diff --git a/.gitignore b/.gitignore index 90cc901..815e13b 100644 --- a/.gitignore +++ b/.gitignore @@ -26,4 +26,6 @@ bld/ .vs/ # Uncomment if you have tasks that create the .vs/DcRat/v16/.suo +# Plugin/Decrypter/Decrypter/bin/ +packages/ \ No newline at end of file diff --git a/packages/AsyncBridge.0.3.1/.signature.p7s b/packages/AsyncBridge.0.3.1/.signature.p7s deleted file mode 100644 index 6c910fe..0000000 Binary files a/packages/AsyncBridge.0.3.1/.signature.p7s and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/AsyncBridge.0.3.1.nupkg b/packages/AsyncBridge.0.3.1/AsyncBridge.0.3.1.nupkg deleted file mode 100644 index 589f7b4..0000000 Binary files a/packages/AsyncBridge.0.3.1/AsyncBridge.0.3.1.nupkg and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.dll b/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.dll deleted file mode 100644 index 9eae140..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.dll and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.pdb b/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.pdb deleted file mode 100644 index a04d159..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.pdb and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.xml b/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.xml deleted file mode 100644 index 0595d57..0000000 --- a/packages/AsyncBridge.0.3.1/lib/net35-client/AsyncBridge.xml +++ /dev/null @@ -1,1506 +0,0 @@ - - - - AsyncBridge - - - - - Provides extension methods for threading-related types. - - - - Asynchronous wrappers for .NET Framework operations. - - - - Provides extension methods for threading-related types. - - - - AsyncCtpThreadingExtensions is a placeholder. - - - - - Gets an awaiter used to await this . - - The task to await. - - An awaiter instance. - - - - - Gets an awaiter used to await this . - - Specifies the type of data returned by the task. - The task to await. - - An awaiter instance. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Holds state related to the builder's IAsyncStateMachine. - - - - This is a mutable struct. Be very delicate with it. - - - - - A reference to the heap-allocated state machine object associated with this builder. - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument is null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Gets the Action to use with an awaiter's OnCompleted or UnsafeOnCompleted method. - On first invocation, the supplied state machine will be boxed. - - - Specifies the type of the method builder used.Specifies the type of the state machine used.The builder.The state machine. - - An Action to provide to the awaiter. - - - - - Throws the exception on the ThreadPool. - - The exception to propagate.The target context on which to propagate the exception. Null to use the ThreadPool. - - - - Provides the ability to invoke a state machine's MoveNext method under a supplied ExecutionContext. - - - - - The context with which to run MoveNext. - - - - - The state machine whose MoveNext method should be invoked. - - - - - Cached delegate used with ExecutionContext.Run. - - - - - Initializes the runner. - - The context with which to run MoveNext. - - - - Invokes MoveNext under the provided context. - - - - - Invokes the MoveNext method on the supplied IAsyncStateMachine. - - The IAsyncStateMachine machine instance. - - - - Provides a base class used to cache tasks of a specific return type. - - Specifies the type of results the cached tasks return. - - - - A singleton cache for this result type. - This may be null if there are no cached tasks for this TResult. - - - - - - Creates a non-disposable task. - - The result for the task. - - The cacheable task. - - - - - Creates a cache. - - - - A task cache for this result type. - - - - - Gets a cached task if one exists. - - The result for which we want a cached task. - - A cached task if one exists; otherwise, null. - - - - - Provides a cache for Boolean tasks. - - - - - A true task. - - - - - A false task. - - - - - Gets a cached task for the Boolean result. - - true or false - - A cached task for the Boolean result. - - - - - Provides a cache for zero Int32 tasks. - - - - - The cache of Task{Int32}. - - - - - The minimum value, inclusive, for which we want a cached task. - - - - - The maximum value, exclusive, for which we want a cached task. - - - - - Creates an array of cached tasks for the values in the range [INCLUSIVE_MIN,EXCLUSIVE_MAX). - - - - - Gets a cached task for the zero Int32 result. - - The integer value - - A cached task for the Int32 result or null if not cached. - - - - - Identities the async state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached VoidTaskResult task used for builders that complete synchronously. - - - - - The generic builder object to which this non-generic instance delegates. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - The builder is not initialized. - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state. - - - The builder is not initialized.The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The builder is not initialized.The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder{TResult} is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached task for default(TResult). - - - - - State related to the IAsyncStateMachine. - - - - - The lazily-initialized task completion source. - - - - - Gets the lazily-initialized TaskCompletionSource. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state with the specified result. - - - The result to use to complete the task.The task has already completed. - - - - Completes the builder by using either the supplied completed task, or by completing - the builder's previously accessed task using default(TResult). - - - A task already completed with the value default(TResult).The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - This should only be invoked from within an asynchronous method, - and only by the debugger. - - - - - - Gets a task for the specified result. This will either - be a cached or new task, never null. - - - The result for which we need a task. - - The completed task containing the result. - - - - - Provides a builder for asynchronous methods that return void. - This type is intended for compiler use only. - - - - - - The synchronization context associated with this operation. - - - - - State related to the IAsyncStateMachine. - - - - - An object used by the debugger to uniquely identify this builder. Lazily initialized. - - - - - Non-zero if PreventUnobservedTaskExceptions has already been invoked. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger and only in a single-threaded manner. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes the . - - The synchronizationContext associated with this operation. This may be null. - - - - Registers with UnobservedTaskException to suppress exception crashing. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument was null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the method builder successfully. - - - - - Faults the method builder with an exception. - - The exception that is the cause of this fault.The argument is null (Nothing in Visual Basic).The builder is not initialized. - - - - Notifies the current synchronization context that the operation completed. - - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the method or property name of the caller to the method. - - - - - Initializes a new instance of the class. - - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The underlying awaitable on whose logic this awaitable relies. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to await.true to attempt to marshal the continuation back to the original context captured - when BeginAwait is called; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Represents an asynchronous method builder. - - - - - Represents state machines generated for asynchronous methods. This type is intended for compiler use only. - - - - - Moves the state machine to its next state. - - - - - Configures the state machine with a heap-allocated replica. - - The heap-allocated replica. - - - - Represents an awaiter used to schedule continuations when an await operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes. - The argument is null (Nothing in Visual Basic). - - Unlike OnCompleted, UnsafeOnCompleted need not propagate ExecutionContext information. - - - - - Represents an operation that will schedule continuations when the operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes.The argument is null (Nothing in Visual Basic). - - - - Identities the iterator state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Identities the state machine type for this method. - - - - - Gets the type that implements the state machine. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - A MethodInfo for the Exception.PrepForRemoting method. - - - - - An empty array to use with MethodInfo.Invoke. - - - - - The default value to use for continueOnCapturedContext. - - - - - Error message for GetAwaiter. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Whether the current thread is appropriate for inlining the await continuation. - - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Fast checks for the end of an await operation to determine whether more needs to be done prior to completing the await. - - The awaited task. - - - - Handles validations on tasks that aren't successfully completed. - - The awaited task. - - - - Throws an exception to handle a task that completed in a state other than RanToCompletion. - - - - - Schedules the continuation onto the associated with this . - - The awaited task. - The action to invoke when the await operation completes. - Whether to capture and marshal back to the current context. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Invokes the delegate in a try/catch that will propagate the exception asynchronously on the ThreadPool. - - - - - - Copies the exception's stack trace so its stack trace isn't overwritten. - - The exception to prepare. - - - - Gets the MethodInfo for the internal PrepForRemoting method on Exception. - - The MethodInfo if it could be retrieved, or else null. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The result of the completed . - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Used with Task(of void) - - - - - Provides an awaitable context for switching into a target environment. - - - This type is intended for compiler use only. - - - - - Gets an awaiter for this . - - An awaiter for this awaitable. - - This method is intended for compiler user rather than use directly in code. - - - - - Provides an awaiter that switches into a target environment. - - - This type is intended for compiler use only. - - - - - A completed task. - - - - - Gets whether a yield is not required. - - - This property is intended for compiler user rather than use directly in code. - - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Ends the await operation. - - - - - Indicates that the .NET Framework class library method to which this attribute is applied is unlikely to be affected by servicing releases, - and therefore is eligible to be inlined across Native Image Generator (NGen) images. - - - - - Infrastructure. Initializes a new instance of the TargetedPatchingOptOutAttribute class. - - The reason why the method to which the attribute is applied is - considered to be eligible for inlining across Native Image Generator (NGen) images. - - - - Infrastructure. Gets the reason why the method to which this attribute is applied is considered to be eligible for inlining across - Native Image Generator (NGen) images. - - - - - Provides methods for creating and manipulating tasks. - - - - TaskEx is a placeholder. - - - - - An already completed task. - - - - - An already canceled task. - - - - - Creates a task that runs the specified action. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified action. - - The action to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the function. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion.A callback invoked when all of the tasks complete successfully in the RanToCompletion state. - This callback is responsible for storing the results into the TaskCompletionSource. - - - A Task that represents the completion of all of the provided tasks. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates an already completed from the specified result. - - The result from which to create the completed task. - - The completed task. - - - - - Creates an awaitable that asynchronously yields back to the current context when awaited. - - - - A context that, when awaited, will asynchronously transition back into the current context. - If SynchronizationContext.Current is non-null, that is treated as the current context. - Otherwise, TaskScheduler.Current is treated as the current context. - - - - - - Adds the target exception to the list, initializing the list if it's null. - - The list to which to add the exception and initialize if the list is null.The exception to add, and unwrap if it's an aggregate. - - - diff --git a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.dll b/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.dll deleted file mode 100644 index 68e1cae..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.dll and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.pdb b/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.pdb deleted file mode 100644 index eea1a53..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.pdb and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.xml b/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.xml deleted file mode 100644 index 42f23af..0000000 --- a/packages/AsyncBridge.0.3.1/lib/net40-client/AsyncBridge.xml +++ /dev/null @@ -1,1487 +0,0 @@ - - - - AsyncBridge - - - - - Provides extension methods for threading-related types. - - - - Asynchronous wrappers for .NET Framework operations. - - - - Provides extension methods for threading-related types. - - - - AsyncCtpThreadingExtensions is a placeholder. - - - - - Gets an awaiter used to await this . - - The task to await. - - An awaiter instance. - - - - - Gets an awaiter used to await this . - - Specifies the type of data returned by the task. - The task to await. - - An awaiter instance. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Holds state related to the builder's IAsyncStateMachine. - - - - This is a mutable struct. Be very delicate with it. - - - - - A reference to the heap-allocated state machine object associated with this builder. - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument is null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Gets the Action to use with an awaiter's OnCompleted or UnsafeOnCompleted method. - On first invocation, the supplied state machine will be boxed. - - - Specifies the type of the method builder used.Specifies the type of the state machine used.The builder.The state machine. - - An Action to provide to the awaiter. - - - - - Throws the exception on the ThreadPool. - - The exception to propagate.The target context on which to propagate the exception. Null to use the ThreadPool. - - - - Provides the ability to invoke a state machine's MoveNext method under a supplied ExecutionContext. - - - - - The context with which to run MoveNext. - - - - - The state machine whose MoveNext method should be invoked. - - - - - Cached delegate used with ExecutionContext.Run. - - - - - Initializes the runner. - - The context with which to run MoveNext. - - - - Invokes MoveNext under the provided context. - - - - - Invokes the MoveNext method on the supplied IAsyncStateMachine. - - The IAsyncStateMachine machine instance. - - - - Provides a base class used to cache tasks of a specific return type. - - Specifies the type of results the cached tasks return. - - - - A singleton cache for this result type. - This may be null if there are no cached tasks for this TResult. - - - - - - Creates a non-disposable task. - - The result for the task. - - The cacheable task. - - - - - Creates a cache. - - - - A task cache for this result type. - - - - - Gets a cached task if one exists. - - The result for which we want a cached task. - - A cached task if one exists; otherwise, null. - - - - - Provides a cache for Boolean tasks. - - - - - A true task. - - - - - A false task. - - - - - Gets a cached task for the Boolean result. - - true or false - - A cached task for the Boolean result. - - - - - Provides a cache for zero Int32 tasks. - - - - - The cache of Task{Int32}. - - - - - The minimum value, inclusive, for which we want a cached task. - - - - - The maximum value, exclusive, for which we want a cached task. - - - - - Creates an array of cached tasks for the values in the range [INCLUSIVE_MIN,EXCLUSIVE_MAX). - - - - - Gets a cached task for the zero Int32 result. - - The integer value - - A cached task for the Int32 result or null if not cached. - - - - - Identities the async state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached VoidTaskResult task used for builders that complete synchronously. - - - - - The generic builder object to which this non-generic instance delegates. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - The builder is not initialized. - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state. - - - The builder is not initialized.The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The builder is not initialized.The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder{TResult} is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached task for default(TResult). - - - - - State related to the IAsyncStateMachine. - - - - - The lazily-initialized task completion source. - - - - - Gets the lazily-initialized TaskCompletionSource. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state with the specified result. - - - The result to use to complete the task.The task has already completed. - - - - Completes the builder by using either the supplied completed task, or by completing - the builder's previously accessed task using default(TResult). - - - A task already completed with the value default(TResult).The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - This should only be invoked from within an asynchronous method, - and only by the debugger. - - - - - - Gets a task for the specified result. This will either - be a cached or new task, never null. - - - The result for which we need a task. - - The completed task containing the result. - - - - - Provides a builder for asynchronous methods that return void. - This type is intended for compiler use only. - - - - - - The synchronization context associated with this operation. - - - - - State related to the IAsyncStateMachine. - - - - - An object used by the debugger to uniquely identify this builder. Lazily initialized. - - - - - Non-zero if PreventUnobservedTaskExceptions has already been invoked. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger and only in a single-threaded manner. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes the . - - The synchronizationContext associated with this operation. This may be null. - - - - Registers with UnobservedTaskException to suppress exception crashing. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument was null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the method builder successfully. - - - - - Faults the method builder with an exception. - - The exception that is the cause of this fault.The argument is null (Nothing in Visual Basic).The builder is not initialized. - - - - Notifies the current synchronization context that the operation completed. - - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the method or property name of the caller to the method. - - - - - Initializes a new instance of the class. - - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The underlying awaitable on whose logic this awaitable relies. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to await.true to attempt to marshal the continuation back to the original context captured - when BeginAwait is called; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Represents an asynchronous method builder. - - - - - Represents state machines generated for asynchronous methods. This type is intended for compiler use only. - - - - - Moves the state machine to its next state. - - - - - Configures the state machine with a heap-allocated replica. - - The heap-allocated replica. - - - - Represents an awaiter used to schedule continuations when an await operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes. - The argument is null (Nothing in Visual Basic). - - Unlike OnCompleted, UnsafeOnCompleted need not propagate ExecutionContext information. - - - - - Represents an operation that will schedule continuations when the operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes.The argument is null (Nothing in Visual Basic). - - - - Identities the iterator state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Identities the state machine type for this method. - - - - - Gets the type that implements the state machine. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - A MethodInfo for the Exception.PrepForRemoting method. - - - - - An empty array to use with MethodInfo.Invoke. - - - - - The default value to use for continueOnCapturedContext. - - - - - Error message for GetAwaiter. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Whether the current thread is appropriate for inlining the await continuation. - - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Fast checks for the end of an await operation to determine whether more needs to be done prior to completing the await. - - The awaited task. - - - - Handles validations on tasks that aren't successfully completed. - - The awaited task. - - - - Throws an exception to handle a task that completed in a state other than RanToCompletion. - - - - - Schedules the continuation onto the associated with this . - - The awaited task. - The action to invoke when the await operation completes. - Whether to capture and marshal back to the current context. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Invokes the delegate in a try/catch that will propagate the exception asynchronously on the ThreadPool. - - - - - - Copies the exception's stack trace so its stack trace isn't overwritten. - - The exception to prepare. - - - - Gets the MethodInfo for the internal PrepForRemoting method on Exception. - - The MethodInfo if it could be retrieved, or else null. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The result of the completed . - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Used with Task(of void) - - - - - Provides an awaitable context for switching into a target environment. - - - This type is intended for compiler use only. - - - - - Gets an awaiter for this . - - An awaiter for this awaitable. - - This method is intended for compiler user rather than use directly in code. - - - - - Provides an awaiter that switches into a target environment. - - - This type is intended for compiler use only. - - - - - A completed task. - - - - - Gets whether a yield is not required. - - - This property is intended for compiler user rather than use directly in code. - - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Ends the await operation. - - - - - Provides methods for creating and manipulating tasks. - - - - TaskEx is a placeholder. - - - - - An already completed task. - - - - - An already canceled task. - - - - - Creates a task that runs the specified action. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified action. - - The action to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the function. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion.A callback invoked when all of the tasks complete successfully in the RanToCompletion state. - This callback is responsible for storing the results into the TaskCompletionSource. - - - A Task that represents the completion of all of the provided tasks. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates an already completed from the specified result. - - The result from which to create the completed task. - - The completed task. - - - - - Creates an awaitable that asynchronously yields back to the current context when awaited. - - - - A context that, when awaited, will asynchronously transition back into the current context. - If SynchronizationContext.Current is non-null, that is treated as the current context. - Otherwise, TaskScheduler.Current is treated as the current context. - - - - - - Adds the target exception to the list, initializing the list if it's null. - - The list to which to add the exception and initialize if the list is null.The exception to add, and unwrap if it's an aggregate. - - - diff --git a/packages/AsyncBridge.0.3.1/lib/net45/_._ b/packages/AsyncBridge.0.3.1/lib/net45/_._ deleted file mode 100644 index e69de29..0000000 diff --git a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.dll b/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.dll deleted file mode 100644 index 4764041..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.dll and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.pdb b/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.pdb deleted file mode 100644 index d4b24f9..0000000 Binary files a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.pdb and /dev/null differ diff --git a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.xml b/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.xml deleted file mode 100644 index 0595d57..0000000 --- a/packages/AsyncBridge.0.3.1/lib/portable-net40+sl5/AsyncBridge.xml +++ /dev/null @@ -1,1506 +0,0 @@ - - - - AsyncBridge - - - - - Provides extension methods for threading-related types. - - - - Asynchronous wrappers for .NET Framework operations. - - - - Provides extension methods for threading-related types. - - - - AsyncCtpThreadingExtensions is a placeholder. - - - - - Gets an awaiter used to await this . - - The task to await. - - An awaiter instance. - - - - - Gets an awaiter used to await this . - - Specifies the type of data returned by the task. - The task to await. - - An awaiter instance. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Creates and configures an awaitable object for awaiting the specified task. - - The task to be awaited. - true to automatic marshal back to the original call site's current SynchronizationContext - or TaskScheduler; otherwise, false. - - The instance to be awaited. - - - - - Holds state related to the builder's IAsyncStateMachine. - - - - This is a mutable struct. Be very delicate with it. - - - - - A reference to the heap-allocated state machine object associated with this builder. - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument is null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Gets the Action to use with an awaiter's OnCompleted or UnsafeOnCompleted method. - On first invocation, the supplied state machine will be boxed. - - - Specifies the type of the method builder used.Specifies the type of the state machine used.The builder.The state machine. - - An Action to provide to the awaiter. - - - - - Throws the exception on the ThreadPool. - - The exception to propagate.The target context on which to propagate the exception. Null to use the ThreadPool. - - - - Provides the ability to invoke a state machine's MoveNext method under a supplied ExecutionContext. - - - - - The context with which to run MoveNext. - - - - - The state machine whose MoveNext method should be invoked. - - - - - Cached delegate used with ExecutionContext.Run. - - - - - Initializes the runner. - - The context with which to run MoveNext. - - - - Invokes MoveNext under the provided context. - - - - - Invokes the MoveNext method on the supplied IAsyncStateMachine. - - The IAsyncStateMachine machine instance. - - - - Provides a base class used to cache tasks of a specific return type. - - Specifies the type of results the cached tasks return. - - - - A singleton cache for this result type. - This may be null if there are no cached tasks for this TResult. - - - - - - Creates a non-disposable task. - - The result for the task. - - The cacheable task. - - - - - Creates a cache. - - - - A task cache for this result type. - - - - - Gets a cached task if one exists. - - The result for which we want a cached task. - - A cached task if one exists; otherwise, null. - - - - - Provides a cache for Boolean tasks. - - - - - A true task. - - - - - A false task. - - - - - Gets a cached task for the Boolean result. - - true or false - - A cached task for the Boolean result. - - - - - Provides a cache for zero Int32 tasks. - - - - - The cache of Task{Int32}. - - - - - The minimum value, inclusive, for which we want a cached task. - - - - - The maximum value, exclusive, for which we want a cached task. - - - - - Creates an array of cached tasks for the values in the range [INCLUSIVE_MIN,EXCLUSIVE_MAX). - - - - - Gets a cached task for the zero Int32 result. - - The integer value - - A cached task for the Int32 result or null if not cached. - - - - - Identities the async state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached VoidTaskResult task used for builders that complete synchronously. - - - - - The generic builder object to which this non-generic instance delegates. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - The builder is not initialized. - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state. - - - The builder is not initialized.The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The builder is not initialized.The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - - - Provides a builder for asynchronous methods that return . - This type is intended for compiler use only. - - - - - AsyncTaskMethodBuilder{TResult} is a value type, and thus it is copied by value. - Prior to being copied, one of its Task, SetResult, or SetException members must be accessed, - or else the copies may end up building distinct Task instances. - - - - - - A cached task for default(TResult). - - - - - State related to the IAsyncStateMachine. - - - - - The lazily-initialized task completion source. - - - - - Gets the lazily-initialized TaskCompletionSource. - - - - - Gets the for this builder. - - - - The representing the builder's asynchronous operation. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger, and only in a single-threaded manner - when no other threads are in the middle of accessing this property or this.Task. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference. - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the in the - RanToCompletion state with the specified result. - - - The result to use to complete the task.The task has already completed. - - - - Completes the builder by using either the supplied completed task, or by completing - the builder's previously accessed task using default(TResult). - - - A task already completed with the value default(TResult).The task has already completed. - - - - Completes the in the - Faulted state with the specified exception. - - - The to use to fault the task.The argument is null (Nothing in Visual Basic).The task has already completed. - - - - Called by the debugger to request notification when the first wait operation - (await, Wait, Result, etc.) on this builder's task completes. - - - true to enable notification; false to disable a previously set notification. - - - This should only be invoked from within an asynchronous method, - and only by the debugger. - - - - - - Gets a task for the specified result. This will either - be a cached or new task, never null. - - - The result for which we need a task. - - The completed task containing the result. - - - - - Provides a builder for asynchronous methods that return void. - This type is intended for compiler use only. - - - - - - The synchronization context associated with this operation. - - - - - State related to the IAsyncStateMachine. - - - - - An object used by the debugger to uniquely identify this builder. Lazily initialized. - - - - - Non-zero if PreventUnobservedTaskExceptions has already been invoked. - - - - - Gets an object that may be used to uniquely identify this builder to the debugger. - - - - - This property lazily instantiates the ID in a non-thread-safe manner. - It must only be used by the debugger and only in a single-threaded manner. - - - - - - Temporary support for disabling crashing if tasks go unobserved. - - - - - Initializes the . - - The synchronizationContext associated with this operation. This may be null. - - - - Registers with UnobservedTaskException to suppress exception crashing. - - - - - Initializes a new . - - - - The initialized . - - - - - Initiates the builder's execution with the associated state machine. - - Specifies the type of the state machine.The state machine instance, passed by reference.The argument was null (Nothing in Visual Basic). - - - - Associates the builder with the state machine it represents. - - The heap-allocated state machine object.The argument was null (Nothing in Visual Basic).The builder is incorrectly initialized. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Schedules the specified state machine to be pushed forward when the specified awaiter completes. - - - Specifies the type of the awaiter.Specifies the type of the state machine.The awaiter.The state machine. - - - - Completes the method builder successfully. - - - - - Faults the method builder with an exception. - - The exception that is the cause of this fault.The argument is null (Nothing in Visual Basic).The builder is not initialized. - - - - Notifies the current synchronization context that the operation completed. - - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - - Initializes a new instance of the class. - - - - - Allows you to obtain the method or property name of the caller to the method. - - - - - Initializes a new instance of the class. - - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The underlying awaitable on whose logic this awaitable relies. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes.The argument is null (Nothing in Visual Basic).The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Provides an awaitable object that allows for configured awaits on . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Initializes the . - - The awaitable .true to attempt to marshal the continuation back to the original context captured; otherwise, false. - - - - - Gets an awaiter for this awaitable. - - - - The awaiter. - - - - - Provides an awaiter for a . - - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Whether to attempt marshaling back to the original context. - - - - - Gets whether the task being awaited is completed. - - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to await.true to attempt to marshal the continuation back to the original context captured - when BeginAwait is called; otherwise, false. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - - - The result of the completed . - - The awaiter was not properly initialized.The task was not yet completed.The task was canceled.The task completed in a Faulted state. - - - - Represents an asynchronous method builder. - - - - - Represents state machines generated for asynchronous methods. This type is intended for compiler use only. - - - - - Moves the state machine to its next state. - - - - - Configures the state machine with a heap-allocated replica. - - The heap-allocated replica. - - - - Represents an awaiter used to schedule continuations when an await operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes. - The argument is null (Nothing in Visual Basic). - - Unlike OnCompleted, UnsafeOnCompleted need not propagate ExecutionContext information. - - - - - Represents an operation that will schedule continuations when the operation completes. - - - - - - Schedules the continuation action to be invoked when the instance completes. - - The action to invoke when the operation completes.The argument is null (Nothing in Visual Basic). - - - - Identities the iterator state machine type for this method. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Identities the state machine type for this method. - - - - - Gets the type that implements the state machine. - - - - - Initializes the attribute. - - The type that implements the state machine. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - A MethodInfo for the Exception.PrepForRemoting method. - - - - - An empty array to use with MethodInfo.Invoke. - - - - - The default value to use for continueOnCapturedContext. - - - - - Error message for GetAwaiter. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Whether the current thread is appropriate for inlining the await continuation. - - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Fast checks for the end of an await operation to determine whether more needs to be done prior to completing the await. - - The awaited task. - - - - Handles validations on tasks that aren't successfully completed. - - The awaited task. - - - - Throws an exception to handle a task that completed in a state other than RanToCompletion. - - - - - Schedules the continuation onto the associated with this . - - The awaited task. - The action to invoke when the await operation completes. - Whether to capture and marshal back to the current context. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Invokes the delegate in a try/catch that will propagate the exception asynchronously on the ThreadPool. - - - - - - Copies the exception's stack trace so its stack trace isn't overwritten. - - The exception to prepare. - - - - Gets the MethodInfo for the internal PrepForRemoting method on Exception. - - The MethodInfo if it could be retrieved, or else null. - - - - Provides an awaiter for awaiting a . - - - This type is intended for compiler use only. - - - - - The task being awaited. - - - - - Gets whether the task being awaited is completed. - - - This property is intended for compiler user rather than use directly in code. - - The awaiter was not properly initialized. - - - - Initializes the . - - The to be awaited. - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Schedules the continuation onto the associated with this . - - The action to invoke when the await operation completes. - The - - argument is null (Nothing in Visual Basic). - The awaiter was not properly initialized. - - This method is intended for compiler user rather than use directly in code. - - - - - Ends the await on the completed . - - The result of the completed . - The awaiter was not properly initialized. - The task was not yet completed. - The task was canceled. - The task completed in a Faulted state. - - - - Used with Task(of void) - - - - - Provides an awaitable context for switching into a target environment. - - - This type is intended for compiler use only. - - - - - Gets an awaiter for this . - - An awaiter for this awaitable. - - This method is intended for compiler user rather than use directly in code. - - - - - Provides an awaiter that switches into a target environment. - - - This type is intended for compiler use only. - - - - - A completed task. - - - - - Gets whether a yield is not required. - - - This property is intended for compiler user rather than use directly in code. - - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Posts the back to the current context. - - The action to invoke asynchronously. - The awaiter was not properly initialized. - - - - Ends the await operation. - - - - - Indicates that the .NET Framework class library method to which this attribute is applied is unlikely to be affected by servicing releases, - and therefore is eligible to be inlined across Native Image Generator (NGen) images. - - - - - Infrastructure. Initializes a new instance of the TargetedPatchingOptOutAttribute class. - - The reason why the method to which the attribute is applied is - considered to be eligible for inlining across Native Image Generator (NGen) images. - - - - Infrastructure. Gets the reason why the method to which this attribute is applied is considered to be eligible for inlining across - Native Image Generator (NGen) images. - - - - - Provides methods for creating and manipulating tasks. - - - - TaskEx is a placeholder. - - - - - An already completed task. - - - - - An already canceled task. - - - - - Creates a task that runs the specified action. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified action. - - The action to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute.The CancellationToken to use to request cancellation of this task. - - A task that represents the completion of the function. - - The argument is null. - - - - Creates a task that runs the specified function. - - The function to execute asynchronously. - - A task that represents the completion of the action. - - The argument is null. - - - - Creates a task that runs the specified function. - - The action to execute.The CancellationToken to use to cancel the task. - - A task that represents the completion of the action. - - The argument is null. - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Starts a Task that will complete after the specified due time. - - The delay in milliseconds before the returned task completes.A CancellationToken that may be used to cancel the task before the due time occurs. - - The timed Task. - - The argument must be non-negative or -1 and less than or equal to Int32.MaxValue. - - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion. - - A Task that represents the completion of all of the provided tasks. - - - - If any of the provided Tasks faults, the returned Task will also fault, and its Exception will contain information - about all of the faulted tasks. If no Tasks fault but one or more Tasks is canceled, the returned - Task will also be canceled. - - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete only when all of the provided collection of Tasks has completed. - - The Tasks to monitor for completion.A callback invoked when all of the tasks complete successfully in the RanToCompletion state. - This callback is responsible for storing the results into the TaskCompletionSource. - - - A Task that represents the completion of all of the provided tasks. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates a Task that will complete when any of the tasks in the provided collection completes. - - The Tasks to be monitored. - - A Task that represents the completion of any of the provided Tasks. The completed Task is this Task's result. - - - - - Any Tasks that fault will need to have their exceptions observed elsewhere. - - The argument is null.The argument contains a null reference. - - - - Creates an already completed from the specified result. - - The result from which to create the completed task. - - The completed task. - - - - - Creates an awaitable that asynchronously yields back to the current context when awaited. - - - - A context that, when awaited, will asynchronously transition back into the current context. - If SynchronizationContext.Current is non-null, that is treated as the current context. - Otherwise, TaskScheduler.Current is treated as the current context. - - - - - - Adds the target exception to the list, initializing the list if it's null. - - The list to which to add the exception and initialize if the list is null.The exception to add, and unwrap if it's an aggregate. - - - diff --git a/packages/BouncyCastle.1.8.6.1/.signature.p7s b/packages/BouncyCastle.1.8.6.1/.signature.p7s deleted file mode 100644 index aa53217..0000000 Binary files a/packages/BouncyCastle.1.8.6.1/.signature.p7s and /dev/null differ diff --git a/packages/BouncyCastle.1.8.6.1/BouncyCastle.1.8.6.1.nupkg b/packages/BouncyCastle.1.8.6.1/BouncyCastle.1.8.6.1.nupkg deleted file mode 100644 index 0bac009..0000000 Binary files a/packages/BouncyCastle.1.8.6.1/BouncyCastle.1.8.6.1.nupkg and /dev/null differ diff --git a/packages/BouncyCastle.1.8.6.1/README.md b/packages/BouncyCastle.1.8.6.1/README.md deleted file mode 100644 index 270d9cc..0000000 --- a/packages/BouncyCastle.1.8.6.1/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# The Bouncy Castle Crypto Package For C Sharp - -The Bouncy Castle Crypto package is a C\# implementation of cryptographic algorithms and protocols, it was developed by the Legion of the Bouncy Castle, a registered Australian Charity, with a little help! The Legion, and the latest goings on with this package, can be found at [http://www.bouncycastle.org](http://www.bouncycastle.org). In addition to providing basic cryptography algorithms, the package also provides support for CMS, TSP, X.509 certificate generation and a variety of other standards such as OpenPGP. - -The Legion also gratefully acknowledges the contributions made to this package by others (see [here](http://www.bouncycastle.org/csharp/contributors.html) for the current list). If you would like to contribute to our efforts please feel free to get in touch with us or visit our [donations page](https://www.bouncycastle.org/donate), sponsor some specific work, or purchase a support contract through [Crypto Workshop](http://www.cryptoworkshop.com). - -Except where otherwise stated, this software is distributed under a license based on the MIT X Consortium license. To view the license, [see here](http://www.bouncycastle.org/licence.html). The OpenPGP library also includes a modified BZIP2 library which is licensed under the [Apache Software License, Version 2.0](http://www.apache.org/licenses/). - -**Note**: this source tree is not the FIPS version of the APIs - if you are interested in our FIPS version please contact us directly at [office@bouncycastle.org](mailto:office@bouncycastle.org). - -## Mailing Lists - -For those who are interested, there are 2 mailing lists for participation in this project. To subscribe use the links below and include the word subscribe in the message body. (To unsubscribe, replace **subscribe** with **unsubscribe** in the message body) - -* [announce-crypto-csharp-request@bouncycastle.org](mailto:announce-crypto-csharp-request@bouncycastle.org) - This mailing list is for new release announcements only, general subscribers cannot post to it. -* [dev-crypto-csharp-request@bouncycastle.org](mailto:dev-crypto-csharp-request@bouncycastle.org) - This mailing list is for discussion of development of the package. This includes bugs, comments, requests for enhancements, questions about use or operation. - -**NOTE:**You need to be subscribed to send mail to the above mailing list. - -## Feedback - -If you want to provide feedback directly to the members of **The Legion** then please use [feedback-crypto@bouncycastle.org](mailto:feedback-crypto@bouncycastle.org), if you want to help this project survive please consider [donating](https://www.bouncycastle.org/donate). - -For bug reporting/requests you can report issues here on github, via feedback-crypto if required, and we also have a [Jira issue tracker](http://www.bouncycastle.org/jira). We will accept pull requests based on this repository as well. - -## Finally - -Enjoy! diff --git a/packages/BouncyCastle.1.8.6.1/lib/BouncyCastle.Crypto.dll b/packages/BouncyCastle.1.8.6.1/lib/BouncyCastle.Crypto.dll deleted file mode 100644 index 0f324ca..0000000 Binary files a/packages/BouncyCastle.1.8.6.1/lib/BouncyCastle.Crypto.dll and /dev/null differ diff --git a/packages/CSCore.1.2.1.2/.signature.p7s b/packages/CSCore.1.2.1.2/.signature.p7s deleted file mode 100644 index c899549..0000000 Binary files a/packages/CSCore.1.2.1.2/.signature.p7s and /dev/null differ diff --git a/packages/CSCore.1.2.1.2/CSCore.1.2.1.2.nupkg b/packages/CSCore.1.2.1.2/CSCore.1.2.1.2.nupkg deleted file mode 100644 index 8a8f91c..0000000 Binary files a/packages/CSCore.1.2.1.2/CSCore.1.2.1.2.nupkg and /dev/null differ diff --git a/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.XML b/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.XML deleted file mode 100644 index 3856c6f..0000000 --- a/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.XML +++ /dev/null @@ -1,25323 +0,0 @@ - - - - CSCore - - - - - Defines and provides methods to convert between -values and -values. - - are used by the , the and the class. - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - WAVE_FORMAT_NMS_VBXADPCM - - - WAVE_FORMAT_CS_IMAADPCM - - - WAVE_FORMAT_ECHOSC3 - - - WAVE_FORMAT_ROCKWELL_ADPCM - - - WAVE_FORMAT_ROCKWELL_DIGITALK - - - WAVE_FORMAT_XEBEC - - - WAVE_FORMAT_G721_ADPCM - - - WAVE_FORMAT_G728_CELP - - - WAVE_FORMAT_MSG723 - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - WAVE_FORMAT_RT24 - - - WAVE_FORMAT_PAC - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - WAVE_FORMAT_LUCENT_G723 - - - WAVE_FORMAT_CIRRUS - - - WAVE_FORMAT_ESPCM - - - WAVE_FORMAT_VOXWARE - - - WAVE_FORMAT_CANOPUS_ATRAC - - - WAVE_FORMAT_G726_ADPCM - - - WAVE_FORMAT_G722_ADPCM - - - WAVE_FORMAT_DSAT_DISPLAY - - - WAVE_FORMAT_VOXWARE_BYTE_ALIGNED - - - WAVE_FORMAT_VOXWARE_AC8 - - - WAVE_FORMAT_VOXWARE_AC10 - - - WAVE_FORMAT_VOXWARE_AC16 - - - WAVE_FORMAT_VOXWARE_AC20 - - - WAVE_FORMAT_VOXWARE_RT24 - - - WAVE_FORMAT_VOXWARE_RT29 - - - WAVE_FORMAT_VOXWARE_RT29HW - - - WAVE_FORMAT_VOXWARE_VR12 - - - WAVE_FORMAT_VOXWARE_VR18 - - - WAVE_FORMAT_VOXWARE_TQ40 - - - WAVE_FORMAT_SOFTSOUND - - - WAVE_FORMAT_VOXWARE_TQ60 - - - WAVE_FORMAT_MSRT24 - - - WAVE_FORMAT_G729A - - - WAVE_FORMAT_MVI_MVI2 - - - WAVE_FORMAT_DF_G726 - - - WAVE_FORMAT_DF_GSM610 - - - WAVE_FORMAT_ISIAUDIO - - - WAVE_FORMAT_ONLIVE - - - WAVE_FORMAT_SBC24 - - - WAVE_FORMAT_DOLBY_AC3_SPDIF - - - WAVE_FORMAT_MEDIASONIC_G723 - - - WAVE_FORMAT_PROSODY_8KBPS - - - WAVE_FORMAT_ZYXEL_ADPCM - - - WAVE_FORMAT_PHILIPS_LPCBB - - - WAVE_FORMAT_PACKED - - - WAVE_FORMAT_MALDEN_PHONYTALK - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - WAVE_FORMAT_RHETOREX_ADPCM - - - WAVE_FORMAT_IRAT - - - WAVE_FORMAT_VIVO_G723 - - - WAVE_FORMAT_VIVO_SIREN - - - WAVE_FORMAT_DIGITAL_G723 - - - WAVE_FORMAT_SANYO_LD_ADPCM - - - WAVE_FORMAT_SIPROLAB_ACEPLNET - - - WAVE_FORMAT_SIPROLAB_ACELP4800 - - - WAVE_FORMAT_SIPROLAB_ACELP8V3 - - - WAVE_FORMAT_SIPROLAB_G729 - - - WAVE_FORMAT_SIPROLAB_G729A - - - WAVE_FORMAT_SIPROLAB_KELVIN - - - WAVE_FORMAT_G726ADPCM - - - WAVE_FORMAT_QUALCOMM_PUREVOICE - - - WAVE_FORMAT_QUALCOMM_HALFRATE - - - WAVE_FORMAT_TUBGSM - - - WAVE_FORMAT_MSAUDIO1 - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - WAVE_FORMAT_UNISYS_NAP_ADPCM - - - WAVE_FORMAT_UNISYS_NAP_ULAW - - - WAVE_FORMAT_UNISYS_NAP_ALAW - - - WAVE_FORMAT_UNISYS_NAP_16K - - - WAVE_FORMAT_CREATIVE_ADPCM - - - WAVE_FORMAT_CREATIVE_FASTSPEECH8 - - - WAVE_FORMAT_CREATIVE_FASTSPEECH10 - - - WAVE_FORMAT_UHER_ADPCM - - - WAVE_FORMAT_QUARTERDECK - - - WAVE_FORMAT_ILINK_VC - - - WAVE_FORMAT_RAW_SPORT - - - WAVE_FORMAT_ESST_AC3 - - - WAVE_FORMAT_IPI_HSX - - - WAVE_FORMAT_IPI_RPELP - - - WAVE_FORMAT_CS2 - - - WAVE_FORMAT_SONY_SCX - - - WAVE_FORMAT_FM_TOWNS_SND - - - WAVE_FORMAT_BTV_DIGITAL - - - WAVE_FORMAT_QDESIGN_MUSIC - - - WAVE_FORMAT_VME_VMPCM - - - WAVE_FORMAT_TPC - - - WAVE_FORMAT_OLIGSM - - - WAVE_FORMAT_OLIADPCM - - - WAVE_FORMAT_OLICELP - - - WAVE_FORMAT_OLISBC - - - WAVE_FORMAT_OLIOPR - - - WAVE_FORMAT_LH_CODEC - - - WAVE_FORMAT_NORRIS - - - WAVE_FORMAT_SOUNDSPACE_MUSICOMPRESS - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - MPEG_RAW_AAC - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - See . - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. See . - - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - - Raw AAC1 - - - - - Windows Media Audio Voice (WMA Voice) - - - - Extensible - - - WAVE_FORMAT_DEVELOPMENT - - - - FLAC - - - - - Converts a -value to a -value. - - The -value to convert to the equivalent -value. - The which belongs to the specified . - - - - Converts a value to a -value. - - The to convert to the equivalent -value. - The -value which belongs to the specified . - - - - The Major Type for Audio media types. - - - - - Channelmask used by . For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/dd757714(v=vs.85).aspx - - - - - Front left speaker. - - - - - Front right speaker. - - - - - Front center speaker. - - - - - Low frequency speaker. - - - - - Back left speaker. - - - - - Back right speaker. - - - - - Front left of center speaker. - - - - - Front right of center speaker. - - - - - Back center speaker. - - - - - Side left speaker. - - - - - Side right speaker. - - - - - Top center speaker. - - - - - Top front left speaker. - - - - - Top front center speaker. - - - - - Top front right speaker. - - - - - Top back left speaker. - - - - - Top back center speaker. - - - - - Top back right speaker. - - - - - Defines common channelmasks. - - - - - Mono. - - - - - Stereo. - - - - - 5.1 surround with rear speakers. - - - - - 5.1 surround with side speakers. - - - - - 7.1 surround. - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream. - is the default setting. - For more information, see . - - - - - None/Invalid - - - - - AACProfile_L2_0x29 - Default value - - - - - AACProfile_L4_0x2A - - - - - AACProfile_L5_0x2B - - - - - HighEfficiencyAACProfile_L2_0x2C - - - - - HighEfficiencyAACProfile_L3_0x2D - - - - - HighEfficiencyAACProfile_L4_0x2E - - - - - HighEfficiencyAACProfile_L5_0x2F - - - - - ReservedForIsoUse_0x30 - - - - - ReservedForIsoUse_0x31 - - - - - ReservedForIsoUse_0x32 - - - - - ReservedForIsoUse_0x33 - - - - - Provides an encoder for encoding raw waveform-audio data to the AAC (Advanced Audio Codec) format. - - - - - Initializes a new instance of the class. - - of the audio data which gets encoded. - which should be used to save the encoded data in. - - - - Initializes a new instance of the class. - - of the audio data which gets encoded. - which should be used to save the encoded data in. - Default samplerate. Use 192000 as the default value. - Guid of the container type. Use as the default container. - - - - Gets or sets the audio profile and level of an Advanced Audio Coding (AAC) stream. - - - This attribute contains the value of the audioProfileLevelIndication field, as defined by ISO/IEC 14496-3. - - - - - Mediafoundation AAC decoder. - - - - - Gets a value which indicates whether the Mediafoundation AAC decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides AAC data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains AAC data. - - - - Decodes an aiff-chunk and provides its stored data. - - - - - Initializes a new instance of the class. - - The binary reader which provides can be used to decode the chunk. - The chunk identifier. - - binaryReader - or - chunkId - - - - - Gets the underlying binary reader. - - Care endianness. - - - - Gets the ChunkId of the . The is used to determine the type of the - . - - - - - Gets the size of the in bytes. The and the - (4 bytes each) are not included. - - - - - Seeks to the end of the chunk. - - - Can be used to make sure that the underlying / points to - the next . - - - - - Provides all s of a aiff stream. - - - - - Initializes a new instance of the class. - - The binary reader which provides can be used to decode the chunk. - - FORM header not found. - or - Invalid Formtype. - - - - - Gets the form type. - - - Either 'AIFF' or 'AIFC'. - - - - - Gets all found of the . - - - - - Seeks to the end of the chunk. - - - Can be used to make sure that the underlying / points to - the next . - - - - - Represents errors that occur when decoding or encoding Aiff-streams/files. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The message that describes the error. - - - - Initializes a new instance of the class. - - The message that describes the error. - The that caused the . - - - - Initializes a new instance of the class. - - - The that holds the serialized object - data about the exception being thrown. - - - The that contains contextual - information about the source or destination. - - - - - Decodes a aiff stream/file. - - - - - Initializes a new instance of the class for the specified . - - The complete file path to be decoded. - - No COMM Chunk found. - or - No SSND Chunk found. - or - Format not supported. - - - - - Initializes a new instance of the class for the specified . - - The stream to be decoded. - stream - - Stream is not readable.;stream - or - Stream is not seekable.;stream - - - No COMM Chunk found. - or - No SSND Chunk found. - or - Format not supported. - - - - - Gets the found s of the aiff stream/file. - - - - - Reads a sequence of elements from the and advances the position within the stream by - the number of elements read. - - - An array of elements. When this method returns, the contains the - specified array of elements with the values between and ( - + - 1) replaced by the elements read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of elements to read from the current source. - - The total number of elements read into the buffer. - - buffer - - offset - or - count - - The sum of offset and count is larger than the buffer length. - Unexpected error. Not supported bps. - - - - Gets a value indicating whether the supports seeking. - - - - - Gets the of the waveform-audio data. - - - - - Gets or sets the current position in bytes. - - The value is less than zero or greater than . - - - - Gets the length of the audio data in bytes. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Releases unmanaged and - optionally - managed resources. - - - true to release both managed and unmanaged resources; false to release only - unmanaged resources. - - - - - Finalizes an instance of the class. - - - - - Provides the format of the encoded audio data of a AIFF-file. - - - - - Initializes a new instance of the class. - - The binary reader which provides can be used to decode the chunk. - Compression type not supported. - - - - Gets the number of channels. - - - - - Gets the total number of sample frames. - - - To get the total number of samples multiply by - . - - - - - Gets the number of bits per sample. - - - - - Gets the sample rate in Hz. - - - - - Gets the compression type. - - All compression types except PCM are currently not supported. - - - - Gets the wave format. - - The wave format. - - This method does not take care about multi channel formats. It won't setup a channel mask. - - - - - Seeks to the end of the chunk. - - - Can be used to make sure that the underlying / points to - the next . - - - - - Provides the format version of the aifc file. - - - - - Defines Aiff-Versions. - - - - - Version 1. - - - - - Initializes a new instance of the class. - - The binary reader which provides can be used to decode the chunk. - Invalid AIFF-C Version. - - - - Gets the version of the aifc file. - - - - - Seeks to the end of the chunk. - - - Can be used to make sure that the underlying / points to - the next . - - - - - Provides the encoded audio data of an aiff stream. - - - - - Initializes a new instance of the class. - - The binary reader which provides can be used to decode the chunk. - - - - Gets the offset. The offset determines where the first sample frame in the starts. - - Offset in bytes. - - - - Gets the block size. It specifies the size in bytes of the blocks that sound data is aligned to. - - - - - Gets the zero based position in the stream, at which the encoded audio data starts. - - - - - Seeks to the end of the chunk. - - - Can be used to make sure that the underlying / points to - the next . - - - - - Represents an entry of the class which provides information about a codec. - - - - - Gets the which initializes a codec decoder based on a . - - - - - Gets all with the codec associated file extensions. - - - - - Initializes a new instance of the class. - - Delegate which initializes a codec decoder based on a . - All which the codec associated file extensions. - - - - Provides data for all events which notify the client that a connection got established. For example the event. - - - - - Gets the uri of the connection. - - - - - Gets a value indicating whether the connection got established successfully or not. true if the connection got established successfully, otherwise false. - - - - - Initializes a new instance of the class. - - The uri of the connection. - A value indicating whether the connection got established successfully or not. true if the connection got established successfully, otherwise false. - - - - Mediafoundation DDP decoder. - - - - - Gets a value which indicates whether the Mediafoundation DDP decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides DDP data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains DDP data. - - - - Helps to choose the right decoder for different codecs. - - - - - Gets the default singleton instance of the class. - - - - - Gets the file filter in English. This filter can be used e.g. in combination with an OpenFileDialog. - - - - - Registers a new codec. - - - The key which gets used internally to save the in a - . This is typically the associated file extension. For example: the mp3 codec - uses the string "mp3" as its key. - - which provides information about the codec. - - - - Returns a fully initialized instance which is able to decode the specified file. If the - specified file can not be decoded, this method throws an . - - Filename of the specified file. - Fully initialized instance which is able to decode the specified file. - The codec of the specified file is not supported. - - - - Returns a fully initialized instance which is able to decode the audio source behind the - specified . - If the specified audio source can not be decoded, this method throws an . - - Uri which points to an audio source. - Fully initialized instance which is able to decode the specified audio source. - The codec of the specified audio source is not supported. - - - - Returns all the common file extensions of all supported codecs. Note that some of these file extensions belong to - more than one codec. - That means that it can be possible that some files with the file extension abc can be decoded but other a few files - with the file extension abc can't be decoded. - - Supported file extensions. - - - - Defines the channel assignments. - - - - - Independent assignment. - - - - - Left/side stereo. Channel 0 becomes the left channel while channel 1 becomes the side channel. - - - - - Right/side stereo. Channel 0 becomes the right channel while channel 1 becomes the side channel. - - - - - Mid/side stereo. Channel 0 becomes the mid channel while channel 1 becomes the side channel. - - - - - FLAC Exception. - - - - - Gets the layer of the flac stream the exception got thrown. - - Used for debugging purposes. - - - - Initializes a new instance of the class. - - A message which describes the error. - The layer of the flac stream the exception got thrown. - - - - Initializes a new instance of the class. - - The InnerException which caused the error. - The layer.The layer of the flac stream the exception got thrown. - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - - The StreamingContext object that supplies the contextual information about the source or - destination. - - - - - When overridden in a derived class, sets the with information about the exception. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - - - - - - - - Represents a frame inside of an Flac-Stream. - - - - - Gets the header of the flac frame. - - - - - Gets the CRC16-checksum. - - - - - Gets a value indicating whether the decoder has encountered an error with this frame. - - - true if this frame contains an error; otherwise, false. - - - - - Creates a new instance of the class based on the specified . - - The stream which contains the flac frame. - A new instance of the class. - - - - Creates a new instance of the class based on the specified and some basic stream information. - - The stream which contains the flac frame. - Some basic information about the flac stream. - A new instance of the class. - - - - Tries to read the next flac frame inside of the specified stream and returns a value which indicates whether the next flac frame could be successfully read. - - True if the next flac frame could be successfully read; false if not. - - - - Gets the raw pcm data of the flac frame. - - The buffer which should be used to store the data in. This value can be null. - The number of read bytes. - - - - Disposes the and releases all associated resources. - - - - - Finalizes an instance of the class. - - - - - Provides a decoder for decoding flac (Free Lostless Audio Codec) data. - - - - - Gets a list with all found metadata fields. - - - - - Gets the output of the decoder. - - - - - Gets a value which indicates whether the seeking is supported. True means that seeking is supported; False means - that seeking is not supported. - - - - - Initializes a new instance of the class. - - Filename which of a flac file which should be decoded. - - - - Initializes a new instance of the class. - - Stream which contains flac data which should be decoded. - - - - Initializes a new instance of the class. - - Stream which contains flac data which should be decoded. - Scan mode which defines how to scan the flac data for frames. - - - - Initializes a new instance of the class. - - Stream which contains flac data which should be decoded. - Scan mode which defines how to scan the flac data for frames. - - Callback which gets called when the pre scan processes finished. Should be used if the - argument is set the . - - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets or sets the position of the in bytes. - - - - - Gets the length of the in bytes. - - - - - Disposes the instance and disposes the underlying stream. - - - - - Disposes the instance and disposes the underlying stream. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls the method. - - - - - Represents the header of a . - - - - - Gets number of samples, the frame contains. - - - The number of samples, the frame contains. - - - - - Gets the sample rate in Hz. - - - The sample rate in Hz. - - - - - Gets the number of channels. - - - The number of channels. - - - - - Gets the channel assignment. - - - The channel assignment. - - - - - Gets the bits per sample. - - - The bits per sample. - - - - - Gets a value which indicates whether the frame provides the or the . - - - A value which indicates whether the frame provides the or the . - - - - - Gets the frame's starting sample number. - - - The frame's starting sample number. - - Only available if the is set to . - - - - Gets the frame's number. - - - The frame's number. - - Only available if the is set to . - - - - Gets the 8-bit crc checksum of the frame header. - - - The 8-bit crc checksum of the frame header. - - - - - Gets a value indicating whether this instance has error. - - - true if this instance has error; otherwise, false. - - - - - Gets the stream position. - - - The stream position. - - - - - Initializes a new instance of the class. - - The underlying stream which contains the . - - - - Initializes a new instance of the class. - - The underlying stream which contains the . - The stream-info-metadata-block of the flac stream which provides some basic information about the flac framestream. Can be set to null. - - - - Initializes a new instance of the class. - - The underlying stream which contains the . - The stream-info-metadata-block of the flac stream which provides some basic information about the flac framestream. Can be set to null. - A value which indicates whether the crc8 checksum of the should be calculated. - - - - Initializes a new instance of the class. - - The raw byte-data which contains the . - The stream-info-metadata-block of the flac stream which provides some basic information about the flac framestream. Can be set to null. - A value which indicates whether the crc8 checksum of the should be calculated. - - - - Indicates whether the format of the current is equal to the format of another . - - A which provides the format to compare with the format of the current . - true if the format of the current is equal to the format of the . - - - - Provides some basic information about a flac frame. This structure is typically used for implementing a seeking algorithm. - - - - - Gets the header of the flac frame. - - - - - Gets a value which indicates whether the described frame is the first frame of the flac stream. True means that the described frame is the first frame of the flac stream. False means that the described frame is not the first frame of the flac stream. - - - - - Gets the offset in bytes at which the frame starts in the flac stream (including the header of the frame). - - - - - Gets the number samples which are contained by other frames before this frame occurs. - - - - - Splits a flac file into a few basic layers and defines them. Mainly used for debugging purposes. - - - - - Everything which is not part of a flac frame. - - For example the "fLaC" sync code. - - - - Everything metadata related. - - - - - Everything which is part of a frame but not part of its subframes. - - - - - Everything subframe related. - - - - - Defines the blocking strategy of the a flac frame. - - - - - The of flac frames is variable. - - - - - Each flac frame uses the same . - - - - - Provides data for a FlacPreScan. - - - - - Gets the a list of found frames by the scan. - - - - - Initializes a new instance of the class. - - Found frames. - - - - Defines how to scan a flac stream. - - - - - Don't scan the flac stream. This will cause a stream to be not seekable. - - - - - Scan synchronously. - - - - - Scan async. - - - Don't use the stream while scan is running because the stream position - will change while scanning. If you playback the stream, it will cause an error! - - - - - Default value. - - - - - The default implementation of the class for - with no specific implemetation. - - - - - Initializes a new instance of the class. - - The type of the metadata. - - - - Initializes the properties of the by reading them from the . - - The stream which contains the metadata. - - - - Gets the type of the . - - - - - Represents a flac metadata block. - - - - - Reads and returns a single from the specified . - - The stream which contains the . - Returns the read . - - - - Reads all from the specified . - - The stream which contains the . - All . - - - - Skips all of the specified . - - The stream which contains the . - - - - Initializes the properties of the . - - The stream which contains the metadata. - The length of block inside of the stream in bytes. Does not include the metadata header. - A value which indicates whether this is the last block inside of the stream. true means that this is the last block inside of the stream. - - - - Initializes the properties of the by reading them from the . - - The stream which contains the metadata. - - - - Gets the type of the . - - - - - Gets a value indicating whether this instance is the last block. - - - - - Gets the length of the block inside of the stream in bytes. - - The length does not include the metadata header. - - - - Flac metadata factory. - - - - - Gets the default factory instance. - - - - - Registers a new . - - The . - The object assigned to the . - - - - Registers a new . - - The metadata type as an integer. - The object assigned to the . - - - - Reads and returns a single from the specified . - - The stream which contains the . - Returns the read . - Could not read metadata. - - - - Represents a flac seektable. - - - - - Gets the number of entries, the seektable offers. - - - - - Gets the seek points. - - - - - Gets the at the specified . - - - The . - - The index. - The at the specified . - - - - Initializes the properties of the by reading them from the . - - The stream which contains the metadata. - - - - Gets the type of the . - - - - - Represents the streaminfo metadata flac which provides general information about the flac stream. - - - - - Initializes the properties of the by reading them from the . - - The stream which contains the metadata. - - - - Gets the type of the . - - - - - Gets the minimum size of the block in samples. - - - The minimum size of the block in samples. - - - - - Gets the maximum size of the block in samples. - - - The maximum size of the block in samples. - - - - - Gets the maximum size of the frame in bytes. - - - The maximum size of the frame in bytes. - - - - - Gets the minimum size of the frame in bytes. - - - The minimum size of the frame in bytes. - - - - - Gets the sample rate in Hz. - - - The sample rate. - - - - - Gets the number of channels. - - - The number of channels. - - - - - Gets the number of bits per sample. - - - The number of bits per sample. - - - - - Gets the total number of samples inside of the stream. - - - - - Gets MD5 signature of the unencoded audio data. - - - The MD5 signature of the unencoded audio data. - - - - - This method is based on the CUETools.NET BitReader (see http://sourceforge.net/p/cuetoolsnet/code/ci/default/tree/CUETools.Codecs/BitReader.cs) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - Defines flac metadata types. - - - - - Streaminfo metadata. - - - - - Padding metadata. - - - - - Application metadata. - - - - - Seektable metadata. - - - - - Vorbis comment metadata. - - - - - Cue sheet metadata. - - - - - Picture metadata. - - - - - Undefined metadata. Used for custom metadata fields. - - - - - Represents a single flac seek point. - - - - - The sample number for a placeholder point. - - - - - Gets the sample number of the first sample in the target frame, or for a placeholder point. - - - The sample number of the first sample in the target frame. - - According to https://xiph.org/flac/format.html#metadata_block_seektable. - - - - Gets the offset (in bytes) from the first byte of the first frame header to the first byte of the target frame's header. - - - The offset (in bytes) from the first byte of the first frame header to the first byte of the target frame's header. - "/> - According to https://xiph.org/flac/format.html#metadata_block_seektable. - - - - Gets the number of samples in the target frame. - - - The number of samples in the target frame. - - According to https://xiph.org/flac/format.html#metadata_block_seektable. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The of the target frame. - The of the target frame. - The of the target frame. - - - - Copied from http://stackoverflow.com/questions/8970101/whats-the-quickest-way-to-compute-log2-of-an-integer-in-c 14.01.2015 - - - - - This method is based on the CUETools.NET BitReader (see http://sourceforge.net/p/cuetoolsnet/code/ci/default/tree/CUETools.Codecs/BitReader.cs) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - Delegate which initializes a new decoder for a specific codec based on a . - - which contains the data that should be decoded by the codec decoder. - Decoder for a specific coded based on a . - - - - Mediafoundation MP1 decoder. - - - - - Gets a value which indicates whether the Mediafoundation MP1 decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides MP1 data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains MP1 data. - - - - Mediafoundation MP2 decoder. - - - - - Gets a value which indicates whether the Mediafoundation MP2 decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides MP2 data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains MP2 data. - - - - DirectX Media Object MP3 Decoder wrapper. - - - - - Initializes a new instance of the class. - - File which contains raw MP3 data. - - - - Initializes a new instance of the class. - - Stream which contains raw MP3 data. - - - - Gets or sets the position of the in bytes. - - - - - Gets the length of the in bytes. - - - - - Gets a value indicating whether the supports seeking. - - - - - Reads a sequence of bytes from the stream. - - An array of bytes. When this method returns, the buffer contains the read bytes. - The zero-based byte offset in buffer at which to begin storing the data read from the stream. - The maximum number of bytes to be read from the stream - The actual number of read bytes. - - - - Returns a to decode the mp3 data. - - Format of the mp3 data to decode. - Output format. - to decode the mp3 data. - - - - Returns the input format. - - Input format. - - - - Returns the output format. - - Output format. - - - - Gets raw mp3 data to decode. - - Byte array which will hold the raw mp3 data to decode. - Number of requested bytes. - Total amount of read bytes. - - - - Disposes the . - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Channelmode of MP3 data. For more information see the mp3 specification. - - - - - Stereo (left and right). - - - - - Joint stereo. - - - - - Dual channel. - - - - - Mono (only one channel). - - - - - The class describes an MPEG Audio Layer-3 (MP3) audio format. - - - - - Set this member to . - - - - - Indicates whether padding is used to adjust the average bitrate to the sampling rate. - - - - - Block size in bytes. This value equals the frame length in bytes x . For MP3 audio, the frame length is calculated as follows: 144 x (bitrate / sample rate) + padding. - - - - - Number of audio frames per block. - - - - - Encoder delay in samples. If you do not know this value, set this structure member to zero. - - - - - MPEGLAYER3_WFX_EXTRA_BYTES - - - - - Initializes a new instance of the class. - - Sample rate in Hz. - Number of channels. - Block size in bytes. This value equals the frame length in bytes x . For MP3 audio, the frame length is calculated as follows: 144 x (bitrate / sample rate) + padding. - Bitrate. - - - - Updates the - and the -property. - - - - - MP3 Format id. - - - - - None - - - - - Default value. Equals the MPEGLAYER3_ID_MPEG constant. - - - - - Constant frame size. - - - - - Represents an MP3 Frame. - - - - - Maximum length of one single in bytes. - - - - - Creates a new instance of the class based on a . - - which provides MP3 data. - A new instance of the class based on the specified . - - - - Creates a new instance of the class based on a . - - which provides MP3 data. - Byte array which recieves the content of the . - A new instance of the class based on the specified . - - - - Reads data from the . - - Buffer which will receive the read data. - Zero-based index at which to begin storing data within the . - The number of read bytes. - - - - Gets the Mpeg Version. - - - - - Gets the Mpeg Layer. - - - - - Gets the bit rate. - - - - - Gets the sample rate. - - - - - Gets the channel mode. - - - - - Gets the number of channels. - - - - - Gets the number of samples - - - - - Gets the length of the frame. - - - - - Gets the channel extension. - - - - - Gets a value which indicates whether the copyright flag is set (true means that the copyright flag is set). - - - - - Gets a value which indicates whether the original flag is set (true means that the original flag is set). - - - - - Gets the emphasis. - - - - - Gets the padding. - - - - - Gets a value which indicates whether the crc flag is set (true means that the crc flag is set). - - - - - MP3 Mediafoundation Decoder. - - - - - Gets a value which indicates whether the Mediafoundation MP3 decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides MP3 data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains MP3 data. - - - - Indicates whether padding is used to adjust the average bitrate to the sampling rate. Use one of the following values: - - - - - Insert padding as needed to achieve the stated average bitrate. - - - - - Always insert padding. The average bit rate may be higher than stated. - - - - - Never insert padding. The average bit rate may be lower than stated. - - - - - An implementation for streaming mp3 streams like mp3 radio stations, etc. - - - - - Initializes a new instance of the class. - - The address of the mp3 stream. - - - - Initializes a new instance of the class. - - The address of the mp3 stream. - If set to true, the connection will be established asynchronously and the constructor will return immediately. - Doing that, requires the usage of the event which will notify the caller when the - is ready for use. If set to false the constructor will block the current thread as long as it takes to establish the connection. - - - - - Initializes a new instance of the class. - - The address of the mp3 stream. - - - - Initializes a new instance of the class. - - The address of the mp3 stream. - If set to true, the connection will be established asynchronously and the constructor will return immediately. - Doing that, requires the usage of the event which will notify the caller when the - is ready for use. If set to false the constructor will block the current thread as long as it takes to establish the connection. - - - - - Gets the stream address. - - - - - Gets the number buffered bytes. - - - - - Gets the size of the internal buffer in bytes. - - - - - Gets a value indicating whether the supports seeking. - - This property will always be set to false. - - - - Gets the of the decoded mp3 stream. - If the internal decoder got not initialized yet, the value of the property is set to null. - - - - - Reads a sequence of elements from the and advances the position within the stream by the number of elements read. - - An array of elements. When this method returns, the contains the specified array of elements with the values between and ( + - 1) replaced by the elements read from the current source. - The zero-based offset in the at which to begin storing the data read from the current stream. - The maximum number of elements to read from the current source. - - The total number of elements read into the buffer. - - Mp3WebStream - - - - Gets or sets the current position. This property is not supported by the class. - - The Mp3WebStream class does not support seeking. - - - - Gets the length of the waveform-audio data. The value of this property will always be set to zero. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Occurs when connection got established and the async argument of the constructor was set to true. - - - - - Initializes the connection. - - true if the connection was initialized successfully; otherwise false. - - Could not create HttpWebRequest - or - Could not create WebResponse - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Defines all known Mpeg-layers. - - - - - Reserved by ISO. - - - - - MPEG Layer 3 - - - - - MPEG Layer 2 - - - - - MPEG Layer 1 - - - - - Defines all known Mpeg Versions. - - - - - Version 2.5 - - - - - Reserved by ISO - - - - - Version 2.0 - - - - - Version 1.0 - - - - - Defines a Xing-Header. - - - - - Gets the header flags of the . - - - - - Gets the of a . If the does not has an the return value will be null. - - which should get checked whether it contains a . - of the specified or null. - - - - Defines the header flags of a xing header. - - - - - Frames field is present - - - - - Bytes field is present. - - - - - TOC field is present. - - - - - Quality indicator field is present. - - - - - Mediafoundation WMA decoder. - - - - - Gets a value which indicates whether the Mediafoundation WMA, WMA-Speech and WMA-Professional decoder is supported on the current platform. - - - - - Gets a value which indicates whether the Mediafoundation WMA-Speech decoder is supported on the current platform. - - - - - Gets a value which indicates whether the Mediafoundation WMA-Professional decoder is supported on the current platform. - - - - - Gets a value which indicates whether the Mediafoundation WMA decoder is supported on the current platform. - - - - - Initializes a new instance of the class. - - Url which points to a data source which provides WMA data. This is typically a filename. - - - - Initializes a new instance of the class. - - Stream which contains WMA data. - - - - Implementation of the interface which reads raw data from a based - on a specified . - - - - - Initializes a new instance of the class. - - which contains raw waveform-audio data. - The format of the waveform-audio data within the . - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets a value indicating whether the supports seeking. - - - - - Gets the format of the raw data. - - - - - Gets or sets the position of the in bytes. - - - - - Gets the length of the in bytes. - - - - - Disposes the and the underlying . - - - - - Disposes the and the underlying . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls the method. - - - - - Represents the of a wave file. - - - - - Chunk ID of the . - - - - - Initializes a new instance of the class. - - which contains the data chunk. - - - - Initializes a new instance of the class. - - which should be used to read the data chunk. - - - - Gets the zero-based position inside of the stream at which the audio data starts. - - - - - Represents the of a wave file. - - - - - Chunk ID of the . - - - - - Initializes a new instance of the class. - - which contains the fmt chunk. - - - - Initializes a new instance of the class. - - which should be used to read the fmt chunk. - - - - Gets the specified by the . - - - - - Represents a wave file chunk. For more information see - . - - - - - Initializes a new instance of the class. - - which contains the wave file chunk. - - - - Initializes a new instance of the class. - - which should be used to read the wave file chunk. - - - - Gets the unique ID of the Chunk. Each type of chunk has its own id. - - - - - Gets the data size of the chunk. - - - - - Parses the and returns a . Note that the position of the - stream has to point to a wave file chunk. - - which points to a wave file chunk. - - Instance of the class or any derived classes. It the stream does not point to a - wave file chunk the instance of the which gets return will be invalid. - - - - - Provides a decoder for reading wave files. - - - - - Initializes a new instance of the class. - - Filename which points to a wave file. - - - - Initializes a new instance of the class. - - Stream which contains wave file data. - - - - Gets a list of all found chunks. - - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets the wave format of the wave file. This property gets specified by the . - - - - - Gets or sets the position of the in bytes. - - - - - Gets the length of the in bytes. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the and the underlying stream. - - - - - Disposes the and the underlying stream. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls the method. - - - - - Encoder for wave files. - - - - - Signals if the object has already been disposed - - - - - Signals if the object is in a disposing state - - - - - Initializes a new instance of the class. - - Filename of the destination file. This filename should typically end with the .wav extension. - - Format of the waveform-audio data. Note that the won't convert any - data. - - - - - Initializes a new instance of the class. - - Destination stream which should be used to store the - - Format of the waveform-audio data. Note that the won't convert any - data. - - - - - Disposes the and writes down the wave header. - - - - - Writes down all audio data of the to a file. - - The filename. - The source to write down to the file. - if set to true the file will be overritten if it already exists. - The maximum number of bytes to write. Use -1 to write an infinte number of bytes. - - This method is obsolete. Use the extension instead. - - - - - Encodes a single sample. - - The sample to encode. - - - - Encodes multiple samples. - - Float array which contains the samples to encode. - Zero-based offset in the array. - Number of samples to encode. - - - - Encodes raw data in the form of a byte array. - - Byte array which contains the data to encode. - Zero-based offset in the . - Number of bytes to encode. - - - - Writes down a single byte. - - Byte to write down. - - - - Writes down a single 16 bit integer value. - - Value to write down. - - - - Writes down a single 32 bit integer value. - - Value to write down. - - - - Writes down a single 32 bit float value. - - Value to write down. - - - - Disposes the and writes down the wave header. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor of the which calls the method. - - - - - Enables a client to read input data from a capture endpoint buffer. For more information, see - . - - - - - Initializes a new instance of the class. - - The native pointer of the IAudioCaptureClient COM object. - - - - Gets the size of the next packet in frames (the size of one frame equals the blockalign value of the waveformat). - - - - - Creates a new by calling the method of the - specified . - - - The which should be used to create the -instance - with. - - A new instance of the class. - - - - Retrieves a pointer to the next available packet of data in the capture endpoint buffer. - For more information see - . - - - A pointer variable into which the method writes the starting address of the next data - packet that is available for the client to read. - - - Variable into which the method writes the frame count (the number of audio frames - available in the data packet). The client should either read the entire data packet or none of it. - - Variable into which the method writes the buffer-status flags. - - Variable into which the method writes the device position of the first audio frame in the - data packet. The device position is expressed as the number of audio frames from the start of the stream. - - - Variable into which the method writes the value of the performance counter at the time that - the audio endpoint device recorded the device position of the first audio frame in the data packet. - - HRESULT - - - - Retrieves a pointer to the next available packet of data in the capture endpoint buffer. - For more information see - . - - - Variable into which the method writes the frame count (the number of audio frames available in - the data packet). The client should either read the entire data packet or none of it. - - Variable into which the method writes the buffer-status flags. - - Variable into which the method writes the device position of the first audio frame in the - data packet. The device position is expressed as the number of audio frames from the start of the stream. - - - Variable into which the method writes the value of the performance counter at the time that - the audio endpoint device recorded the device position of the first audio frame in the data packet. - - - Pointer to a variable which stores the starting address of the next data packet that is available for the - client to read. - - - Use Marshal.Copy to convert the pointer to the buffer into an array. - - - - - Retrieves a pointer to the next available packet of data in the capture endpoint buffer. - For more information see - . - - - Variable into which the method writes the frame count (the number of audio frames available in - the data packet). The client should either read the entire data packet or none of it. - - Variable into which the method writes the buffer-status flags. - - Pointer to a variable which stores the starting address of the next data packet that is available for the - client to read. - - - Use Marshal.Copy to convert the pointer to the buffer into an array. - - - - - The ReleaseBuffer method releases the buffer. For more information, see . - - - The number of audio frames that the client read from the - capture buffer. This parameter must be either equal to the number of frames in the - previously acquired data packet or 0. - - HRESULT - - - - The ReleaseBuffer method releases the buffer. For more information, see . - - - The number of audio frames that the client read from the - capture buffer. This parameter must be either equal to the number of frames in the - previously acquired data packet or 0. - - - - - The GetNextPacketSize method retrieves the number of frames in the next data packet in - the capture endpoint buffer. - For more information, see . - - - Variable into which the method writes the frame count (the number of audio - frames in the next capture packet). - - HRESULT - - - - The GetNextPacketSize method retrieves the number of frames in the next data packet in - the capture endpoint buffer. - For more information, see . - - The number of the audio frames in the next capture packet. - - - - Defines flags that indicate the status of an audio endpoint buffer. - - - - - None - - - - - The data in the packet is not correlated with the previous packet's device position; - this is possibly due to a stream state transition or timing glitch. - - - - - Treat all of the data in the packet as silence and ignore the actual data values. - - - - - The time at which the device's stream position was recorded is uncertain. Thus, the - client might be unable to accurately set the time stamp for the current data packet. - - - - - The constants indicate characteristics of an audio session associated with - the stream. A client can specify these options during the initialization of the stream by through the - StreamFlags parameter of the method. - - - - - The session expires when there are no associated streams and owning session control objects holding references. - - - - - The volume control is hidden in the volume mixer user interface when the audio session is created. If the session - associated with the stream already exists before opens the stream, the volume - control is displayed in the volume mixer. - - - - - The volume control is hidden in the volume mixer user interface after the session expires. - - - - - Specifies characteristics that a client can assign to an audio stream during the initialization of the stream. - - - - - None - - - - - The audio stream will be a member of a cross-process audio session. For more information, see - . - - - - - The audio stream will operate in loopback mode. For more information, see - . - - - - - Processing of the audio buffer by the client will be event driven. For more information, see - . - - - - - The volume and mute settings for an audio session will not persist across system restarts. For more information, - see . - - - - - This constant is new in Windows 7. The sample rate of the stream is adjusted to a rate specified by an application. - For more information, see - . - - - - - The class enables a client to monitor a stream's data rate and the current position in - the stream. - - - - - Initializes a new instance of the class. - - The native pointer of the IAudioClock COM Object. - - - - Gets the device frequency. For more information, see - . - - - - - Gets the device position. - - - - - Creates a new by calling the method of the - specified . - - - which should be used to create the -instance - with. - - A new . - - - - The GetFrequency method gets the device frequency. - - - The device frequency. For more information, see - . - - HRESULT - - - - The GetPosition method gets the current device position. - - - The device position is the offset from the start of the stream to the current position in the stream. However, the - units in which this offset is expressed are undefined—the device position value has meaning only in relation to the - . For more information, see - . - - - The value of the performance counter at the time that the audio endpoint device read the device position - () in response to the call. The method converts - the counter value to 100-nanosecond time - units before writing it to . - - HRESULT - - - - The GetCharacteristics method is reserved for future use. - - Value that indicates the characteristics of the audio clock. - HREUSLT - - - - Used to get the device position. - - - - - Initializes a new instance of the class. - - The native pointer of the IAudioClock2 COM object. - - - - Initializes a new instance of the class. - - - An instance which should be used to query the - object. - - The argument is null. - - The COM object is not supported on the current platform. Only supported on Windows - 7/Windows Server 2008 R2 and above. - For more information, see - . - - - - - The method gets the current device position, in frames, directly from the - hardware. - - - Receives the device position, in frames. The received position is an unprocessed value - that the method obtains directly from the hardware. For more information, see - . - - - Receives the value of the performance counter at the time that the audio endpoint device read - the device position retrieved in the parameter in response to the - call. - converts the counter value to 100-nanosecond time units before writing it to - QPCPosition. - - HRESULT - - - - The method gets the current device position, in frames, directly from the - hardware. - - - Receives the device position, in frames. The received position is an unprocessed value - that the method obtains directly from the hardware. For more information, see - . - - - Receives the value of the performance counter at the time that the audio endpoint device read - the device position retrieved in the parameter in response to the - call. - converts the counter value to 100-nanosecond time units before writing it to - QPCPosition. - - - - - Represents a peak meter on an audio stream to or from an audio endpoint device. - For more information, see - . - - - - - Initializes a new instance of class. - - The native pointer. - - - - Gets the number of channels in the audio stream that are monitored by peak meters. - - - - - - - Gets the peak sample value for the given . - - - - - The peak sample value for the given . - - - - Gets the hardware-supported functions. - - - - - - - Gets the peak sample value for the channels in the audio stream. - - - - - - - Creates a new instance for the given . - - The underlying device to create the audio meter instance for. - A new instance for the given . - - - - Gets the peak sample value for the channels in the audio stream. - - - A variable into which the method writes the peak sample value for the audio stream. The peak value - is a number in the normalized range from 0.0 to 1.0. - - HRESULT - - - - Gets the peak sample value for the channels in the audio stream. - - - The peak sample value for the audio stream. The peak value is a number in the normalized range from 0.0 to - 1.0. - - - - - Gets the number of channels in the audio stream that - are monitored by peak meters. - - A variable into which the method writes the number of channels. - HRESULT - - - - Gets the number of channels in the audio stream that - are monitored by peak meters. - - The number of channels. - - - - Gets the peak sample values for all the channels in the - audio stream. - - - - The channel count. This parameter also specifies the number of elements in the - array. If the specified count does not match the number of channels in the stream, - the method returns error code . - - - An array of peak sample values. The method writes the peak values for the channels into the - array. The array contains one element for each channel in the stream. The peak values are numbers in the normalized - range from 0.0 to 1.0. The array gets allocated by the method. - - HRESULT - - - - Gets the peak sample values for all the channels in the - audio stream. - - - - The channel count. This parameter also specifies the number of elements in the returned - array. If the specified count does not match the number of channels in the stream, the method returns error code - . - - - An array of peak sample values. he array contains one element for each channel in the stream. The peak values - are numbers in the normalized range from 0.0 to 1.0. - - - - - Gets the peak sample values for all the channels in the - audio stream. - - - An array of peak sample values. he array contains one element for each channel in the stream. The peak values - are numbers in the normalized range from 0.0 to 1.0. - - - - - Queries the audio endpoint device for its - hardware-supported functions. - - - A variable into which the method writes a hardware support mask that indicates the - hardware capabilities of the audio endpoint device. - - HRESULT - - - - Queries the audio endpoint device for its - hardware-supported functions. - - A hardware support mask that indicates the hardware capabilities of the audio endpoint device. - - - - Provides data for the event. - - - - - Gets the number of audio channels in the session submix. - - - - - Gets the volume level for each audio channel. Each volume level is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume. - - - - - Gets the index of the audio channel that changed. Use this value as an index into the . - If the session submix contains n channels, the channels are numbered from 0 to n– 1. If more than one channel might have changed, the value of ChangedChannel is (DWORD)(–1). - - - - - Gets the volume of the channel specified by the . - - The zero-based index of the channel. - Volume level of the specified channelIndex in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume. - - - - Initializes a new instance of the class. - - The number of channels. - Volumes of the channels. - Number of channel volumes changed. - Userdefined event context. - - - - The class can be used by a client to get information about the audio session. - For more information, see . - - - - - Initializes a new instance of the class. - - The native pointer to the IAudioSessionControl2 object. - - - - Gets the session identifier. - - For more information, see . - - - - Gets the identifier of the audio session instance. - - For more information, see . - - - - Gets the process identifier of the audio session. - In the case of that the session is no single-process-session (see ), the is the initial identifier of the process that created the session. - - - - - Gets a value indicating whether the session spans more than one process. If True, the session spans more than one process; If False otherwise. - - - - - Gets the process of the audio session. - In the case of that the session is no SingleProcessSession (see ), the Process is the process that created the session. - If the process that created the session is not available anymore, the value is null. - - - - - Gets a value indicating whether the session is a system sounds session. If True, the session is a system sound session; If False otherwise. - - - - - Gets the session identifier. - - - A variable which retrieves the session identifier. - HRESULT - - - - Gets the identifier of the audio session instance. - - - A variable which retrieves the identifier of a particular instance of the audio session. - HRESULT - - - - Gets the process identifier of the audio session. - - - A variable which receives the process id of the audio session. - HRESULT - - - - Indicates whether the session is a system sounds session. - - - HRESULT; S_OK = true, S_FALSE = false - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - HRESULT - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - - - - Provides data for the event. - - - - - Gets the reason that the audio session was disconnected. - - - - - Initializes a new instance of the class. - - The reason that the audio session was disconnected. - - - - Specifies reasons that a audio session was disconnected. - - For more information about WTS sessions, see the Windows SDK documentation or . - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the Windows Terminal Services (WTS) session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Provides data for the event. - - - - - Gets the new display name the session. - - - - - Initializes a new instance of the class. - - Thew new display name of the session. - The event context value. - - - - The object enumerates audio sessions on an audio device. - For more information, see . - - - - - Initializes a new instance of the class. - - The native pointer of the object. - - - - Gets the total number of audio sessions. - - - - - Gets the audio session specified by an index. - - The session number. If there are n sessions, the sessions are numbered from 0 to n – 1. To get the number of sessions, call the GetCount method. - - - - Gets the total number of audio sessions that are open on the audio device. - - - Receives the total number of audio sessions. - HRESULT - - - - Gets the audio session specified by an audio session number. - - - The session number. If there are n sessions, the sessions are numbered from 0 to n – 1. To get the number of sessions, call the GetCount method. - The of the specified session number. - HRESULT - - - - Gets the audio session specified by an audio session number. - - The session number. If there are n sessions, the sessions are numbered from 0 to n – 1. To get the number of sessions, call the GetCount method. - The of the specified session number. - - - - Returns an enumerator that iterates through the audio sessions. - - - A that can be used to iterate through the audio sessions. - - - - - Returns an enumerator that iterates through the audio sessions. - - - An object that can be used to iterate through the audio sessions. - - - - - A base class for all event-args classes which specify an value. - - - - - Gets the event context value. - - - - - Initializes a new instance of the class. - - The event context value. - - - - Provides notifications of session-related events such as changes in the volume level, display name, and session state. - For more information, see . - - - - - Occurs when the display name for the session has changed. - - - - - Occurs when the display icon for the session has changed. - - - - - Occurs when the volume level or muting state of the session has changed. - - - - - Occurs when the volume level of an audio channel in the session submix has changed. - - - - - Occurs when the grouping parameter for the session has changed. - - - - - Occurs when the stream-activity state of the session has changed. - - - - - Occurs when the session has been disconnected. - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - The event context value. - HRESULT - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - The event context value. - HRESULT - - - - Notifies the client that the volume level or muting state of the audio session has changed. - - - The new volume level for the audio session. This parameter is a value in the range 0.0 to 1.0, - where 0.0 is silence and 1.0 is full volume (no attenuation). - - The new muting state. If TRUE, muting is enabled. If FALSE, muting is disabled. - The event context value. - HRESULT - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The number of channels in the session submix. - An array of volume levels. Each element is a value of type float that specifies the volume level for a particular channel. Each volume level is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume (no attenuation). The number of elements in the array is specified by the ChannelCount parameter. - The number of the channel whose volume level changed. - The event context value. - - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. This parameter points to a grouping-parameter GUID. - The event context value. - HRESULT - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - HRESULT - - - - Notifies the client that the audio session has been disconnected. - - The reason that the audio session was disconnected. - HRESULT - - - - Provides data for the event. - - - - - Gets the new grouping parameter for the session. - - - - - Initializes a new instance of the class. - - The new grouping parameter for the session. - The event context value. - - - - Provides data for the event. - - - - - Gets the path for the new display icon for the session. - - - - - Initializes a new instance of the class. - - The path for the new display icon for the session. - The event context value. - - - - The class enables a client to access the session controls and volume controls for both cross-process and process-specific audio sessions. - - - - - Initializes a new instance of the class. - - Native pointer to the object. - - - - Retrieves an audio session control. - - If the GUID does not identify a session that has been previously opened, the call opens a new but empty session. If the value is Guid.Empty, the method assigns the stream to the default session. - Specifies the status of the flags for the audio stream. - The of the specified . - HRESULT - - - - Retrieves an audio session control. - - If the GUID does not identify a session that has been previously opened, the call opens a new but empty session. If the value is Guid.Empty, the method assigns the stream to the default session. - Specifies the status of the flags for the audio stream. - instance. - - - - Retrieves a simple audio volume control. - - Specifies whether the request is for a cross-process session. Set to TRUE if the session is cross-process. Set to FALSE if the session is not cross-process. - If the GUID does not identify a session that has been previously opened, the call opens a new but empty session. If the value is Guid.Empty, the method assigns the stream to the default session. - of the audio volume control object. - HRESULT - - - - Retrieves a simple audio volume control. - - Specifies whether the request is for a cross-process session. Set to TRUE if the session is cross-process. Set to FALSE if the session is not cross-process. - If the GUID does not identify a session that has been previously opened, the call opens a new but empty session. If the value is Guid.Empty, the method assigns the stream to the default session. - instance. - - - - Enables an application to manage submixes for the audio device. - - - - - Occurs when the audio session has been created. - - - - - Occurs when a pending system ducking event gets fired. - - - - - Occurs when a pending system unducking event gets fired. - - - - - Creates a new instance of based on a . - - Device to use to activate the . - instance for the specified . - - - - Initializes a new instance of the class. - - The native pointer. - - - - Gets a pointer to the audio session enumerator object. - - - Retrieves a session enumerator object that the client can use to enumerate audio sessions on the audio device. - HRESULT - The client is responsible for releasing the . - - - - Gets a pointer to the audio session enumerator object. - - a session enumerator object that the client can use to enumerate audio sessions on the audio device. - The client is responsible for releasing the returned . - - - - Registers the application to receive a notification when a session is created. - - - The application's implementation of the interface. - HRESULT - - Use the class as the default implementation for the parameter. - - Note: Make sure to call the from an MTA-Thread. Also make sure to enumerate all sessions after calling this method. - - - - - Registers the application to receive a notification when a session is created. - - The application's implementation of the interface. - - Use the class as the default implementation for the parameter. - - Note: Make sure to call the from an MTA-Thread. Also make sure to enumerate all sessions after calling this method. - - - - - Deletes the registration to receive a notification when a session is created. - - - - The application's implementation of the interface. - Pass the same object that was specified to the session manager in a previous call to register for notification. - HRESULT - - - - Deletes the registration to receive a notification when a session is created. - - - The application's implementation of the interface. - Pass the same object that was specified to the session manager in a previous call to register for notification. - - - - Registers the application to receive ducking notifications. - - - A string that contains a session instance identifier. Applications that are playing a media stream and want to provide custom stream attenuation or ducking behavior, pass their own session instance identifier. - Other applications that do not want to alter their streams but want to get all the ducking notifications must pass NULL. - Instance of any object which implements the and which should receive duck notifications. - HRESULT - - - - Registers the application to receive ducking notifications. - - A string that contains a session instance identifier. Applications that are playing a media stream and want to provide custom stream attenuation or ducking behavior, pass their own session instance identifier. - Other applications that do not want to alter their streams but want to get all the ducking notifications must pass NULL. - Instance of any object which implements the and which should receive duck notifications. - - - - Deletes the registration to receive ducking notifications. - - - - The interface that is implemented by the application. Pass the same interface pointer that was specified to the session manager in a previous call to the method. - - HRESULT - - - - Deletes the registration to receive ducking notifications. - - - The interface that is implemented by the application. Pass the same interface pointer that was specified to the session manager in a previous call to the method. - - - - - Releases the COM object and unregisters all session notifications and all volume duck notifications. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - The object provides notification when an audio session is created. - For more information, . - - - - - Occurs when the audio session has been created. - - - - - Notifies the registered processes that the audio session has been created. - - Pointer to the object of the audio session that was created. - HRESULT - - - - Provides data for the event. - - - - - Gets the new volume level for the audio session. - - The value is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume (no attenuation). - - - - Gets the new muting state. - - If true, muting is enabled. If false, muting is disabled. - - - - Initializes a new instance of the class. - - The new volume level for the audio session. This parameter is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume (no attenuation). - The muting state. If true, muting is enabled. If false, muting is disabled. - The event context value. - - - - Defines constants that indicate the current state of an audio session. - - - - - The session has no active audio streams. - - - - - The session has active audio streams. - - - - - The session is dormant. - - - - - Provides data for the event. - - - - - Gets the new session state. - - - - - Initializes a new instance of the class. - - - - - - The default implementation of the interface. - - - - - Occurs when a pending system ducking event gets fired. - - - - - Occurs when a pending system unducking event gets fired. - - - - - Sends a notification about a pending system ducking event. - - A string containing the session instance identifier of the communications session that raises the the auto-ducking event. - The number of active communications sessions. If there are n sessions, the sessions are numbered from 0 to –1. - HRESULT - - - - Sends a notification about a pending system unducking event. - - A string containing the session instance identifier of the terminating communications session that intiated the ducking. - The number of active communications sessions. If there are n sessions, they are numbered from 0 to n-1. - - - - - Provides data for the event. - - - - - Gets the data-flow direction of the endpoint device. - - - - - Gets the device role of the audio endpoint device. - - - - - Initializes a new instance of the class. - - The device id that identifies the audio endpoint device. - The data-flow direction of the endpoint device. - The device role of the audio endpoint device. - - - - Provides basic data for all device notification events. - - - - - Gets the device id that identifies the audio endpoint device. - - - - - Initializes a new instance of the class. - - The device id that identifies the audio endpoint device. - - - - Tries the get device associated with the . - - The device associated with the . If the return value is false, the will be null. - true if the associated device be successfully retrieved; false otherwise. - - - - Provides data for the event. - - - - - Gets the that specifies the changed property. - - - - - Initializes a new instance of the class. - - The device id that identifies the audio endpoint device. - The that specifies the changed property. - - - - Provides data for the event. - - - - - Gets the new state of the endpoint device. - - - - - Initializes a new instance of the class. - - The device id that identifies the audio endpoint device. - The new state of the endpoint device. - - - - The class enables a client to configure the control parameters for an audio session and to monitor events in the session. - For more information, see . - - - - - Occurs when the display name for the session has changed. - - - - - Occurs when the display icon for the session has changed. - - - - - Occurs when the volume level or muting state of the session has changed. - - - - - Occurs when the volume level of an audio channel in the session submix has changed. - - - - - Occurs when the grouping parameter for the session has changed. - - - - - Occurs when the stream-activity state of the session has changed. - - - - - Occurs when the session has been disconnected. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - - - - Initializes a new instance of the class. - - The audio client to create a instance for. - audioClient - - - - Gets the current state of the audio session. - - - - - Gets or sets the display name for the audio session. - - - - - Gets or sets the path for the display icon for the audio session. - - - - - Gets or sets the grouping parameter of the audio session. - - - - - Retrieves the current state of the audio session. - - - A variable into which the method writes the current session state. - HRESULT - - - - Retrieves the display name for the audio session. - - - A variable into which the method writes the display name of the session. - HRESULT - - - - Assigns a display name to the current session. - - - The new display name of the audio session. - EventContext which can be accessed in the event handler. - HRESULT - - - - Retrieves the path for the display icon for the audio session. - - - A variable into which the method writes the path and file name of an .ico, .dll, or .exe file that contains the icon. - HRESULT - - - - Assigns a display icon to the current session. - - - A string that specifies the path and file name of an .ico, .dll, or .exe file that contains the icon. - EventContext which can be accessed in the event handler. - HRESULT - - - - Retrieves the grouping parameter of the audio session. - - - A variable into which the method writes the grouping parameter. - HRESULT - For some more information about grouping parameters, see . - - - - Assigns a session to a grouping of sessions. - - - - - HRESULT - For some more information about grouping parameters, see . - - - - Registers the client to receive notifications of session events, including changes in the stream state. - - - An instance of the object which receives the notifications. - HRESULT - - - - Registers the client to receive notifications of session events, including changes in the stream state. - - An instance of the object which receives the notifications. - - - - Deletes a previous registration by the client to receive notifications. - - The instance of the object which got registered previously by the method. - HRESULT - - - - Deletes a previous registration by the client to receive notifications. - - The instance of the object which got registered previously by the method. - - - - Releases the COM object. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - The interface provides notifications of session-related events such as changes in the volume level, display name, and session state. - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - The event context value. - HRESULT - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - The event context value. - HRESULT - - - - Notifies the client that the volume level or muting state of the audio session has changed. - - The new volume level for the audio session. This parameter is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume (no attenuation). - The new muting state. If TRUE, muting is enabled. If FALSE, muting is disabled. - The event context value. - HRESULT - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The number of channels in the session submix. - An array of volume levels. Each element is a value of type float that specifies the volume level for a particular channel. Each volume level is a value in the range 0.0 to 1.0, where 0.0 is silence and 1.0 is full volume (no attenuation). The number of elements in the array is specified by the ChannelCount parameter. - The number of the channel whose volume level changed. - The event context value. - HRESULT - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. This parameter points to a grouping-parameter GUID. - The event context value. - HRESULT - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - HRESULT - - - - Notifies the client that the audio session has been disconnected. - - The reason that the audio session was disconnected. - HRESULT - - - - The interface provides notification when an audio session is created. - - - - - Notifies the registered processes that the audio session has been created. - - Pointer to the object of the audio session that was created. - HRESULT - - - - The interface is used to by the system to send notifications about stream attenuation changes. - - For more information, see . - - - - Sends a notification about a pending system ducking event. - - A string containing the session instance identifier of the communications session that raises the the auto-ducking event. - The number of active communications sessions. If there are n sessions, the sessions are numbered from 0 to –1. - HRESULT - - - - Sends a notification about a pending system unducking event. - - A string containing the session instance identifier of the terminating communications session that intiated the ducking. - The number of active communications sessions. If there are n sessions, they are numbered from 0 to n-1. - HRESULT - - - - The interface provides notifications when an audio endpoint device is added or removed, when the state or properties of an endpoint device change, or when there is a change in the default role assigned to an endpoint device. - - - - - The OnDeviceStateChanged method indicates that the state of an audio endpoint device has - changed. - - The device id that identifies the audio endpoint device. - Specifies the new state of the endpoint device. - HRESULT - - - - The OnDeviceAdded method indicates that a new audio endpoint device has been added. - - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnDeviceRemoved method indicates that an audio endpoint device has been removed. - - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnDefaultDeviceChanged method notifies the client that the default audio endpoint - device for a particular device role has changed. - - The data-flow direction of the endpoint device. - The device role of the audio endpoint device. - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnPropertyValueChanged method indicates that the value of a property belonging to an - audio endpoint device has changed. - - The device id that identifies the audio endpoint device. - The that specifies the changed property. - HRESULT - - - - Represents an audio endpoint device - (see also ). - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - Obtain an instance of the by using the constructor. - - - - - Initializes a new instance of the class based on an - by calling its method. - - The used to obtain an instance. - device - - - - Gets the data flow of the associated device. - - - The data flow of the associated device. - - - - - Indicates whether the endpoint is associated with a rendering device or a capture device. - - A variable into which the method writes the data-flow direction of the endpoint device. - HRESULT - Use the property instead. - - - - Provides data for the event. - - - - - Gets the object of the audio session that was created. - - - - - Initializes a new instance of the class. - - The object of the audio session that was created. - must not be null. - - - - Provides data for the and the event. - For more information, see . - - - - - A string containing the session instance identifier of the communications session that raises the auto-ducking event. - - - - - The number of active communications sessions. If there are n sessions, the sessions are numbered from 0 to –1. - - - - - Initializes a new instance of the class. - - The session instance identifier of the communications session that raises the the auto-ducking event. - number of active communications sessions. - sessionID is null or empty. - countCommunicationSessions is less than zero. - - - - The interface represents the volume controls on the audio stream to or from an - audio endpoint device. - For more information, see - . - - - - - Initializes a new instance of the class. - - Native pointer of the object. - - - - Gets all registered . - - - - - Gets the number of available channels. - - - - - - Gets or sets the MasterVolumeLevel in decibel. - - - - - - - Gets or sets the MasterVolumeLevel as a normalized value in the range from 0.0 to 1.0. - - - - - - - Gets or sets the muting state of the audio stream that enters or leaves the - audio endpoint device. True indicates that the audio endpoint devie is muted. False indicates that the audio endpoint device is not muted. - - - - - - - Gets all available channels. - - - - - Returns a new instance based on a instance. - - instance to create the for. - A new instance based on the specified . - - - - Registers a client's notification callback - interface. - - The callback instance that the client is registering for notification callbacks. - HRESULT - - When notifications are no longer needed, the client can call the - method to terminate the - notifications. - - - - - Registers a client's notification callback - interface. - - The callback instance that the client is registering for notification callbacks. - - When notifications are no longer needed, the client can call the - method to terminate the - notifications. - - - - - Deletes the registration of a client's - notification callback interface that the client registered in a previous call to the - method. - - - The callback instance to unregister. The client passed this same object to the endpoint volume - object in the previous call to the method. - - HRESULT - - - - Deletes the registration of a client's - notification callback interface that the client registered in a previous call to the - method. - - - The callback instance to unregister. The client passed this same object to the endpoint volume - object in the previous call to the method. - - - - - Gets the number of channels in the audio stream that enters - or leaves the audio endpoint device. - - Retrieves the number of channels in the audio stream. - HRESULT - - - - Gets the number of channels in the audio stream that enters - or leaves the audio endpoint device. - - The number of channels in the audio stream. - - - - Sets the master volume level, in decibels, of the audio - stream that enters or leaves the audio endpoint device. - - - The new master volume level in decibels. To obtain the range and - granularity of the volume levels that can be set by this method, call the - method. - - EventContext which can be accessed in the event handler. - HRESULT - - - - Sets the master volume level, in decibels, of the audio - stream that enters or leaves the audio endpoint device. - - - The new master volume level in decibels. To obtain the range and - granularity of the volume levels that can be set by this method, call the - method. - - EventContext which can be accessed in the event handler. - - - - Sets the master volume level of the audio stream - that enters or leaves the audio endpoint device. The volume level is expressed as a - normalized, audio-tapered value in the range from 0.0 to 1.0. - - - The new master volume level. The level is expressed as a normalized - value in the range from 0.0 to 1.0. - - EventContext which can be accessed in the event handler. - HRESULT - - - - Sets the master volume level of the audio stream - that enters or leaves the audio endpoint device. The volume level is expressed as a - normalized, audio-tapered value in the range from 0.0 to 1.0. - - - The new master volume level. The level is expressed as a normalized - value in the range from 0.0 to 1.0. - - EventContext which can be accessed in the event handler. - - - - Gets the master volume level, in decibels, of the audio - stream that enters or leaves the audio endpoint device. - - - A - float variable into which the method writes the volume level in decibels. To get the - range of volume levels obtained from this method, call the - method. - - HRESULT - - - - Gets the master volume level, in decibels, of the audio - stream that enters or leaves the audio endpoint device. - - - Volume level in decibels. To get the range of volume levels obtained from this - method, call the method. - - - - - Gets the master volume level of the audio stream - that enters or leaves the audio endpoint device. The volume level is expressed as a - normalized, audio-tapered value in the range from 0.0 to 1.0. - - - A float - variable into which the method writes the volume level. The level is expressed as a - normalized value in the range from 0.0 to 1.0. - - HRESULT - - - - Gets the master volume level of the audio stream - that enters or leaves the audio endpoint device. The volume level is expressed as a - normalized, audio-tapered value in the range from 0.0 to 1.0. - - - Volume level. The level is expressed as a normalized value in the range from - 0.0 to 1.0. - - - - - Sets the volume level, in decibels, of the specified - channel of the audio stream that enters or leaves the audio endpoint device. - - - The new volume level in decibels. To obtain the range and - granularity of the volume levels that can be set by this method, call the - method. - - EventContext which can be accessed in the event handler. - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - HRESULT - - - - Sets the volume level, in decibels, of the specified - channel of the audio stream that enters or leaves the audio endpoint device. - - - The new volume level in decibels. To obtain the range and - granularity of the volume levels that can be set by this method, call the - method. - - EventContext which can be accessed in the event handler. - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - - - - Sets the normalized, audio-tapered volume level - of the specified channel in the audio stream that enters or leaves the audio endpoint - device. - - - The volume level. The volume level is expressed as a normalized - value in the range from 0.0 to 1.0. - - EventContext which can be accessed in the event handler. - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - HRESULT - - - - Sets the normalized, audio-tapered volume level - of the specified channel in the audio stream that enters or leaves the audio endpoint - device. - - - The volume level. The volume level is expressed as a normalized - value in the range from 0.0 to 1.0. - - EventContext which can be accessed in the event handler. - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - - - - Gets the volume level, in decibels, of the specified - channel in the audio stream that enters or leaves the audio endpoint device. - - - A float variable into which the method writes the - volume level in decibels. To get the range of volume levels obtained from this method, - call the method. - - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - HRESULT - - - - Gets the volume level, in decibels, of the specified - channel in the audio stream that enters or leaves the audio endpoint device. - - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - - Volume level in decibels. To get the range of volume levels obtained from this - method, call the method. - - - - - Gets the normalized, audio-tapered volume level - of the specified channel of the audio stream that enters or leaves the audio endpoint - device. - - - A float variable into which the method writes the volume - level. The level is expressed as a normalized value in the range from 0.0 to - 1.0. - - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - HRESULT - - - - Gets the normalized, audio-tapered volume level - of the specified channel of the audio stream that enters or leaves the audio endpoint - device. - - - The channel number. If the audio stream contains n channels, the channels are numbered from 0 to - n–1. - - - Volume level of a specific channel. The level is expressed as a normalized - value in the range from 0.0 to 1.0. - - - - - Sets the muting state of the audio stream that enters or leaves the - audio endpoint device. - - True mutes the stream. False turns off muting. - EventContext which can be accessed in the event handler. - HRESULT - - - - Sets the muting state of the audio stream that enters or leaves the - audio endpoint device. - - EventContext which can be accessed in the event handler. - True mutes the stream. False turns off muting. - - - - Gets the muting state of the audio stream that enters or leaves the - audio endpoint device. - - - A Variable into which the method writes the muting state. - If is true, the stream is muted. If false, the stream is not muted. - - HRESULT - - - - Gets the muting state of the audio stream that enters or leaves the - audio endpoint device. - - If the method returns true, the stream is muted. If false, the stream is not muted. - - - - Gets information about the current step in the volume - range. - - - A variable into which the method writes the current step index. This index is a value in the - range from 0 to – 1, where 0 represents the minimum volume level and - – 1 represents the maximum level. - - - A variable into which the method writes the number of steps in the volume range. This number - remains constant for the lifetime of the object instance. - - HRESULT - - - - Gets information about the current step in the volume - range. - - - A variable into which the method writes the current step index. This index is a value in the - range from 0 to – 1, where 0 represents the minimum volume level and - – 1 represents the maximum level. - - - A variable into which the method writes the number of steps in the volume range. This number - remains constant for the lifetime of the object instance. - - - - - Increments, by one step, the volume level of the audio stream - that enters or leaves the audio endpoint device. - - EventContext which can be accessed in the event handler. - HRESULT - - - - Increments, by one step, the volume level of the audio stream - that enters or leaves the audio endpoint device. - - EventContext which can be accessed in the event handler. - - - - Decrements, by one step, the volume level of the audio stream - that enters or leaves the audio endpoint device. - - EventContext which can be accessed in the event handler. - HRESULT - - - - Decrements, by one step, the volume level of the audio stream - that enters or leaves the audio endpoint device. - - EventContext which can be accessed in the event handler. - - - - Queries the audio endpoint device for its - hardware-supported functions. - - - A variable into which the method writes a hardware support mask that indicates the - hardware capabilities of the audio endpoint device. - - HRESULT - - - - Queries the audio endpoint device for its - hardware-supported functions. - - A hardware support mask that indicates the hardware capabilities of the audio endpoint device. - - - - Gets the volume range, in decibels, of the audio stream that - enters or leaves the audio endpoint device. - - - Minimum volume level in decibels. This value remains constant - for the lifetime of the object instance. - - - Maximum volume level in decibels. This value remains constant - for the lifetime of the object instance. - - - Volume increment in decibels. This increment remains - constant for the lifetime of the object instance. - - HREUSLT - - - - Gets the volume range, in decibels, of the audio stream that - enters or leaves the audio endpoint device. - - - Minimum volume level in decibels. This value remains constant - for the lifetime of the object instance. - - - Maximum volume level in decibels. This value remains constant - for the lifetime of the object instance. - - - Volume increment in decibels. This increment remains - constant for the lifetime of the object instance. - - - - - Provides an implementation of the interface. - - - - - Occurs when the volume level or the muting state of the audio endpoint device has changed. - - - - - The method notifies the client that the volume level or muting state of the audio endpoint device has changed. - - Pointer to the volume-notification data. - HRESULT; If the method succeeds, it returns . If it fails, it returns an error code. - - - - Provides data for the event. - - - - - Initializes a new instance of the class. - - The data which describes a change in the volume level or muting state of an audio endpoint device. - The native pointer to the . - - - - Gets the event context value. - - - The event context value. - - - Context value for the method. This member is the value of the - event-context GUID that was provided as an input parameter to the method call - that changed the endpoint volume level or muting state. For more information, see - . - - - - - Gets a value indicating whether the audio stream is currently muted. - - - true if the audio stream is currently muted; otherwise, false. - - - - - Gets the current master volume level of the audio stream. The volume level is - normalized to the range from 0.0 to 1.0, where 0.0 is the minimum volume level and 1.0 - is the maximum level. Within this range, the relationship of the normalized volume level - to the attenuation of signal amplitude is described by a nonlinear, audio-tapered curve. - - - - - Gets the number of channels. - - - The number of channels. - - - - - Gets the volume level for each channel is normalized to the range from 0.0 to 1.0, where 0.0 - is the minimum volume level and 1.0 is the maximum level. Within this range, the - relationship of the normalized volume level to the attenuation of signal amplitude is - described by a nonlinear, audio-tapered curve. - - - - - Represents a single audio endpoint volume channel. - - - - - Gets the parent instance. - - - The parent instance. - - - - - Gets the index of the audio endpoint channel. - - - The index of the audio endpoint channel. - - - - - Initializes a new instance of the class. - - The underlying which provides access to the audio endpoint volume. - The zero-based index of the channel. - - - - Gets or sets the volume in decibel. - - - The volume in decibel. - - - - - Gets or sets the volume as a normalized value in the range from 0.0 to 1.0. - - - The volume as a normalized value in the range from 0.0 to 1.0. - - - - - The class enables a client to write output data to a rendering endpoint buffer. - - - For more information, see - . - - - - - Initializes a new instance of the class. - - Pointer to the instance. - - - - Returns a new instance of the class. This is done by calling the - method of the class. - - - The instance which should be used to create the new - instance. - - A new instance of the class. - - - - Retrieves a pointer to the next available space in the rendering endpoint buffer into - which the caller can write a data packet. - - - The number of audio frames in the data packet that the caller plans to write to the requested space in the buffer. - If the call succeeds, the size of the buffer area pointed to by return value matches the size specified in - . - - - A pointer variable into which the method writes the starting address of the buffer area into which the caller - will write the data packet. - - - - - Retrieves a pointer to the next available space in the rendering endpoint buffer into - which the caller can write a data packet. - - - The number of audio frames in the data packet that the caller plans to write to the requested space in the buffer. - If the call succeeds, the size of the buffer area pointed to by matches the size - specified in . - - - Pointer variable into which the method writes the starting address of the buffer area into which - the caller will write the data packet. - - HRESULT - - - - Releases the buffer space acquired in the previous call to the - method. - - - The number of audio frames written by the client to the data packet. - The value of this parameter must be less than or equal to the size of the data packet, as specified in the - numFramesRequested parameter passed to the method. - - The buffer-configuration flags. - HRESULT - - - - Releases the buffer space acquired in the previous call to the - method. - - - The number of audio frames written by the client to the data packet. - The value of this parameter must be less than or equal to the size of the data packet, as specified in the - numFramesRequested parameter passed to the method. - - The buffer-configuration flags. - - - - The structure describes a change in the volume level or muting state of an audio endpoint device. - For more information, see . - - - - - The event context value. - - - Context value for the method. This member is the value of the - event-context GUID that was provided as an input parameter to the method call - that changed the endpoint volume level or muting state. For more information, see - . - - - - - A value indicating whether the audio stream is currently muted. true if the audio stream is currently muted; - otherwise, false. - - - - - Specifies the current master volume level of the audio stream. The volume level is - normalized to the range from 0.0 to 1.0, where 0.0 is the minimum volume level and 1.0 - is the maximum level. Within this range, the relationship of the normalized volume level - to the attenuation of signal amplitude is described by a nonlinear, audio-tapered curve. - - - - - The number of channels. - - - - - The first element of an array which specifies the volume level of each channel. Use the - method to get all channel volumes. - - - - - Gets all channel volumes. - - - The volume level for each channel is normalized to the range from 0.0 to 1.0, where 0.0 - is the minimum volume level and 1.0 is the maximum level. Within this range, the - relationship of the normalized volume level to the attenuation of signal amplitude is - described by a nonlinear, audio-tapered curve. - - - - - The are hardware support flags for an audio endpoint device. - - For more information, see . - - - - None - - - - - The audio endpoint device supports a hardware volume control. - - - - - The audio endpoint device supports a hardware mute control. - - - - - The audio endpoint device supports a hardware peak meter. - - - - - The interface provides notifications of changes in the volume level and muting state of an audio endpoint device. - - - - - Notifies the client that the volume level or muting state of the audio endpoint device has changed. - - Pointer to the volume-notification data. - HRESULT; If the method succeeds, it returns . If it fails, it returns an error code. - - - - Enables a client to create and initialize an audio stream between an audio application and the audio engine (for a - shared-mode stream) or the hardware buffer of an audio endpoint device (for an exclusive-mode stream). For more - information, see - . - - - - - IID of the IAudioClient-interface. - - - - - Initializes a new instance of the class. - - Native pointer. - Use the method to create a new instance. - - - - Gets the default interval between periodic processing passes by the audio engine. The time is expressed in - 100-nanosecond units. - - - - - Gets the minimum interval between periodic processing passes by the audio endpoint device. The time is expressed in - 100-nanosecond units. - - - - - Gets the maximum capacity of the endpoint buffer. - - - - - Gets the number of frames of padding in the endpoint buffer. - - - - - Gets the stream format that the audio engine uses for its - internal processing of shared-mode streams. - - - - - Gets the maximum latency for the current stream and can - be called any time after the stream has been initialized. - - - - - Returns a new instance of the class. - - Device which should be used to create the instance. - instance. - - - - Initializes the audio stream. - - - The sharing mode for the connection. Through this parameter, the client tells the audio engine - whether it wants to share the audio endpoint device with other clients. - - Flags to control creation of the stream. - - The buffer capacity as a time value (expressed in 100-nanosecond units). This parameter - contains the buffer size that the caller requests for the buffer that the audio application will share with the - audio engine (in shared mode) or with the endpoint device (in exclusive mode). If the call succeeds, the method - allocates a buffer that is a least this large. - - - The device period. This parameter can be nonzero only in exclusive mode. In shared mode, - always set this parameter to 0. In exclusive mode, this parameter specifies the requested scheduling period for - successive buffer accesses by the audio endpoint device. If the requested device period lies outside the range that - is set by the device's minimum period and the system's maximum period, then the method clamps the period to that - range. If this parameter is 0, the method sets the device period to its default value. To obtain the default device - period, call the method. If the - stream flag is set and - is set as the , then - must be nonzero and equal to . - - - The format descriptor. For more information, see - . - - - A value that identifies the audio session that the stream belongs to. If the - identifies a session that has been previously opened, the method adds the stream to that - session. If the GUID does not identify an existing session, the method opens a new session and adds the stream to - that session. The stream remains a member of the same session for its lifetime. Use to - use the default session. - - HRESULT - - For more information, see - . - - - - - Initializes the audio stream. - - - The sharing mode for the connection. Through this parameter, the client tells the audio engine - whether it wants to share the audio endpoint device with other clients. - - Flags to control creation of the stream. - - The buffer capacity as a time value (expressed in 100-nanosecond units). This parameter - contains the buffer size that the caller requests for the buffer that the audio application will share with the - audio engine (in shared mode) or with the endpoint device (in exclusive mode). If the call succeeds, the method - allocates a buffer that is a least this large. - - - The device period. This parameter can be nonzero only in exclusive mode. In shared mode, - always set this parameter to 0. In exclusive mode, this parameter specifies the requested scheduling period for - successive buffer accesses by the audio endpoint device. If the requested device period lies outside the range that - is set by the device's minimum period and the system's maximum period, then the method clamps the period to that - range. If this parameter is 0, the method sets the device period to its default value. To obtain the default device - period, call the method. If the - stream flag is set and - is set as the , then - must be nonzero and equal to . - - - Pointer to the format descriptor. For more information, see - . - - - A value that identifies the audio session that the stream belongs to. If the - identifies a session that has been previously opened, the method adds the stream to that - session. If the GUID does not identify an existing session, the method opens a new session and adds the stream to - that session. The stream remains a member of the same session for its lifetime. Use to - use the default session. - - HRESULT - - For more information, see - . - - - - - Initializes the audio stream. - - - The sharing mode for the connection. Through this parameter, the client tells the audio engine - whether it wants to share the audio endpoint device with other clients. - - Flags to control creation of the stream. - - The buffer capacity as a time value (expressed in 100-nanosecond units). This parameter - contains the buffer size that the caller requests for the buffer that the audio application will share with the - audio engine (in shared mode) or with the endpoint device (in exclusive mode). If the call succeeds, the method - allocates a buffer that is a least this large. - - - The device period. This parameter can be nonzero only in exclusive mode. In shared mode, - always set this parameter to 0. In exclusive mode, this parameter specifies the requested scheduling period for - successive buffer accesses by the audio endpoint device. If the requested device period lies outside the range that - is set by the device's minimum period and the system's maximum period, then the method clamps the period to that - range. If this parameter is 0, the method sets the device period to its default value. To obtain the default device - period, call the method. If the - stream flag is set and - is set as the , then - must be nonzero and equal to . - - - The format descriptor. For more information, see - . - - - A value that identifies the audio session that the stream belongs to. If the - identifies a session that has been previously opened, the method adds the stream to that - session. If the GUID does not identify an existing session, the method opens a new session and adds the stream to - that session. The stream remains a member of the same session for its lifetime. Use to - use the default session. - - - For more information, see - . - - - - - Retrieves the size (maximum capacity) of the endpoint buffer. - - Retrieves the number of audio frames that the buffer can hold. - - The size of one frame = (number of bits per sample)/8 * (number of channels) - - HRESULT - - - - Returns the size (maximum capacity) of the endpoint buffer. - - The number of audio frames that the buffer can hold. - - The size of one frame = (number of bits per sample)/8 * (number of channels) - - HRESULT - - - - Retrieves the maximum latency for the current stream and can - be called any time after the stream has been initialized. - - Retrieves a value representing the latency. The time is expressed in 100-nanosecond units. - - Rendering clients can use this latency value to compute the minimum amount of data that - they can write during any single processing pass. To write less than this minimum is to - risk introducing glitches into the audio stream. For more information, see - . - - HRESULT - - - - Retrieves the maximum latency for the current stream and can - be called any time after the stream has been initialized. - - - Rendering clients can use this latency value to compute the minimum amount of data that - they can write during any single processing pass. To write less than this minimum is to - risk introducing glitches into the audio stream. For more information, see - . - - A value representing the latency. The time is expressed in 100-nanosecond units. - - - - Retrieves the number of frames of padding in the endpoint buffer. - - Retrieves the frame count (the number of audio frames of padding in the buffer). - HRESULT - - The size of one frame = (number of bits per sample)/8 * (number of channels) - - - - - Retrieves the number of frames of padding in the endpoint - buffer. - - The frame count (the number of audio frames of padding in the buffer). - - The size of one frame = (number of bits per sample)/8 * (number of channels) - - - - - Indicates whether the audio endpoint device - supports a particular stream format. - - - The sharing mode for the stream format. Through this parameter, the client indicates whether it - wants to use the specified format in exclusive mode or shared mode. - - The stream format to test whether it is supported by the or not. - - Retrieves the supported format that is closest to the format that the client specified - through the parameter. If is - , the will be always null. - - - HRESULT code. If the method returns 0 (= ), the endpoint device supports the specified - . If the method returns - 1 (= ), the method succeeded with a to the specified - . If the method returns - 0x88890008 (= ), the method succeeded but the specified format - is not supported in exclusive mode. If the method returns anything else, the method failed. - - - For more information, see - . - - - - - Indicates whether the audio endpoint device - supports a particular stream format. - - - The sharing mode for the stream format. Through this parameter, the client indicates whether it - wants to use the specified format in exclusive mode or shared mode. - - The stream format to test whether it is supported by the or not. - - Retrieves the supported format that is closest to the format that the client specified - through the parameter. If is - , the will be always null. - - - True if the is supported. False if the - is not supported. - - - For more information, see - . - - - - - Indicates whether the audio endpoint device - supports a particular stream format. - - - The sharing mode for the stream format. Through this parameter, the client indicates whether it - wants to use the specified format in exclusive mode or shared mode. - - The stream format to test whether it is supported by the or not. - - True if the is supported. False if the - is not supported. - - - For more information, see - . - - - - - Retrieves the stream format that the audio engine uses for its - internal processing of shared-mode streams. - - - Retrieves the mix format that the audio engine uses for its internal processing of - shared-mode streams. - - - For more information, see - . - - HRESULT - - - - Retrieves the stream format that the audio engine uses for its - internal processing of shared-mode streams. - - - For more information, see - . - - The mix format that the audio engine uses for its internal processing of shared-mode streams. - - - - Retrieves the length of the periodic interval separating - successive processing passes by the audio engine on the data in the endpoint buffer. - - - Retrieves a time value specifying the default interval between periodic processing - passes by the audio engine. The time is expressed in 100-nanosecond units. - - - Retrieves a time value specifying the minimum interval between periodic processing - passes by the audio endpoint device. The time is expressed in 100-nanosecond units. - - - Use the and the properties instead of - the method. - For more information, see - . - - HRESULT - - - - Starts the audio stream. - - HRESULT - - For more information, see - . - - - - - Starts the audio stream. - - - For more information, see - . - - - - - Stops the audio stream. - - HRESULT - - For more information, see - . - - - - - Stops the audio stream. - - - For more information, see - . - - - - - Resets the audio stream. - - HRESULT - - For more information, see - . - - - - - Resets the audio stream. - - - For more information, see - . - - - - - Sets the event handle that the system signals when an audio - buffer is ready to be processed by the client. - - The event handle. - - HRESULT - - - For more information, see - . - - - - - Sets the event handle that the system signals when an audio - buffer is ready to be processed by the client. - - The event handle. - - For more information, see - . - - - - - Sets the event handle that the system signals when an audio - buffer is ready to be processed by the client. - - The event handle. - - For more information, see - . - - - - - Accesses additional services from the audio client object. - - - The interface ID for the requested service. For a list of all available values, see - . - - - A pointer variable into which the method writes the address of an instance of the - requested interface. Through this method, the caller obtains a counted reference to the interface. The caller is - responsible for releasing the interface, when it is no longer needed, by calling the interface's Release method. If - the GetService call fails, *ppv is . - - HRESULT - - For more information, see - . - - - - - Accesses additional services from the audio client object. - - - The interface ID for the requested service. For a list of all available values, see - . - - - A pointer into which the method writes the address of an instance of the requested interface. - Through this method, the caller obtains a counted reference to the interface. The caller is responsible for - releasing the interface, when it is no longer needed, by calling the interface's Release method. - - - For more information, see - . - - - - - AudioClient share mode - - - - - The device will be opened in shared mode and use the WAS format. - - - - - The device will be opened in exclusive mode and use the application specified format. - - - - - Represents a collection of multimedia device resources. - - - - - Initializes a new instance of the class. - - The native pointer. - Use the method to create an instance of the class. - - - - Gets the number of devices in the device collection. - - - - - Gets the element at the specified index. - - - - - - The method retrieves a count of the devices in the device collection. - - The number of devices in the device collection. - - - - The method retrieves a count of the devices in the device collection. - - Variable into which the method writes the number of devices in the device collection. - HRESULT - - - - The method retrieves a pointer to the specified item in the device collection. - - The device number. If the collection contains n devices, the devices are numbered 0 to n– 1. - The object of the specified item in the device collection. - - - - The method retrieves a pointer to the specified item in the device collection. - - The device number. If the collection contains n devices, the devices are numbered 0 to n– 1. - A pointer variable into which the method writes the address of the object of the specified item in the device collection. - HRESULT - - - - Returns an enumerator that iterates through the . - - Enumerator for the . - - - - Returns an enumerator that iterates through the . - - Enumerator for the . - - - - The object provides notifications when an audio endpoint device is added or removed, when the state or properties of an endpoint device change, or when there is a change in the default role assigned to an endpoint device. - - - - - Occurs when the state of an audio endpoint device has changed. - - - - - Occurs when a new audio endpoint device has been added. - - - - - Occurs when an audio endpoint device has been removed. - - - - - Occurs when the default audio endpoint device for a particular device role has changed. - - - - - Occurs when the value of a property belonging to an audio endpoint device has changed. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class based on an existing . - - - - - - The OnDeviceStateChanged method indicates that the state of an audio endpoint device has - changed. - - The device id that identifies the audio endpoint device. - Specifies the new state of the endpoint device. - HRESULT - - - - The OnDeviceAdded method indicates that a new audio endpoint device has been added. - - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnDeviceRemoved method indicates that an audio endpoint device has been removed. - - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnDefaultDeviceChanged method notifies the client that the default audio endpoint - device for a particular device role has changed. - - The data-flow direction of the endpoint device. - The device role of the audio endpoint device. - The device id that identifies the audio endpoint device. - HRESULT - - - - The OnPropertyValueChanged method indicates that the value of a property belonging to an - audio endpoint device has changed. - - The device id that identifies the audio endpoint device. - The that specifies the changed property. - HRESULT - - - - Disposes und unregisters the . - - In order to unregister the , this method calls the method. - - - - Finalizes an instance of the class. - - - - - The object enables a client to control the master volume level of an audio session. - For more information, see . - - - - - Creates a new instance by calling the method of the - specified . - - - The which should be used to create the -instance - with. - - A new instance of the class. - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Gets or sets the master volume level for the audio session. Valid volume levels are in the range 0.0 (=0%) to 1.0 (=100%). - - - - - Gets or sets the muting state for the audio session. True indicates that muting is enabled. False indicates that it is disabled. - - - - - Sets the master volume level for the audio session. - - - The new master volume level. Valid volume levels are in the range 0.0 to 1.0. - EventContext which can be accessed in the event handler. - HRESULT - - - - Retrieves the client volume level for the audio session. - - - A variable into which the method writes the client volume level. The volume level is a value in the range 0.0 to 1.0. - HRESULT - - - - Sets the muting state for the audio session. - - - The new muting state. TRUE enables muting. FALSE disables muting. - EventContext which can be accessed in the event handler. - HRESULT - - - - The GetMute method retrieves the current muting state for the audio session. - - - A variable into which the method writes the muting state. TRUE indicates that muting is enabled. FALSE indicates that it is disabled. - HRESULT - - - - Encapsulates the generic features of a multimedia device resource. - - - - - Initializes a new instance of the class. - - Native pointer. - Use the class to create a new instance. - - - - Gets the propertystore associated with the . - - Warning: This PropertyStore is only readable. Use the OpenPropertyStore-Method to get - writeable PropertyStore. - - - - Gets the device id. For information, see . - - - - - Gets the friendly name of the device. - - This value is stored in the . - - - - Gets the AudioEndpointPath of the device. - - - This value is stored in the . - Use this value as the deviceid for XAudio2.8 device selection. - - - - - Gets the device state of the device. - - - - - Gets the data flow of the device. - - - The data flow of the device. - - - - - Gets the device format. - - Specifies the device format, which is the format that the user has selected for the stream that flows between the audio engine and the audio endpoint device when the device operates in shared mode. - - - - Creates a COM object with the specified interface. - - The interface identifier. This parameter is a reference to a GUID that identifies the interface that the caller requests be activated. The caller will use this interface to communicate with the COM object. - The execution context in which the code that manages the newly created object will run. - Use as the default value. See http://msdn.microsoft.com/en-us/library/windows/desktop/dd371405%28v=vs.85%29.aspx for more details. - A pointer variable into which the method writes the address of the interface specified by parameter . - HRESULT - - - - Creates a COM object with the specified interface. - - The interface identifier. This parameter is a reference to a GUID that identifies the interface that the caller requests be activated. The caller will use this interface to communicate with the COM object. - The execution context in which the code that manages the newly created object will run. - Use as the default value. See http://msdn.microsoft.com/en-us/library/windows/desktop/dd371405%28v=vs.85%29.aspx for more details. - A pointer variable into which the method writes the address of the interface specified by parameter . - - - - Retrieves an interface to the device's property store. - - The storage-access mode. This parameter specifies whether to open the property store in read mode, write mode, or read/write mode. - for the . - - - - Retrieves an interface to the device's property store. - - The storage-access mode. This parameter specifies whether to open the property store in read mode, write mode, or read/write mode. - A pointer variable into which the method writes the address of the IPropertyStore interface of the device's property store. - HRESULT - - - - Retrieves an endpoint ID string that identifies the audio endpoint device. - - The variable which will receive the id of the device. - HRESULT - - - - Retrieves the current device state. - - The variable which will receive the of the device. - HRESULT - - - - Disposes the and its default property store (see property). - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Returns the of the . - - The . - - - - CoreAudioAPI COM Exception - - - - - Throws an if the represents an error. - - The error code. - Name of the interface which contains the COM-function which returned the specified . - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class. - - Errorcode. - Name of the interface which contains the COM-function which returned the specified . - Name of the COM-function which returned the specified . - - - - Defines constants that indicate the direction in which audio data flows between an audio endpoint device and an application. - - - - - Audio rendering stream. Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, to the application. - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio endpoint device, or from the audio endpoint device to the application. - - - - - Indicates the current state of an audio endpoint device. - - - - - The audio endpoint device is active. That is, the audio adapter that connects to the endpoint device is present and enabled. In addition, if the endpoint device plugs into a jack on the adapter, then the endpoint device is plugged in. - - - - - The audio endpoint device is disabled. The user has disabled the device in the Windows multimedia control panel, Mmsys.cpl. For more information, see Remarks. - - - - - he audio endpoint device is not present because the audio adapter that connects to the endpoint device has been removed from the system, or the user has disabled the adapter device in Device Manager. - - - - - The audio endpoint device is unplugged. The audio adapter that contains the jack for the endpoint device is present and enabled, but the endpoint device is not plugged into the jack. Only a device with jack-presence detection can be in this state. - - - - - Includes audio endpoint devices in all states—active, disabled, not present, and unplugged. - - - - - Encapsulates the generic features of a multimedia device resource. - - - - - Creates a COM object with the specified interface. - - The interface identifier. This parameter is a reference to a GUID that identifies the interface that the caller requests be activated. The caller will use this interface to communicate with the COM object. - The execution context in which the code that manages the newly created object will run. - Use as the default value. See http://msdn.microsoft.com/en-us/library/windows/desktop/dd371405%28v=vs.85%29.aspx for more details. - Pointer to a pointer variable into which the method writes the address of the interface specified by parameter . - HRESULT - - - - Retrieves an interface to the device's property store. - - The storage-access mode. This parameter specifies whether to open the property store in read mode, write mode, or read/write mode. - Pointer to a pointer variable into which the method writes the address of the IPropertyStore interface of the device's property store. - HRESULT - - - - Retrieves an endpoint ID string that identifies the audio endpoint device. - - The variable which will receive the id of the device. - HRESULT - - - - Retrieves the current device state. - - The variable which will receive the of the device. - HRESULT - - - - Represents a collection of multimedia device resources. - - - - - The method retrieves a count of the devices in the device collection. - - Variable into which the method writes the number of devices in the device collection. - HRESULT - - - - The method retrieves a pointer to the specified item in the device collection. - - The device number. If the collection contains n devices, the devices are numbered 0 to n– 1. - The object of the specified item in the device collection. - HRESULT - - - - Provides methods for enumerating multimedia device resources. - - - - - Generates a collection of audio endpoint devices that meet the specified criteria. - - The data-flow direction for the endpoint device. - The state or states of the endpoints that are to be included in the collection. - Pointer to a pointer variable into which the method writes the address of the COM object of the device-collection object. - HRESULT - - - - The method retrieves the default audio endpoint for the specified data-flow direction and role. - - The data-flow direction for the endpoint device. - The role of the endpoint device. - Pointer to a pointer variable into which the method writes the address of the COM object of the endpoint object for the default audio endpoint device. - HRESULT - - - - Retrieves an audio endpoint device that is identified by an endpoint ID string. - - Endpoint ID. The caller typically obtains this string from the property or any method of the . - Pointer to a pointer variable into which the method writes the address of the IMMDevice interface for the specified device. Through this method, the caller obtains a counted reference to the interface. - HREUSLT - - - - Registers a client's notification callback interface. - - Implementation of the which is should receive the notificaitons. - HRESULT - - - - Deletes the registration of a notification interface that the client registered in a previous call to the method. - - Implementation of the which should be unregistered from any notifications. - HRESULT - - - - Defines constants that indicate the role that the system has assigned to an audio endpoint device. - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording. - - - - - Voice communications (talking to another person). - - - - - Specifies how to open a property store. - - - - - Readable only. - - - - - Writeable but not readable. - - - - - Read- and writeable. - - - - - Provides methods for enumerating multimedia device resources. - - - - - Returns the default audio endpoint for the specified data-flow direction and role. - - The data-flow direction for the endpoint device. - The role of the endpoint device. - instance of the endpoint object for the default audio endpoint device. - - - - Returns the default audio endpoint for the specified data-flow direction and role. If no device is available the method returns null. - - The data-flow direction for the endpoint device. - The role of the endpoint device. - instance of the endpoint object for the default audio endpoint device. If no device is available the method returns null. - - - - Generates a collection of all active audio endpoint devices that meet the specified criteria. - - The data-flow direction for the endpoint device. - which contains the enumerated devices. - - - - Generates a collection of audio endpoint devices that meet the specified criteria. - - The data-flow direction for the endpoint device. - The state or states of the endpoints that are to be included in the collection. - which contains the enumerated devices. - - - - Occurs when the state of an audio endpoint device has changed. - - - - - Occurs when a new audio endpoint device has been added. - - - - - Occurs when an audio endpoint device has been removed. - - - - - Occurs when the default audio endpoint device for a particular device role has changed. - - - - - Occurs when the value of a property belonging to an audio endpoint device has changed. - - - - - Initializes a new instance of the class. - - - - - Gets the with the specified device id. - - - The . - - The device identifier. - - - - - Returns the default audio endpoint for the specified data-flow direction and role. - - The data-flow direction for the endpoint device. - The role of the endpoint device. - instance of the endpoint object for the default audio endpoint device. - - - - The method retrieves the default audio endpoint for the specified data-flow direction and role. - - The data-flow direction for the endpoint device. - The role of the endpoint device. - A pointer variable into which the method writes the address of the COM object of the endpoint object for the default audio endpoint device. - HRESULT - - - - Generates a collection of audio endpoint devices that meet the specified criteria. - - The data-flow direction for the endpoint device. - The state or states of the endpoints that are to be included in the collection. - which contains the enumerated devices. - - - - Generates a collection of audio endpoint devices that meet the specified criteria. - - The data-flow direction for the endpoint device. - The state or states of the endpoints that are to be included in the collection. - A pointer variable into which the method writes the address of the COM object of the device-collection object. - HRESULT - - - - Retrieves an audio endpoint device that is identified by an endpoint ID string. - - Endpoint ID. The caller typically obtains this string from the property or any method of the . - instance for specified device. - - - - Retrieves an audio endpoint device that is identified by an endpoint ID string. - - Endpoint ID. The caller typically obtains this string from the property or any method of the . - A pointer variable into which the method writes the address of the IMMDevice interface for the specified device. Through this method, the caller obtains a counted reference to the interface. - HREUSLT - - - - Registers a client's notification callback interface. - - Implementation of the which is should receive the notificaitons. - - - - Registers a client's notification callback interface. - - Implementation of the which is should receive the notificaitons. - HRESULT - - - - Deletes the registration of a notification interface that the client registered in a previous call to the method. - - Implementation of the which should be unregistered from any notifications. - - - - Deletes the registration of a notification interface that the client registered in a previous call to the method. - - Implementation of the which should be unregistered from any notifications. - HRESULT - - - - Is used to create buffer objects, manage devices, and set up the environment. This object supersedes and adds new methods. - Obtain a instance by calling the method. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Ascertains whether the device driver is certified for DirectX. - - Receives a value which indicates whether the device driver is certified for DirectX. - DSResult - - - - Ascertains whether the device driver is certified for DirectX. - - A value which indicates whether the device driver is certified for DirectX. On emulated devices, the method returns . - - - - Used to create buffer objects, manage devices, and set up the environment. - - - - - Returns a new instance of the class. - - The device to use for the initialization. - The new instance of the class. - - - - Returns a new instance of the class. - - The device to use for the initialization. - The new instance of the class. - - - - Gets the capabilities. - - - - - Initializes a new instance of the class. - - The native pointer of the DirectSound COM object. - - - - Checks whether the specified is supported. - - The wave format. - A value indicating whether the specified is supported. If true, the is supported; Otherwise false. - - - - Sets the cooperative level of the application for this sound device. - - Handle to the application window. - The requested level. - - - - Sets the cooperative level of the application for this sound device. - - Handle to the application window. - The requested level. - DSResult - - - - Creates a sound buffer object to manage audio samples. - - A structure that describes the sound buffer to create. - Must be . - A variable that receives the IDirectSoundBuffer interface of the new buffer object. - For more information, see . - - - - Creates a sound buffer object to manage audio samples. - - A structure that describes the sound buffer to create. - Must be . - A variable that receives the IDirectSoundBuffer interface of the new buffer object. - DSResult - For more information, see . - - - - Retrieves the capabilities of the hardware device that is represented by the device object. - - - Receives the capabilities of this sound device. - DSResult - Use the property instead. - - - - Creates a new secondary buffer that shares the original buffer's memory. - - Type of the buffer to duplicate. - The buffer to duplicate. - The duplicated buffer. - For more information, see . - - - - Creates a new secondary buffer that shares the original buffer's memory. - - Address of the IDirectSoundBuffer or IDirectSoundBuffer8 interface of the buffer to duplicate. - Address of a variable that receives the IDirectSoundBuffer interface pointer for the new buffer. - DSResult - For more information, see . - - - - Has no effect. See remarks. - - This method was formerly used for compacting the on-board memory of ISA sound cards. - DSResult - - - - Has no effect. See remarks. - - This method was formerly used for compacting the on-board memory of ISA sound cards. - - - - Retrieves the speaker configuration. - - Retrieves the speaker configuration. - DSResult - - - - Retrieves the speaker configuration. - - The speaker configuration. - - - - Specifies the speaker configuration of the device. - - The speaker configuration. - DSResult - - In Windows Vista and later versions of Windows, is a NOP. For Windows Vista and later versions, the speaker configuration is a system setting that should not be modified by an application. End users can set the speaker configuration through control panels. - For more information, see . - - - - - Specifies the speaker configuration of the device. - - The speaker configuration. - - In Windows Vista and later versions of Windows, is a NOP. For Windows Vista and later versions, the speaker configuration is a system setting that should not be modified by an application. End users can set the speaker configuration through control panels. - For more information, see . - - - - - Initializes a device object that was created by using the CoCreateInstance function. - - The globally unique identifier (GUID) specifying the sound driver to which this device object binds. Pass null to select the primary sound driver. - DSResult - - - - Initializes a device object that was created by using the CoCreateInstance function. - - The globally unique identifier (GUID) specifying the sound driver to which this device object binds. Pass null to select the primary sound driver. - - - - Combines a value with a value. - - Must be . - The value to combine with the . - Combination out of the and the value. - Must be stereo.; speakerConfiguration - - - - Used to manage sound buffers. - - - - - Left only. - - - - - 50% left, 50% right. - - - - - Right only. - - - - - The default frequency. For more information, see . - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Gets the capabilities of the buffer object. - - - - - Gets the status of the sound buffer. - - - - - Retrieves the capabilities of the buffer object. - - Receives the capabilities of this sound buffer. - DSResult - - - - Retrieves the capabilities of the buffer object. - - The capabilities of this sound buffer. - - - - Causes the sound buffer to play, starting at the play cursor. - - Flags specifying how to play the buffer. - - - - Causes the sound buffer to play, starting at the play cursor. - - Flags specifying how to play the buffer. - Priority for the sound, used by the voice manager when assigning hardware mixing resources. The lowest priority is 0, and the highest priority is 0xFFFFFFFF. If the buffer was not created with the flag, this value must be 0. - - - - Causes the sound buffer to play, starting at the play cursor. - - Flags specifying how to play the buffer. - Priority for the sound, used by the voice manager when assigning hardware mixing resources. The lowest priority is 0, and the highest priority is 0xFFFFFFFF. If the buffer was not created with the flag, this value must be 0. - DSResult - - - - Causes the sound buffer to stop playing. - - For more information, see . - - - - Causes the sound buffer to stop playing. - - DSResult - For more information, see . - - - - Restores the memory allocation for a lost sound buffer. - - For more information, see . - - - - Restores the memory allocation for a lost sound buffer. - - DSResult - For more information, see . - - - - Readies all or part of the buffer for a data write and returns pointers to which data can be written. - - Offset, in bytes, from the start of the buffer to the point where the lock begins. This parameter is ignored if is specified in the parameter. - Size, in bytes, of the portion of the buffer to lock. The buffer is conceptually circular, so this number can exceed the number of bytes between and the end of the buffer. - Receives a pointer to the first locked part of the buffer. - Receives the number of bytes in the block at . If this value is less than , the lock has wrapped and points to a second block of data at the beginning of the buffer. - Receives a pointer to the second locked part of the capture buffer. If is returned, the parameter points to the entire locked portion of the capture buffer. - Receives the number of bytes in the block at . If is , this value is zero. - Flags modifying the lock event. - DSResult - - - - Readies all or part of the buffer for a data write and returns pointers to which data can be written. - - Offset, in bytes, from the start of the buffer to the point where the lock begins. This parameter is ignored if is specified in the parameter. - Size, in bytes, of the portion of the buffer to lock. The buffer is conceptually circular, so this number can exceed the number of bytes between and the end of the buffer. - Receives a pointer to the first locked part of the buffer. - Receives the number of bytes in the block at . If this value is less than , the lock has wrapped and points to a second block of data at the beginning of the buffer. - Receives a pointer to the second locked part of the capture buffer. If is returned, the parameter points to the entire locked portion of the capture buffer. - Receives the number of bytes in the block at . If is , this value is zero. - Flags modifying the lock event. - - - - Releases a locked sound buffer. - - Address of the value retrieved in the audioPtr1 parameter of the method. - Number of bytes written to the portion of the buffer at audioPtr1. - Address of the value retrieved in the audioPtr2 parameter of the method. - Number of bytes written to the portion of the buffer at audioPtr2. - DSResult - - - - Releases a locked sound buffer. - - Address of the value retrieved in the audioPtr1 parameter of the method. - Number of bytes written to the portion of the buffer at audioPtr1. - Address of the value retrieved in the audioPtr2 parameter of the method. - Number of bytes written to the portion of the buffer at audioPtr2. - - - - Retrieves the position of the play and write cursors in the sound buffer. - - Receives the offset, in bytes, of the play cursor. - Receives the offset, in bytes, of the write cursor. - DSResult - - - - Retrieves the position of the play and write cursors in the sound buffer. - - Receives the offset, in bytes, of the play cursor. - Receives the offset, in bytes, of the write cursor. - - - - Sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer. - - Offset of the play cursor, in bytes, from the beginning of the buffer. - - - - Sets the position of the play cursor, which is the point at which the next byte of data is read from the buffer. - - Offset of the play cursor, in bytes, from the beginning of the buffer. - DSResult - - - - Initializes a sound buffer object if it has not yet been initialized. - - The device object associated with this buffer. - A structure that contains the values used to initialize this sound buffer. - DSResult - - - - Initializes a sound buffer object if it has not yet been initialized. - - The device object associated with this buffer. - A structure that contains the values used to initialize this sound buffer. - - - - Retrieves the status of the sound buffer. - - - Receives the status of the sound buffer. - DSResult - Use the property instead. - - - - Sets the frequency at which the audio samples are played. - - Frequency, in hertz (Hz), at which to play the audio samples. A value of resets the frequency to the default value of the buffer format. - DSResult - Before setting the frequency, you should ascertain whether the frequency is supported by checking the and members of the structure for the device. Some operating systems do not support frequencies greater than 100,000 Hz. - - - - Sets the frequency at which the audio samples are played. - - Frequency, in hertz (Hz), at which to play the audio samples. A value of resets the frequency to the default value of the buffer format. - Before setting the frequency, you should ascertain whether the frequency is supported by checking the and members of the structure for the device. Some operating systems do not support frequencies greater than 100,000 Hz. - - - - Retrieves the frequency, in samples per second, at which the buffer is playing. - - A variable that receives the frequency at which the audio buffer is being played, in hertz. - DSResult - - - - Gets the frequency, in samples per second, at which the buffer is playing. - - The frequency at which the audio buffer is being played, in hertz. - - - - Sets the relative volume of the left and right channels. - - Relative volume between the left and right channels. Must be between and . - DSResult - For more information, see . - - - - Sets the relative volume of the left and right channels. - - Relative volume between the left and right channels. Must be between and . - For more information, see . - - - - Sets the relative volume of the left and right channels as a scalar value. - - Relative volume between the left and right channels. Must be between -1.0 and 1.0. - A value of -1.0 will set the volume of the left channel to 100% and the volume of the right channel to 0%. - A value of 1.0 will set the volume of the left channel to 0% and the volume of the right channel to 100%. - - - - Retrieves the relative volume of the left and right audio channels. - - A variable that receives the relative volume, in hundredths of a decibel. - DSResult - - - - Retrieves the relative volume of the left and right audio channels. - - The relative volume, in hundredths of a decibel. - - - - Gets the relative volume of the left and right channels as a scalar value. - - The relative volume between the left and right channels. A value of -1.0 indicates that the volume of the left channel is set to 100% and the volume of the right channel to 0%. - A value of 1.0 indicates that the volume of the left channel is set to 0% and the volume of the right channel is set to 100%. - - - - Sets the attenuation of the sound. - - Attenuation, in hundredths of a decibel (dB). - DSResult - - - - Sets the attenuation of the sound. - - Attenuation, in hundredths of a decibel (dB). - - - - Sets the attenuation of the sound. - - The attenuation of the sound. The attenuation is expressed as a normalized value in the range from 0.0 to 1.0. - - - - Retrieves the attenuation of the sound. - - A variable that receives the attenuation, in hundredths of a decibel. - DSResult - - - - Returns the attenuation of the sound. - - The attenuation, in hundredths of a decibel. - - - - Returns the attenuation of the sound. - - The attenuation of the sound. The attenuation is expressed as a normalized value in the range from 0.0 to 1.0. - - - - Retrieves a description of the format of the sound data in the buffer, or the buffer size needed to retrieve the format description. - - Address of a or instance that receives a description of the sound data in the buffer. To retrieve the buffer size needed to contain the format description, specify . In this case the variable at receives the size of the structure needed to receive the data. - Size, in bytes, of the structure at . If is not , this value must be equal to or greater than the size of the expected data. - A variable that receives the number of bytes written to the structure at . - DSResult - - - - Returns a description of the format of the sound data in the buffer. - - A description of the format of the sound data in the buffer. The returned description is either of the type or of the type . - - - - Sets the format of the primary buffer. Whenever this application has the input focus, DirectSound will set the primary buffer to the specified format. - - A waveformat that describes the new format for the primary sound buffer. - DSResult - - - - Sets the format of the primary buffer. Whenever this application has the input focus, DirectSound will set the primary buffer to the specified format. - - A waveformat that describes the new format for the primary sound buffer. - - - - Enables effects on a buffer. For this method to succeed, CoInitialize must have been called. Additionally, the buffer must not be playing or locked. - - Number of elements in the effectDescriptions and resultCodes arrays. If this value is 0, effectDescriptions and resultCodes must both be . Set to 0 to remove all effects from the buffer. - Address of an array of DSEFFECTDESC structures, of size effectsCount, that specifies the effects wanted on the buffer. Must be if effectsCount is 0. - Address of an array of DWORD elements, of size effectsCount. - DSResult - - - - Allocates resources for a buffer that was created with the DSBCAPS_LOCDEFER flag in the DSBUFFERDESC structure. - - Flags specifying how resources are to be allocated for a buffer created with the DSBCAPS_LOCDEFER flag. - Number of elements in the resultCodes array, or 0 if resultCodes is . - Address of an array of DWORD variables that receives information about the effects associated with the buffer. This array must contain one element for each effect that was assigned to the buffer by . - DSResult - - - - Retrieves an interface for an effect object associated with the buffer. - - Unique class identifier of the object being searched for, such as GUID_DSFX_STANDARD_ECHO. Set this parameter to GUID_All_Objects to search for objects of any class. - Index of the object within objects of that class in the path. - Unique identifier of the desired interface. - Address of a variable that receives the desired interface pointer. - DSResult - For more information, see . - - - - Gets a value indicating whether the buffer is lost. True means that the buffer is lost; Otherwise False. - - - - - Writes data to the buffer by locking the buffer, copying data to the buffer and finally unlocking it. - - The data to write to the buffer. - The zero-based offset in the at which to start copying data. - The number of bytes to write. - Returns true if writing data was successful; Otherwise false. - - - - Writes data to the buffer by locking the buffer, copying data to the buffer and finally unlocking it. - - The data to write to the buffer. - The zero-based offset in the at which to start copying data. - The number of shorts to write. - Returns true if writing data was successful; Otherwise false. - - - - Describes the capabilities of a device. - - - - - Size of the structure, in bytes. This member must be initialized before the structure is used. - - - - - Flags describing device capabilities. - - - - - Minimum sample rate specification that is supported by this device's hardware secondary sound buffers. - - - - - Maximum sample rate specification that is supported by this device's hardware secondary sound buffers. - - - - - Number of primary buffers supported. This value will always be 1. - - - - - Number of buffers that can be mixed in hardware. This member can be less than the sum of and . Resource tradeoffs frequently occur. - - - - - Maximum number of static buffers. - - - - - Maximum number of streaming sound buffers. - - - - - Number of unallocated buffers. On WDM drivers, this includes . - - - - - Number of unallocated static buffers. - - - - - Number of unallocated streaming buffers. - - - - - Maximum number of 3D buffers. - - - - - Maximum number of static 3D buffers. - - - - - Maximum number of streaming 3D buffers. - - - - - Number of unallocated 3D buffers. - - - - - Number of unallocated static 3D buffers. - - - - - Number of unallocated streaming 3D buffers. - - - - - Size, in bytes, of the amount of memory on the sound card that stores static sound buffers. - - - - - Size, in bytes, of the free memory on the sound card. - - - - - Size, in bytes, of the largest contiguous block of free memory on the sound card. - - - - - The rate, in kilobytes per second, at which data can be transferred to hardware static sound buffers. This and the number of bytes transferred determines the duration of a call to the method. - - - - - The processing overhead, as a percentage of main processor cycles, needed to mix software buffers. This varies according to the bus type, the processor type, and the clock speed. - - - - - Represents a directsound-device. - - - - - The guid of the default playback device. - - - - - Gets the default playback device. - - - - - Enumerates all directsound-devices. Use the method instead. - - A list, containing all enumerated directsound-devices. - - - - Gets the textual description of the DirectSound device. - - - - - Gets the module name of the DirectSound driver corresponding to this device. - - - - - The that identifies the device being enumerated. - - - - - Initializes a new instance of the class. - - The description. - The module. - The unique identifier. - - - - Performs an explicit conversion from to . - - The device. - - The of the . - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the functionality to enumerate directsound devices installed on the system. - - - - - Enumerates the directsound devices installed on the system. - - A readonly collection, containing all enumerated devices. - - - - Exception class which represents all DirectSound related exceptions. - - - - - Initializes a new instance of the class. - - The Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class. - - The Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - - The StreamingContext object that supplies the contextual information about the source or - destination. - - - - - Gets the which got associated with the specified . - - - - - Throws an if the is not - . - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Sets up notification events for a playback or capture buffer. - - - - - Returns a new instance of the class for the specified . - - The to create a instance for. - A new instance of the class for the specified - is null. - - - - Initializes a new instance of the class based on the native pointer. - - The native pointer of the COM object. - - - - Sets the notification positions. During capture or playback, whenever the read or play cursor reaches one of the specified offsets, the associated event is signaled. - - An array of structures. - - - - Sets the notification positions. During capture or playback, whenever the read or play cursor reaches one of the specified offsets, the associated event is signaled. - - An array of structures. - DSResult - - - - Represents a primary directsound buffer. - - - - - Initializes a new instance of the class. - - A instance which provides the method. - - - - - Initializes a new instance of the class. - - A instance which provides the method. - The buffer description which describes the buffer to create. - - The is invalid. - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Represents a secondary directsound buffer. - - - - - Initializes a new instance of the class. - - A instance which provides the method. - The of the sound buffer. - The buffer size. Internally, the will be set to * 2. - or - must be a value between 4 and 0x0FFFFFFF. - - - - Initializes a new instance of the class. - - A instance which provides the method. - The buffer description which describes the buffer to create. - - - The is invalid. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Defines possible flags for the method. - - - - - The default value. - - - - - Start the lock at the write cursor. The offset parameter is ignored. - - - - - Lock the entire buffer. The bytes parameter is ignored. - - - - - Flags specifying how to play a . - - For more information, see . - - - - None - - - - - After the end of the audio buffer is reached, play restarts at the beginning of the buffer. Play continues until explicitly stopped. This flag must be set when playing a primary buffer. - - - - - Play this voice in a hardware buffer only. If the hardware has no available voices and no voice management flags are set, the call to fails. This flag cannot be combined with . - - - - - Play this voice in a software buffer only. This flag cannot be combined with or any voice management flag. - - - - - If the hardware has no available voices, a currently playing nonlooping buffer will be stopped to make room for the new buffer. The buffer prematurely terminated is the one with the least time left to play. - - - - - If the hardware has no available voices, a currently playing buffer will be stopped to make room for the new buffer. The buffer prematurely terminated will be selected from buffers that have the buffer's flag set and are beyond their maximum distance. If there are no such buffers, the method fails. - - - - - If the hardware has no available voices, a currently playing buffer will be stopped to make room for the new buffer. The buffer prematurely terminated will be the one with the lowest priority as set by the priority parameter passed to for the buffer. - - - - - The structure describes a notification position. It is used by . - - - - - Zero offset. - - - - - Causes the event to be signaled when playback or capture stops, either because the end of the buffer has been reached (and playback or capture is not looping) or because the application called the or IDirectSoundCaptureBuffer8::Stop method. - - - - - Offset from the beginning of the buffer where the notify event is to be triggered, or . - - - - - Handle to the event to be signaled when the offset has been reached. - - - - - Initializes a new instance of the struct. - - The offset from the beginning of the buffer where the notify event is to be triggered. - Handle to the event to be signaled when the offset has been reached - - - - Defines flags that describe the status of a . - - - - - The buffer is playing. If this value is not set, the buffer is stopped. - - - - - The buffer is lost and must be restored before it can be played or locked. - - - - - The buffer is being looped. If this value is not set, the buffer will stop when it reaches the end of the sound data. This value is returned only in combination with . - - - - - The buffer is playing in hardware. Set only for buffers created with the flag. - - - - - The buffer is playing in software. Set only for buffers created with the flag. - - - - - The buffer was prematurely terminated by the voice manager and is not playing. Set only for buffers created with the flag. - - - - - Describes the capabilities of a DirectSound buffer object. It is used by the property. - - For more information, see . - - - - Size of the structure, in bytes. This member must be initialized before the structure is used. - - Use the method to determine the size. - - - - Flags that specify buffer-object capabilities. - - - - - Size of this buffer, in bytes. - - - - - The rate, in kilobytes per second, at which data is transferred to the buffer memory when is called. High-performance applications can use this value to determine the time required for to execute. For software buffers located in system memory, the rate will be very high because no processing is required. For hardware buffers, the rate might be slower because the buffer might have to be downloaded to the sound card, which might have a limited transfer rate. - - - - - The processing overhead as a percentage of main processor cycles needed to mix this sound buffer. For hardware buffers, this member will be zero because the mixing is performed by the sound device. For software buffers, this member depends on the buffer format and the speed of the system processor. - - - - - Flags that specify buffer-object capabilities. - - - - - None - - - - - The buffer is a primary buffer. - - - - - The buffer is in on-board hardware memory. - - - - - The buffer uses hardware mixing. - - - - - The buffer is in software memory and uses software mixing. - - - - - The buffer has 3D control capability. - - - - - The buffer has frequency control capability. - - - - - The buffer has pan control capability. - - - - - The buffer has volume control capability. - - - - - The buffer has position notification capability. - - - - - The buffer supports effects processing. - - - - - The buffer has sticky focus. If the user switches to another application not using DirectSound, the buffer is still audible. However, if the user switches to another DirectSound application, the buffer is muted. - - - - - The buffer is a global sound buffer. With this flag set, an application using DirectSound can continue to play its buffers if the user switches focus to another application, even if the new application uses DirectSound. - For more information, see . - - - - - The buffer uses the new behavior of the play cursor when is called. For more information, see . - - - - - The sound is reduced to silence at the maximum distance. The buffer will stop playing when the maximum distance is exceeded, so that processor time is not wasted. Applies only to software buffers. - - - - - The buffer can be assigned to a hardware or software resource at play time, or when is called. - - - - - Force to return the buffer's true play position. This flag is only valid in Windows Vista. - - - - - Describes the characteristics of a new buffer object. - - - - - Size of the structure, in bytes. This member must be initialized before the structure is used. - - Use the or the method to - - - - Flags specifying the capabilities of the buffer. - - - - - Size of the new buffer, in bytes. For more information, see . - - Must be a value between 4 and 0x0FFFFFFF. - - - - Address of a or class specifying the waveform format for the buffer. This value must be for primary buffers. - - - - - Unique identifier of the two-speaker virtualization algorithm to be used by DirectSound3D hardware emulation. If is not set in , this member must be . - For more information, see . - - - - - Flags describing device capabilities. - - - - - The driver has been tested and certified by Microsoft. This flag is always set for WDM drivers. To test for certification, use . - - - - - The device supports all sample rates between the and member values. Typically, this means that the actual output rate will be within +/- 10 hertz (Hz) of the requested frequency. - - - - - The device does not have a DirectSound driver installed, so it is being emulated through the waveform-audio functions. Performance degradation should be expected. - - - - - None - - - - - The device supports a primary buffer with 16-bit samples. - - - - - The device supports primary buffers with 8-bit samples. - - - - - The device supports monophonic primary buffers. - - - - - The device supports stereo primary buffers. - - - - - The device supports hardware-mixed secondary sound buffers with 16-bit samples. - - - - - The device supports hardware-mixed secondary buffers with 8-bit samples. - - - - - The device supports hardware-mixed monophonic secondary buffers. - - - - - The device supports hardware-mixed stereo secondary buffers. - - - - - Defines possible return values for the method. - - For more information, see or . - - - - Driver is certified for DirectSound. - - - - - Driver is not certified for DirectSound. - - - - - Not supported. - - The method returned DSERR_UNSUPPORTED. - - - - Defines cooperative levels which can be set by calling the - method. - - For more information, see . - - - - Sets the normal level. This level has the smoothest multitasking and resource-sharing behavior, but because it does - not allow the primary buffer format to change, output is restricted to the default 8-bit format. - - - - - Sets the priority level. Applications with this cooperative level can call the SetFormat and Compact methods. - - - - - For DirectX 8.0 and later, has the same effect as . For previous versions, sets the - application to the exclusive level. This means that when it has the input focus, the application will be the only - one audible; sounds from applications with the GlobalFocus flag set will be muted. With this level, it also - has all the privileges of the DSSCL_PRIORITY level. DirectSound will restore the hardware format, as specified by - the most recent call to the SetFormat method, after the application gains the input focus. - - - - - Sets the write-primary level. The application has write access to the primary buffer. No secondary buffers can be - played. This level cannot be set if the DirectSound driver is being emulated for the device; that is, if the - GetCaps method returns the DSCAPS_EMULDRIVER flag in the DSCAPS structure. - - - - - Defines possible DirectSound return values. - - For more information, see . - - - - The method succeeded. - - - - - The DirectSound subsystem could not allocate sufficient memory to complete the caller's request. - - - - - The requested COM interface is not available. - - - - - The buffer was created, but another 3D algorithm was substituted. - - - - - The method succeeded, but not all the optional effects were obtained. - - - - - The function called is not supported at this time. - - - - - An undetermined error occurred inside the DirectSound subsystem. - - - - - The request failed because access was denied. - - - - - An invalid parameter was passed to the returning function. - - - - - The request failed because resources, such as a priority level, were already in use by another caller. - - - - - The buffer control (volume, pan, and so on) requested by the caller is not available. Controls must be specified when the buffer is created, using the member of . - - - - - This function is not valid for the current state of this object. - - - - - A cooperative level of or higher is required. - - - - - The specified wave format is not supported. - - - - - No sound driver is available for use, or the given GUID is not a valid DirectSound device ID. - - - - - The object is already initialized. - - - - - The buffer memory has been lost and must be restored. - - - - - Another application has a higher priority level, preventing this call from succeeding. - - - - - The method has not been called or has not been called successfully before other methods were called. - - - - - The buffer size is not great enough to enable effects processing. - - - - - A DirectSound object of class CLSID_DirectSound8 or later is required for the requested functionality. - - - - - A circular loop of send effects was detected. - - - - - The GUID specified in an audiopath file does not match a valid mix-in buffer. - - - - - The effects requested could not be found on the system, or they are in the wrong order or in the wrong location; for example, an effect expected in hardware was found in software. - - - - - The requested object was not found. - - - - - Defines possible speaker configurations. - - - - - The audio is passed through directly, without being configured for speakers. - - - - - The audio is played through headphones. - - - - - The audio is played through a single speaker. - - - - - The audio is played through quadraphonic speakers. - - - - - The audio is played through stereo speakers (default value). - - - - - The audio is played through surround speakers. - - - - - The audio is played through a home theater speaker arrangement of five surround speakers with a subwoofer. - - Obsolete 5.1 setting. Use instead. - - - - The audio is played through a home theater speaker arrangement of seven surround speakers with a subwoofer. - - Obsolete 7.1 setting. Use instead. - - - - The audio is played through a home theater speaker arrangement of seven surround speakers with a subwoofer. This value applies to Windows XP SP2 or later. - - - - - The audio is played through a home theater speaker arrangement of five surround speakers with a subwoofer. This value applies to Windows Vista or later. - - - - - The audio is played through a wide speaker arrangement of seven surround speakers with a subwoofer. ( is still defined, but is obsolete as of Windows XP SP 2. Use instead.) - - - - - The audio is played through a speaker arrangement of five surround speakers with a subwoofer. ( is still defined, but is obsolete as of Windows Vista. Use instead.) - - - - - Defines values that can be combined with the value. - - To combine the a value with the stereo value, use the method. - - - - The speakers are directed over an arc of 5 degrees. - - - - - The speakers are directed over an arc of 10 degrees. - - - - - The speakers are directed over an arc of 20 degrees. - - - - - The speakers are directed over an arc of 180 degrees. - - - - - implementation for Dmo based streams. - - - - - Creates a new instance of the class. - - Base source of the . - - - - Gets or sets the position of the stream in bytes. - - - - - Gets the length of the stream in bytes. - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets the of the . - - - - - Gets inputData to feed the Dmo MediaObject with. - - - InputDataBuffer which receives the inputData. - If this parameter is null or the length is less than the amount of inputData, a new byte array will be applied. - - The requested number of bytes. - The number of bytes read. The number of actually read bytes does not have to be the number of requested bytes. - - - - Gets the input format to use. - - The input format. - Typically this is the of the . - - - - Defines DMO-Categories for enumerating DMOs. - - - - - All DMOs. - - - - - AudioEffects - - - - - AudioCaptureEffects - - - - - Category which includes audio decoder. - - - - - Category which includes audio encoder. - - - - - Defines flags that specify search criteria when enumerating Microsoft DirectX Media Objects. - For more information, see . - - - A software key enables the developer of a DMO to control who uses the DMO. If a DMO has a software key, - applications must unlock the DMO to use it. The method for unlocking the DMO depends on the implementation. Consult - the documentation for the particular DMO. - - - - - None - - - - - The enumeration should include DMOs whose use is restricted by a software key. If this flag is absent, keyed DMOs - are omitted from the enumeration. - - - - - Encapsulates the properties of an enumerated dmo. - - - - - Gets or sets the CLSID of the dmo. - - - - - Gets or sets the friendly name of the dmo. - - - - - Error codes that are specific to Microsoft DirectX Media Objects. - - - - - Invalid stream index. - - - - - Invalid media type. - - - - - Media type was not set. One or more streams require a media type before this operation can be performed. - - - - - Data cannot be accepted on this stream. You might need to process more output data; see MediaObject::ProcessInput - (-> http://msdn.microsoft.com/en-us/library/windows/desktop/dd406959(v=vs.85).aspx). - - - - - Media type was not accepted. - - - - - Media-type index is out of range. - - - - - Encapsulates the values retrieved by the method. - - - - - Initializes a new instance of the class. - - The minimum size of an input buffer for the stream, in bytes. - The required buffer alignment, in bytes. If the stream has no alignment requirement, the value is 1 - The maximum amount of data that the DMO will hold for a lookahead, in bytes. If the DMO does not perform a lookahead on the stream, the value is zero. - - - - Gets the maximum amount of data that the DMO will hold for a lookahead, in bytes. If the DMO does not perform a - lookahead on the stream, the value is zero. - - - - - Defines flags that describe an input stream. - - - - - None. - - - - - The stream requires whole samples. Samples must not span multiple buffers, and buffers must not contain partial - samples. - - - - - Each buffer must contain exactly one sample. - - - - - All the samples in this stream must be the same size. - - - - - The DMO performs lookahead on the incoming data, and may hold multiple input buffers for this stream. - - - - - Represents a Dmo output data buffer. For more details see . - - - - - Pointer to the interface of a buffer allocated by the application. - - - - - Status flags. After processing output, the DMO sets this member to a bitwise combination - of or more flags. - - - - - Time stamp that specifies the start time of the data in the buffer. If the buffer has a - valid time stamp, the DMO sets this member and also sets the - flag in the dwStatus member. Otherwise, ignore this member. - - - - - Reference time specifying the length of the data in the buffer. If the DMO sets this - member to a valid value, it also sets the flag in the - dwStatus member. Otherwise, ignore this member. - - - - - Initializes a new instance of the struct. - - The maxlength (in bytes) of the internally used . - - - - Gets the length of the . - - - - - Reads a sequence of bytes from the . - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - The number of read bytes. - - - - Reads a sequence of bytes from the . - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - The maximum number of bytes to read from the buffer. - The number of read bytes. - - - - Reads a sequence of bytes from the . - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - The maximum number of bytes to read from the buffer. - Zero-based offset inside of the source buffer at which to begin copying data. - The number of read bytes. - - - - Resets the Buffer. Sets the length of the to zero and sets the - to . - - - - - Disposes the internally used . - - - - - The enumeration defines flags that describe an output stream. - - - - - None - - - - - The stream contains whole samples. Samples do not span multiple buffers, and buffers do not contain partial - samples. - - - - - Each buffer contains exactly one sample. - - - - - All the samples in this stream are the same size. - - - - - The stream is discardable. Within calls to IMediaObject::ProcessOutput, the DMO can discard data for this stream - without copying it to an output buffer. - - - - - The stream is optional. An optional stream is discardable. Also, the application can ignore this stream entirely; - it does not have to set the media type for the stream. Optional streams generally contain additional information, - or data not needed by all applications. - - - - - Describes a media type used by a Microsoft DirectX Media Object. - - For more informatin, see . - - - - Major type GUID. Use to match any major type. - - - - - Subtype GUID. Use to match any subtype. - - - - - Encapsulates the values retrieved by the - and the - method. - - - - - Initializes a new instance of the class. - - The minimum size of an input buffer for the stream, in bytes. - The required buffer alignment, in bytes. If the stream has no alignment requirement, the value is 1. - - - - Gets the minimum size of an input buffer for this stream, in bytes. - - - - - Gets the required buffer alignment, in bytes. If the input stream has no alignment requirement, the value is 1. - - - - - Base class for all Dmo based streams. - - - - - The default inputStreamIndex to use. - - - - - The default outputStreamIndex to use. - - - - - Gets the input format of the . - - - - - Reads a sequence of bytes from the stream. - - An array of bytes. When this method returns, the buffer contains the read bytes. - The zero-based byte offset in buffer at which to begin storing the data read from the stream. - The maximum number of bytes to be read from the stream - The actual number of read bytes. - - - - Gets or sets the position of the stream. - - - - - Gets the length of the stream. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the . - - - - - Gets the output format of the . - - - - - Gets inputData to feed the Dmo MediaObject with. - - - InputDataBuffer which receives the inputData. - If this parameter is null or the length is less than the amount of inputData, a new byte array will be applied. - - The requested number of bytes. - The number of bytes read. The number of actually read bytes does not have to be the number of requested bytes. - - - - Creates and returns a new instance to use for processing audio data. This can be a decoder, effect, ... - - The input format of the to create. - The output format of the to create. - The created to use for processing audio data. - - - - Gets the input format to use. - - The input format. - - - - Gets the output format to use. - - The output format. - - - - Initializes the DmoStream. Important: This has to be called before using the DmoStream. - - - - - Converts a position of the inputstream to the equal position in the outputstream. - - Any position/offset of the inputstream, in bytes. - Position in the outputstream, in bytes. - - - - Translates a position of the outputstream to the equal position in the inputstream. - - Any position/offset of the outputstream, in bytes. - Position in the inputstream, in bytes. - - - - Resets the overflowbuffer. - - - - - Releases the . - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Internal parameter structure for the effect. - - - - - The wet dry mix. - - - - - The depth. - - - - - The feedback. - - - - - The frequency. - - - - - The waveform. - - - - - The delay. - - - - - The phase. - - - - - Internal parameter structure for the effect. - - - - - The gain. - - - - - The attack. - - - - - The release. - - - - - The threshold. - - - - - The ratio. - - - - - The predelay. - - - - - Base class for any DirectSoundEffect. - - Parameters type. - - - - Default ctor for a ComObject. - - Pointer of a DirectSoundEffect interface. - - - - Gets or sets the Parameters of the Effect. - - - - - Gets the name of the COM interface. Used for generating error messages. - - - - - Sets the effects parameters. - - - Object that contains the new parameters of the effect. - HRESULT - Use the property instead. - - - - Retrieves the effects parameters. - - - A variable which retrieves the set parameters of the effect. - HRESULT - Use the property instead. - - - - The IDirectSoundFXChorus interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXChorus wrapper based on a pointer to a IDirectSoundFXChorus cominterface. - - Pointer of a DirectSoundFXChorus interface. - - - - Interface name used for generating DmoExceptions. - - - - - The DirectSoundFXCompressor interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXCompressor wrapper based on a pointer to a IDirectSoundFXCompressor cominterface. - - Pointer of a DirectSoundFXCompressor interface. - - - - Interface name used for generating DmoExceptions. - - - - - The DirectSoundFXDistortion interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXDistortion wrapper based on a pointer to a IDirectSoundFXDistortion cominterface. - - Pointer of a DirectSoundFXDistortion interface. - - - - Interface name used for generating DmoExceptions. - - - - - The IDirectSoundFXEcho interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXEcho wrapper based on a pointer to a IDirectSoundFXEcho cominterface. - - Pointer of a DirectSoundFXEcho interface. - - - - Interface name used for generating DmoExceptions. - - - - - The DirectSoundFXFlanger interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXFlanger wrapper based on a pointer to a IDirectSoundFXFlanger cominterface. - - Pointer of a DirectSoundFXFlanger interface. - - - - Interface name used for generating DmoExceptions. - - - - - The IDirectSoundFXChorus interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXGargle wrapper based on a pointer to a IDirectSoundFXGargle cominterface. - - Pointer of a DirectSoundFXGargle interface. - - - - Interface name used for generating DmoExceptions. - - - - - The DirectSoundFXReverb interface is used to set and retrieve effect parameters. - - - - - Creates a DirectSoundFXWavesReverb wrapper based on a pointer to a IDirectSoundFXWavesReverb cominterface. - - Pointer of a DirectSoundFXWavesReverb interface. - - - - Interface name used for generating DmoExceptions. - - - - - Internal parameter structure for the effect. - - - - - The gain. - - - - - The edge. - - - - - The post eq center frequency. - - - - - The post eq bandwidth. - - - - - The pre lowpass cutoff. - - - - - Internal parameter structure for the effect. - - - - - The wet dry mix. - - - - - The feedback. - - - - - The left delay. - - - - - The right delay. - - - - - The pan delay. - - - - - Internal parameter structure for the effect. - - - - - The wet dry mix. - - - - - The depth. - - - - - The feedback. - - - - - The frequency. - - - - - The waveform. - - - - - The delay. - - - - - The phase. - - - - - Internal parameter structure for the effect. - - - - - The rate hz. - - - - - The wave shape. - - - - - Internal parameter structure for the effect. - - - - - The in gain. - - - - - The reverb mix. - - - - - The reverb time. - - - - - The high freq rt ratio. - - - - - Provides methods for enumerating Microsoft DirectX Media Objects. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Enumerates DMOs listed in the registry. The caller can search by category, media type, or both. - - - GUID that specifies which category of DMO to search. Use Guid.Empty to search every category. - See for a list of category guids. - - Flags that specify search criteria. - Array of input-Mediatypes. - Array of output-Mediatypes. - EnumDMO - - - - Enumerates DMOs listed in the registry. - - - GUID that specifies which category of DMO to search. Use Guid.Empty to search every category. - See for a list of category guids. - - Flags that specify search criteria. - An that can be used to iterate through the enumerated DMOs. - - - - Retrieves a specified number of items in the enumeration sequence. - - Number of items to retrieve. - Array that is filled with the CLSIDs of the enumerated DMOs. - Array that is filled with the friendly names of the enumerated DMOs. - Actual number of items retrieved. - HRESULT - - - - Retrieves a specified number of items in the enumeration sequence. - - Number of items to retrieve. - Array of enumerated DMOs. - - - - Skips over a specified number of items in the enumeration sequence. - - Number of items to skip. - HRESULT - - - - Skips over a specified number of items in the enumeration sequence. - - Number of items to skip. - - - - Resets the enumeration sequence to the beginning. - - HRESULT - - - - Resets the enumeration sequence to the beginning. - - - - - This method is not implemented. - - Reserved - - - - - This method is not implemented. - - This method is not implemented an will throw an with the error code . - - - - The interface provides methods for manipulating a data buffer. - - For more information, . - - - - The SetLength method specifies the length of the data currently in the buffer. - - Size of the data, in bytes. The value must not exceed the buffer's maximum size. Call the method to obtain the maximum size. - HRESULT - - - - The method retrieves the maximum number of bytes this buffer can hold. - - A variable that receives the buffer's maximum size, in bytes. - HRESULT - - - - The method retrieves the buffer and the size of the valid data in the buffer. - - Address of a pointer that receives the buffer array. Can be if is not . - Pointer to a variable that receives the size of the valid data, in bytes. Can be if is not . - HRESULT - - - - Defines flags that describe an input buffer. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375501(v=vs.85).aspx - - - - - None - - - - - The beginning of the data is a synchronization point. - - - - - The buffer's time stamp is valid. The buffer's indicated time length is valid. - - - - - The buffer's indicated time length is valid. - - - - - InputStatusFlags. - See also: http://msdn.microsoft.com/en-us/library/windows/desktop/dd406950(v=vs.85).aspx - - - - - None - - - - - The stream accepts data. - - - - - Defines flags that describe an input stream. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375502(v=vs.85).aspx. - - - - - None - - - - - The stream contains whole samples. Samples do not span multiple buffers, and buffers do - not contain partial samples. - - - - - Each buffer contains exactly one sample. - - - - - The stream is discardable. Within calls to IMediaObject::ProcessOutput, the DMO can - discard data for this stream without copying it to an output buffer. - - - - - The DMO performs lookahead on the incoming data, and may hold multiple input buffers for - this stream. - - - - - Defines flags that describe an output buffer. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375508(v=vs.85).aspx. - - - - - None - - - - - The beginning of the data is a synchronization point. A synchronization point is a - random access point. For encoded video, this a sample that can be used as a decoding - start point (key frame). For uncompressed audio or video, every sample is a - synchronization point. - - - - - The buffer's time stamp is valid. The buffer's indicated time length is valid. - - - - - The buffer's indicated time length is valid. - - - - - There is still input data available for processing, but the output buffer is full. - - - - - Flags that describe an output stream. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375509(v=vs.85).aspx. - - - - - None - - - - - The stream contains whole samples. Samples do not span multiple buffers, and buffers do - not contain partial samples. - - - - - Each buffer contains exactly one sample. - - - - - All the samples in this stream are the same size. - - - - - The stream is discardable. Within calls to IMediaObject::ProcessOutput, the DMO can - discard data for this stream without copying it to an output buffer. - - - - - The stream is optional. An optional stream is discardable. Also, the application can - ignore this stream entirely; it does not have to set the media type for the stream. - Optional streams generally contain additional information, or data not needed by all - applications. - - - - - Defines flags that specify output processing requests. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375511(v=vs.85).aspx - - - - - None - - - - - Discard the output when the pointer to the output buffer is NULL. - - - - - Defines flags for setting the media type on a stream. - See http://msdn.microsoft.com/en-us/library/windows/desktop/dd375514(v=vs.85).aspx. - - - - - None - - - - - Test the media type but do not set it. - - - - - Clear the media type that was set for the stream. - - - - - Default-Implementation of the IMediaBuffer interface. - For more information, see . - - - - - Creates a MediaBuffer and allocates the specified number of bytes in the memory. - - The number of bytes which has to be allocated in the memory. - - - - Gets the maximum number of bytes this buffer can hold. - - - - - Gets the length of the data currently in the buffer. - - - - - Frees the allocated memory of the internally used buffer. - - - - - The SetLength method specifies the length of the data currently in the buffer. - - Size of the data, in bytes. The value must not exceed the buffer's maximum size. Call the method to obtain the maximum size. - HRESULT - - - - The method retrieves the maximum number of bytes this buffer can hold. - - A variable that receives the buffer's maximum size, in bytes. - HRESULT - - - - The method retrieves the buffer and the size of the valid data in the buffer. - - Address of a pointer that receives the buffer array. Can be if is not . - Pointer to a variable that receives the size of the valid data, in bytes. Can be if is not . - HRESULT - - - - Writes a sequence of bytes to the internally used buffer. - - - Array of bytes. The Write method copies data from the specified array of bytes to the internally - used buffer. - - - Zero-based bytes offset in the specified buffer at which to begin copying bytes to the internally - used buffer. - - The number of bytes to be copied. - - - - Reads a sequence of bytes from the internally used buffer. - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - - - - Reads a sequence of bytes from the buffer. - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - The maximum number of bytes to read from the buffer. - - - - Reads a sequence of bytes from the buffer. - - Array of bytes to store the read bytes in. - - Zero-based byte offset in the specified buffer at which to begin storing the data read from the - buffer. - - The maximum number of bytes to read from the buffer. - Zero-based offset inside of the source buffer at which to begin copying data. - - - - Frees the allocated memory of the internally used buffer. - - - - - Frees the allocated memory of the internally used buffer. - - - - - Represents a DMO MediaObject. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Gets the number of input streams. - - - - - Gets the number of output streams. - - - - - Creates a MediaObject from any ComObjects. - - - Internally the IUnknown::QueryInterface method of the specified COM Object gets called. - - The COM Object to cast to a . - The . - - - - Retrieves the number of input and output streams. - - A variable that receives the number of input streams. - A variable that receives the number of output streams. - HRESULT - - - - Retrieves the number of input and output streams. - - A variable that receives the number of input streams. - A variable that receives the number of output streams. - - - - Retrieves information about a specified input stream. - - Zero-based index of an input stream on the DMO. - Bitwise combination of zero or more flags. - HRESULT - - - - Retrieves information about a specified input stream. - - Zero-based index of an input stream on the DMO. - The retrieved information about the specified input stream. - - - - Retrieves information about a specified output stream. - - Zero-based index of an output stream on the DMO. - Bitwise combination of zero or more flags. - HRESULT - - - - Retrieves information about a specified output stream. - - Zero-based index of an output stream on the DMO. - The information about the specified output stream. - - - - Retrieves a preferred media type for a specified input stream. - - Zero-based index on the set of acceptable media types. - - Can be null to check whether the typeIndex argument is in range. If not, the errorcode will be - (0x80040206). - - Zero-based index of an input stream on the DMO. - HRESULT - - - - Retrieves a preferred media type for a specified input stream. - - Zero-based index on the set of acceptable media types. - Zero-based index of an input stream on the DMO. - The preferred media type for the specified input stream. - - - - Retrieves a preferred media type for a specified output stream. - - Zero-based index on the set of acceptable media types. - - Can be null to check whether the typeIndex argument is in range. If not, the errorcode will be - (0x80040206). - - Zero-based index of an output stream on the DMO. - HRESULT - - - - Retrieves a preferred media type for a specified output stream. - - Zero-based index on the set of acceptable media types. - Zero-based index of an output stream on the DMO. - The preferred media type for the specified output stream. - - - - Sets the media type on an input stream, or tests whether a media type is acceptable. - - Zero-based index of an input stream on the DMO. - The new mediatype. - Bitwise combination of zero or more flags from the enumeration. - HRESULT - - - - Clears the inputtype for a specific input stream. - - Zero-based index of an input stream on the DMO. - - - - Sets the media type on an input stream. - - Zero-based index of an input stream on the DMO. - The new mediatype. - Bitwise combination of zero or more flags from the enumeration. - - - - Sets the media type on an input stream. - - Zero-based index of an input stream on the DMO. - The format to set as the new for the specified input stream. - - - - Tests whether the given is supported. - - Zero-based index of an input stream on the DMO. - The to test whether it is supported. - True = supported, False = not supported - - - - Tests whether the given is supported. - - Zero-based index of an input stream on the DMO. - The to test whether it is supported. - True = supported, False = not supported - - - - Sets the on an output stream, or tests whether a is acceptable. - - Zero-based index of an output stream on the DMO. - The new . - Bitwise combination of zero or more flags from the enumeration. - HRESULT - - - - Clears the outputtype for a specific output stream. - - Zero-based index of an output stream on the DMO. - - - - Sets the on an output stream, or tests whether a is acceptable. - - Zero-based index of an output stream on the DMO. - The new . - Bitwise combination of zero or more flags from the enumeration. - - - - Sets the on an output stream, or tests whether a is acceptable. - - Zero-based index of an output stream on the DMO. - The format to set as the new for the specified output stream. - - - - Tests whether the given is supported as OutputFormat. - - Zero-based index of an output stream on the DMO. - WaveFormat - True = supported, False = not supported - - - - Tests whether the given is supported. - - Zero-based index of an output stream on the DMO. - The to test whether it is supported. - True = supported, False = not supported - - - - Retrieves the media type that was set for an input stream, if any. - - Zero-based index of an input stream on the DMO. - A variable that receives the retrieved media type of the specified input stream. - HRESULT - - - - Retrieves the media type that was set for an input stream, if any. - - Zero-based index of an input stream on the DMO. - The retrieved media type of the specified input stream. - - - - Retrieves the media type that was set for an output stream, if any. - - Zero-based index of an output stream on the DMO. - A variable that receives the retrieved media type of the specified output stream. - HRESULT - - - - Retrieves the media type that was set for an output stream, if any. - - Zero-based index of an output stream on the DMO. - The media type that was set for the specified output stream. - - - - Retrieves the buffer requirements for a specified input stream. - - Zero-based index of an input stream on the DMO. - Minimum size of an input buffer for this stream, in bytes. - - The maximum amount of data that the DMO will hold for a lookahead, in bytes. If the DMO does - not perform a lookahead on the stream, the value is zero. - - - The required buffer alignment, in bytes. If the input stream has no alignment requirement, the - value is 1. - - HRESULT - - - - This method retrieves the buffer requirements for a specified input stream. - - Zero-based index of an input stream on the DMO. - The buffer requirements for the specified input stream. - - - - This method retrieves the buffer requirements for a specified output stream. - - Zero-based index of an output stream on the DMO. - Minimum size of an output buffer for this stream, in bytes. - - The required buffer alignment, in bytes. If the output stream has no alignment requirement, the - value is 1. - - HRESULT - - - - This method retrieves the buffer requirements for a specified output stream. - - Zero-based index of an output stream on the DMO. - The buffer requirements for the specified output stream. - - - - Retrieves the maximum latency on a specified input stream. - - Zero-based index of an input stream on the DMO. - Receives the maximum latency in reference type units. Unit = REFERENCE_TIME = 100 nanoseconds - HRESULT - - - - Retrieves the maximum latency on a specified input stream. - - Zero-based index of an input stream on the DMO. - The maximum latency in reference type units. Unit = REFERENCE_TIME = 100 nanoseconds - - - - Sets the maximum latency on a specified input stream. - - Zero-based index of an input stream on the DMO. - Maximum latency in reference time units. Unit = REFERENCE_TIME = 100 nanoseconds - HRESULT - For the definition of maximum latency, see . - - - - Sets the maximum latency on a specified input stream. - - Zero-based index of an input stream on the DMO. - Maximum latency in reference time units. Unit = REFERENCE_TIME = 100 nanoseconds - HRESULT - For the definition of maximum latency, see . - - - - This method flushes all internally buffered data. - - HRESULT - - - - This method flushes all internally buffered data. - - - - - Signals a discontinuity on the specified input stream. - - Zero-based index of an input stream on the DMO. - HRESULT - A discontinuity represents a break in the input. A discontinuity might occur because no more data is expected, the format is changing, or there is a gap in the data. - After a discontinuity, the DMO does not accept further input on that stream until all pending data has been processed. - The application should call the method until none of the streams returns the (see ) flag. - This method might fail if it is called before the client sets the input and output types on the DMO. - - - - Signals a discontinuity on the specified input stream. - - Zero-based index of an input stream on the DMO. - A discontinuity represents a break in the input. A discontinuity might occur because no more data is expected, the format is changing, or there is a gap in the data. - After a discontinuity, the DMO does not accept further input on that stream until all pending data has been processed. - The application should call the method until none of the streams returns the (see ) flag. - This method might fail if it is called before the client sets the input and output types on the DMO. - - - - Allocates any resources needed by the DMO. Calling this method is always - optional. - - HRESULT - - For more information, see . - - - - - Allocates any resources needed by the DMO. Calling this method is always - optional. - - - For more information, see . - - - - - Frees resources allocated by the DMO. Calling this method is always optional. - - HREUSLT - - For more information, see . - - - - - Frees resources allocated by the DMO. Calling this method is always optional. - - - For more information, see . - - - - - Queries whether an input stream can accept more input data. - - Zero-based index of an input stream on the DMO. - The queried input status. - - For more information, see . - - - - - Queries whether an input stream can accept more input data. - - Zero-based index of an input stream on the DMO. - A variable that receives either or . - HRESULT - - For more information, see . - - - - - Queries whether an input stream can accept more input data. - - Zero-based index of an input stream on the DMO. - If the return value is True, the input stream can accept more input data. Otherwise false. - - - - Delivers a buffer to the specified input stream. - - Zero-based index of an input stream on the DMO. - The to process. - - - - Delivers a buffer to the specified input stream. - - Zero-based index of an input stream on the DMO. - The to process. - Bitwise combination of or more flags from the enumeration. - - - - Delivers a buffer to the specified input stream. - - Zero-based index of an input stream on the DMO. - The to process. - Bitwise combination of or more flags from the enumeration. - - Time stamp that specifies the start time of the data in the buffer. If the buffer has a valid - time stamp, set the Time flag in the flags parameter. - - - Reference time specifying the duration of the data in the buffer. If the buffer has a valid - time stamp, set the TimeLength flag in the flags parameter. - - - - - Delivers a buffer to the specified input stream. - - Zero-based index of an input stream on the DMO. - The to process. - Bitwise combination of or more flags from the enumeration. - - Time stamp that specifies the start time of the data in the buffer. If the buffer has a valid - time stamp, set the Time flag in the flags parameter. - - - Reference time specifying the duration of the data in the buffer. If the buffer has a valid - time stamp, set the TimeLength flag in the flags parameter. - - HRESULT - - - - Generates output from the current input data. - - Bitwise combination of or more flags from the enumeration. - An array of output buffers to process. - - - - Generates output from the current input data. - - Bitwise combination of or more flags from the enumeration. - An array of output buffers to process. - Number of output buffers. - - - - Generates output from the current input data. - - Bitwise combination of or more flags from the enumeration. - An array of output buffers to process. - Number of output buffers. - Receives a reserved value (zero). The application should ignore this value. - HREUSLT - - - - Acquires or releases a lock on the DMO. Call this method to keep the DMO serialized when performing multiple - operations. - - - Value that specifies whether to acquire or release the lock. If the value is non-zero, a lock is - acquired. If the value is zero, the lock is released. - - HRESULT - - - - Acquires or releases a lock on the DMO. Call this method to keep the DMO serialized when performing multiple - operations. - - - Value that specifies whether to acquire or release the lock. If the value is non-zero, a lock is - acquired. If the value is zero, the lock is released. - - - - - Acquires or releases a lock on the DMO. Call this method to keep the DMO serialized when performing multiple - operations. - - A disposable object which can be used to unlock the by calling its method. - - This example shows how to use the method: - - partial class TestClass - { - public void DoStuff(MediaObject mediaObject) - { - using(var lock = mediaObject.Lock()) - { - //do some stuff - } - //the mediaObject gets automatically unlocked by the using statement after "doing your stuff" - } - } - - - - - - Used to unlock a after locking it by calling the method. - - - - - Unlocks the locked . - - - - - The structure describes the format of the data used by a stream in a Microsoft DirectX Media Object (DMO). - For more information, . - - - - - Creates a MediaType based on a given WaveFormat. Don't forget to call Free() for the returend MediaType. - - WaveFormat to create a MediaType from. - Dmo MediaType - - - - A GUID identifying the stream's major media type. This must be one of the DMO Media - Types(see ). - - - - - Subtype GUID of the stream. - - - - - If TRUE, samples are of a fixed size. This field is informational only. For audio, it is - generally set to TRUE. For video, it is usually TRUE for uncompressed video and FALSE - for compressed video. - - - - - If TRUE, samples are compressed using temporal (interframe) compression. A value of TRUE - indicates that not all frames are key frames. This field is informational only. - - - - - Size of the sample, in bytes. For compressed data, the value can be zero. - - - - - GUID specifying the format type. The pbFormat member points to the corresponding format - structure. (see ) - - - - - Size of the format block of the media type. - - - - - Pointer to the format structure. The structure type is specified by the formattype - member. The format structure must be present, unless formattype is GUID_NULL or - FORMAT_None. - - - - - Frees the allocated members of a media type structure by calling the MoFreeMediaType function. - - - - - Sets properties on the audio resampler DSP. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Specifies the quality of the output. - - - Specifies the quality of the output. The valid range is 1 to 60, - inclusive. - - - - - Specifies the channel matrix. - - An array of floating-point values that represents a channel conversion matrix. - - Use the class to build the channel-conversation-matrix and its - method to convert the channel-conversation-matrix into a - compatible array which can be passed as value for the parameter. - For more information, - . - - - - - Specifies the quality of the output. - - - Specifies the quality of the output. The valid range is 1 to 60, - inclusive. - - HRESULT - - - - Specifies the channel matrix. - - An array of floating-point values that represents a channel conversion matrix. - HRESULT - - Use the class to build the channel-conversation-matrix and its - method to convert the channel-conversation-matrix into a - compatible array which can be passed as value for the parameter. - For more information, - . - - - - - DirectX Media Object COM Exception - - - - - Initializes a new instance of the class. - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - - The StreamingContext object that supplies the contextual information about the source or - destination. - - - - - Throws an if the is not . - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Specifies the quality of the output. - - - Specifies the quality of the output. The valid range is 1 to 60, - inclusive. - - HRESULT - - - - Used to apply a bandpass-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - - - - Calculates all coefficients. - - - - - Represents a biquad-filter. - - - - - The a0 value. - - - - - The a1 value. - - - - - The a2 value. - - - - - The b1 value. - - - - - The b2 value. - - - - - The q value. - - - - - The gain value in dB. - - - - - The z1 value. - - - - - The z2 value. - - - - - Gets or sets the frequency. - - value;The samplerate has to be bigger than 2 * frequency. - - - - Gets the sample rate. - - - - - The q value. - - - - - Gets or sets the gain value in dB. - - - - - Initializes a new instance of the class. - - The sample rate. - The frequency. - - sampleRate - or - frequency - or - q - - - - - Initializes a new instance of the class. - - The sample rate. - The frequency. - The q. - - sampleRate - or - frequency - or - q - - - - - Processes a single sample and returns the result. - - The input sample to process. - The result of the processed sample. - - - - Processes multiple samples. - - The input samples to process. - The result of the calculation gets stored within the array. - - - - Calculates all coefficients. - - - - - Represents an element inside of a . - - - - - Gets the assigned input channel of the . - - - - - Gets the assigned output channel of the . - - - - - Gets or sets the coefficient in the range from 0.0f to 1.0f. - - - - - Initializes a new instance of the class. - - The input channel. - The output channel. - - - - Provides an Fast Fourier Transform implementation including a few utils method which are commonly used in combination with FFT (e.g. the hamming window function). - - - - - Obsolete. Use the property instead. - - - - The intensity of the complex value . - sqrt(r² + i²) - - - - Implementation of the Hamming Window using double-precision floating-point numbers. - - Current index of the input signal. - Window width. - Hamming window multiplier. - - - - Hamming window implementation using single-precision floating-point numbers. - - Current index of the input signal. - Window width. - Hamming Window multiplier. - - - - Computes an Fast Fourier Transform. - - Array of complex numbers. This array provides the input data and is used to store the result of the FFT. - The exponent n. - The to use. Use as the default value. - - - - Computes an Fast Fourier Transform. - - Array of complex numbers. This array provides the input data and is used to store the result of the FFT. - The exponent n. - The to use. Use as the default value. - - - - Provides FFT calculations. - - - Usage: Use the -method to input samples to the . Use the method to - calculate the Fast Fourier Transform. - - - - - Gets the specified fft size. - - - - - Gets a value which indicates whether new data is available. - - - - - Initializes a new instance of the class. - - Number of channels of the input data. - The number of bands to use. - is less than zero. - - - - Adds a and a sample to the . The and the sample will be merged together. - - The sample of the left channel. - The sample of the right channel. - - - - Adds multiple samples to the . - - Float Array which contains samples. - Number of samples to add to the . - - - - Calculates the Fast Fourier Transform and stores the result in the . - - The output buffer. - Returns a value which indicates whether the Fast Fourier Transform got calculated. If there have not been added any new samples since the last transform, the FFT won't be calculated. True means that the Fast Fourier Transform got calculated. - - - - Calculates the Fast Fourier Transform and stores the result in the . - - The output buffer. - Returns a value which indicates whether the Fast Fourier Transform got calculated. If there have not been added any new samples since the last transform, the FFT won't be calculated. True means that the Fast Fourier Transform got calculated. - - - - Fft mode. - - - - - Forward - - - - - Backward - - - - - Defines FFT data size constants that can be used for FFT calculations. - Note that only the half of the specified size can be used for visualizations. - - - - - 64 bands. - - - - - 128 bands. - - - - - 256 bands. - - - - - 512 bands. - - - - - 1024 bands. - - - - - 2014 bands. - - - - - 4096 bands. - - - - - 8192 bands. - - - - - 16384 bands. - - - - - Used to apply a highpass-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - - - - Calculates all coefficients. - - - - - Used to apply a highshelf-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - Gain value in dB. - - - - Calculates all coefficients. - - - - - Used to apply a lowpass-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - - - - Calculates all coefficients. - - - - - Used to apply a lowshelf-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - Gain value in dB. - - - - Calculates all coefficients. - - - - - Used to apply a notch-filter to a signal. - - - - - Initializes a new instance of the class. - - The sample rate. - The filter's corner frequency. - - - - Calculates all coefficients. - - - - - Used to apply an peak-filter to a signal. - - - - - Gets or sets the bandwidth. - - - - - Initializes a new instance of the class. - - The sampleRate of the audio data to process. - The center frequency to adjust. - The bandWidth. - The gain value in dB. - - - - Calculates all coefficients. - - - - - Represents a channel conversion matrix. For more information, see - . - - - - - Defines a stereo to 5.1 surround (with rear) channel conversion matrix. - - - - - Defines a 5.1 surround (with rear) to stereo channel conversion matrix. - - - - - Defines a stereo to 5.1 surround (with side) channel conversion matrix. - - - - - Defines a 5.1 surround (with side) to stereo channel conversion matrix. - - - - - Defines a stereo to 7.1 surround channel conversion matrix. - - - - - Defines a 7.1 surround to stereo channel conversion matrix. - - - - - Defines a mono to 5.1 surround (with rear) channel conversion matrix. - - - - - Defines a 5.1 surround (with rear) to mono channel conversion matrix. - - - - - Defines a mono to 5.1 surround (with side) channel conversion matrix. - - - - - Defines a 5.1 surround (with side) to mono channel conversion matrix. - - - - - Defines a mono to 7.1 surround channel conversion matrix. - - - - - Defines a 7.1 surround channel to mono conversion matrix. - - - - - Defines a stereo to mono conversion matrix. - - - - - Defines a mono to stereo conversion matrix. - - - - - Defines a 5.1 surround (with rear) to 7.1 surround channel conversion matrix. - - - - - Defines a 7.1 surround to 5.1 surround (with rear) channel conversion matrix - - - - - Defines a 5.1 surround (with side) to 7.1 surround channel conversion matrix. - - - - - Defines a 7.1 surround to 5.1 surround (with side) channel conversion matrix - - - - - Gets a to convert between the two specified s. - - The of the input stream. - The desired of the output stream. - A to convert between the two specified s. - equals - No accurate was found. - - - - Gets a to convert between the two specified formats. - - The input waveformat. - The output waveformat. - A to convert between the two specified formats. - If no channelmask could be found, the return value is null. - - The channelmask of the input format equals the channelmask of the output format. - No accurate was found. - - - - Initializes a new instance of the class. - - The of the input signal. - The of the output signal. - Invalid /. - - - - Gets the of the input signal. - - - - - Gets the of the output signal. - - - - - Gets the number of rows of the channel conversion matrix. - - - - - Gets the number of columns of the channel conversion matrix. - - - - - Gets the input signals number of channels. - - - The property always returns the same value as the - property. - - - - - Gets the output signals number of channels. - - - The property always returns the same value as the - property. - - - - - Gets or sets a of the . - - The zero-based index of the input channel. - The zero-based index of the output channel. - The of the at the specified position. - - - - Sets the channel conversion matrix. - The x-axis of the specifies the output channels. The y-axis - of the specifies the input channels. - - Channel conversion matrix to use. - - - - Returns a one dimensional array which contains the channel conversion matrix coefficients. - - A one dimensional array which contains the channel conversion matrix coefficients - - This method is primarily used in combination with the - method. - - - - - Flips the axis of the matrix and returns the new matrix with the flipped axis. - - A matrix with flipped axis. - - This could be typically used in the following scenario: There is a - 5.1 to stereo matrix. By using the method the 5.1 to stereo matrix can be - converted into a stereo to 5.1 matrix. - - - - - Resampler based on the which can change the number of channels based on a - . Supported since Windows XP. - - - - - Initializes a new instance of the class. - - Underlying source which has to get resampled. - which defines how to map each channel. - - - - Initializes a new instance of the class. - - Underlying source which has to get resampled. - which defines how to map each channel. - Waveformat, which specifies the new format. Note, that by far not all formats are supported. - - source - or - channelMatrix - or - outputFormat - - The number of channels of the source has to be equal to the number of input channels specified by the channelMatrix. - - - - Initializes a new instance of the class. - - Underlying source which has to get resampled. - which defines how to map each channel. - The destination sample rate. - - - - Gets the channel matrix. - - If any changes to the channel matrix are made, use the method to commit them. - - - - Commits all channel-matrix-changes. - - - - - Resampler based on the DmoResampler. Supported since Windows XP. - - - - - Initializes a new instance of the class. - - which has to get resampled. - The new output samplerate specified in Hz. - - - - Initializes a new instance of the class. - - which has to get resampled. - Waveformat, which specifies the new format. Note, that by far not all formats are supported. - - - - Initializes a new instance of the class. - - which has to get resampled. - Waveformat, which specifies the new format. Note, that by far not all formats are supported. - - True to ignore the position of the for more accurate seeking. The default value is True. - For more details see remarks. - - Since the resampler transforms the audio data of the to a different samplerate, - the position might differ from the actual amount of read data. In order to avoid that behavior set - to True. This will cause the property to return the number of actually read bytes. - Note that seeking the won't have any effect on the of the . - - - - Gets the new output format. - - - - - Gets or sets the position of the source. - - - - - Gets the length of the source. - - - - - Specifies the quality of the output. The valid range is from 1 to 60. - - Specifies the quality of the resampled output. The valid range is: 1 >= value <= 60. - - - - Reads a resampled sequence of bytes from the and advances the position within the - stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Disposes the allocated resources of the resampler but does not dispose the underlying source. - - - - - Disposes the . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Provides a basic fluent API for creating a source chain. - - - - - Appends a source to an already existing source. - - Input - Output - Already existing source. - Function which appends the new source to the already existing source. - The return value of the delegate. - - - - Appends a source to an already existing source. - - Input - Output - Already existing source. - Function which appends the new source to the already existing source. - Receives the return value. - The return value of the delegate. - - - - Changes the SampleRate of an already existing wave source. - - Already existing wave source whose sample rate has to be changed. - Destination sample rate. - Wave source with the specified . - - - - Changes the SampleRate of an already existing sample source. Note: This extension has to convert the - to a and back to a . - - Already existing sample source whose sample rate has to be changed. - Destination sample rate. - Sample source with the specified . - - - - Converts the specified wave source with n channels to a wave source with two channels. - Note: If the has only one channel, the - extension has to convert the to a and back to a - . - - Already existing wave source. - instance with two channels. - - - - Converts the specified sample source with n channels to a wave source with two channels. - Note: If the has more than two channels, the - extension has to convert the to a - and back to a . - - Already existing sample source. - instance with two channels. - - - - Converts the specified wave source with n channels to a wave source with one channel. - Note: If the has two channels, the extension - has to convert the to a and back to a - . - - Already existing wave source. - instance with one channel. - - - - Converts the specified sample source with n channels to a wave source with one channel. - Note: If the has only one channel, the - extension has to convert the to a and back to a - . - - Already existing sample source. - instance with one channels - - - - Appends a new instance of the class to the audio chain. - - The underlying which should be looped. - The new instance instance. - - - - Converts a SampleSource to either a Pcm (8, 16, or 24 bit) or IeeeFloat (32 bit) WaveSource. - - Sample source to convert to a wave source. - Bits per sample. - Wave source - - - - Converts a to IeeeFloat (32bit) . - - The to convert to a . - The wrapped around the specified . - - - - Converts a to a . - - The to convert to a . - The wrapped around the specified . - - - - Returns a thread-safe (synchronized) wrapper around the specified object. - - The object to synchronize. - Type of the argument. - The type of the data read by the Read method of the method. - A thread-safe wrapper around the specified object. - The is null. - - - - Defines a generic base for all readable audio streams. - - The type of the provided audio data. - - - - Reads a sequence of elements from the and advances the position within the - stream by the - number of elements read. - - - An array of elements. When this method returns, the contains the specified - array of elements with the values between and ( + - - 1) replaced by the elements read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of elements to read from the current source. - The total number of elements read into the buffer. - - - - Provides the method. - - - - - Used to write down raw byte data. - - Byte array which contains the data to write down. - Zero-based offset in the . - Number of bytes to write. - - - - Defines the CLSID values for several common mediafoundation audio decoders. - - - - - CLSID_CMSDDPlusDecMFT - - - - - CLSID_CMSMPEGAudDecMFT - - - - - CMSAACDecMFT - - - - - CWMADecMediaObject - - - - - CALawDecMediaObject - - - - - ACM Wrapper - - - - - CWMAudioSpdTxDMO - - - - - CWMSPDecMediaObject - - - - - Wrapper - - - - - IMA ADPCM ACM Wrapper - - - - - CMP3DecMediaObject - - - - - ADPCM ACM Wrapper - - - - - see http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - The is a generic decoder for all installed Mediafoundation codecs. - - - - - Initializes a new instance of the class. - - Uri which points to an audio source which can be decoded. - - - - Initializes a new instance of the class. - - Stream which provides the audio data to decode. - - - - Initializes a new instance of the class. - - Stream which provides the audio data to decode. - - - - Reads a sequence of bytes from the and advances the position within the - stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Disposes the . - - - - - Gets the format of the decoded audio data provided by the method. - - - - - Gets or sets the position of the output stream, in bytes. - - - - - Gets the total length of the decoded audio, in bytes. - - - - - Gets a value which indicates whether the seeking is supported. True means that seeking is supported. False means - that seeking is not supported. - - - - - Disposes the and its internal resources. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Finalizes an instance of the class. - - - - - A generic encoder for all installed Mediafoundation-Encoders. - - - - - Creates an new instance of the class. - - Mediatype of the source to encode. - Stream which will be used to store the encoded data. - The format of the encoded data. - See container type. For a list of all available container types, see . - - - - Gets the total duration of all encoded data. - - - - - Gets the underlying stream which operates as encoding target. - - - - - Gets the media type of the encoded data. - - - - - Gets the which is used to write to the . - - - - - Gets the destination stream which is used to store the encoded audio data. - - - - - Releases all resources used by the encoder and finalizes encoding. - - - - - Encodes raw audio data. - - A byte-array which contains raw data to encode. - The zero-based byte offset in buffer at which to begin encoding bytes to the underlying stream. - The number of bytes to encode. - - - - Sets and initializes the targetstream for the encoding process. - - Stream which should be used as the targetstream. - Mediatype of the raw input data to encode. - Mediatype of the encoded data. - Container type which should be used. - - - - Disposes the . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Finalizes an instance of the class. - - - - - Encodes the whole with the specified . The encoding process - stops as soon as the method of the specified - returns 0. - - The encoder which should be used to encode the audio data. - The which provides the raw audio data to encode. - - - - Returns a new instance of the class, configured as mp3 encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The file to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as mp3 encoder. - - - - Returns a new instance of the class, configured as mp3 encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The stream to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as mp3 encoder. - - - - Returns a new instance of the class, configured as wma encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The file to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as wma encoder. - - - - Returns a new instance of the class, configured as wma encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The stream to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as wma encoder. - - - - Returns a new instance of the class, configured as aac encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The file to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as aac encoder. - - - - Returns a new instance of the class, configured as aac encoder. - - The input format, of the data to encode. - The bitrate to use. The final bitrate can differ from the specified value. - The stream to write to. - For more information about supported input and output formats, see . - A new instance of the class, configured as aac encoder. - - - - Tries to find the which fits best the requested format specified by the parameters: - , , and - . - - The audio subtype. For more information, see the class. - The requested sample rate. - The requested number of channels. - The requested bit rate. - - A which fits best the requested format. If no mediatype could be found the - method returns null. - - - - - Returns all s available for encoding the specified . - - The audio subtype to search available s for. - Available s for the specified . If the returns an empty array, no encoder for the specified was found. - - - - Enables the application to defer the creation of an object. This interface is exposed by activation objects. - - For more information, see . - - - - Initializes a new instance of the class. - - The underlying native pointer. - - - - Creates the object associated with this activation object. - - Interface identifier (IID) of the requested interface. - Receives a pointer to the requested interface. The caller must release the interface. - HRESULT - - - - Creates the object associated with this activation object. - - - - The type of the com object to create. - Interface identifier (IID) of the requested interface. - An instance of the requested interface. - - - - Creates the object associated with this activation object. - - Interface identifier (IID) of the requested interface. - A pointer to the requested interface. The caller must release the interface. - - - - Shuts down the created object. - - - HRESULT - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - HRESULT - - - - Detaches the created object from the activation object. - - - - - Gets the name of the MFT. - - - - - Gets the available input types. - - - - - Gets the available output types. - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The media subtype. - - - - - Represents a byte stream from some data source, which might be a local file, a network file, or some other source. The interface supports the typical stream operations, such as reading, writing, and seeking. - - - - - Gets the characteristics of the . - - - - - Gets or sets the length of the stream in bytes. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Initializes a new instance of the class which acts as a wrapper for the specified to use it in a media foundation context. - - The stream to wrap for media foundation usage. - A value indicating whether the should be closed when the - method is being called. - - - - Retrieves the characteristics of the byte stream. - - Receives a bitwise OR of zero or more flags. - HRESULT - Use the property for easier usage with automated error handling. - - - - Retrieves the length of the stream. - - Receives the length of the stream, in bytes. If the length is unknown, this value is -1. - HRESULT - Use the property for easier usage with automated error handling. - - - - Sets the length of the stream. - - The length of the stream in bytes. - HRESULT - Use the property for easier usage with automated error handling. - - - - Retrieves the current read or write position in the stream. - - The current position, in bytes. - HRESULT - - - - Sets the current read or write position. - - New position in the stream, as a byte offset from the start of the stream. - HRESULT - - - - Gets or sets the current read/write position in bytes. - - - - - Gets a value indicating whether the has reached the end of the stream. - - - - - Queries whether the current position has reached the end of the stream. - - Receives the value if the end of the stream has been reached, or otherwise. - HREUSLT - - - - Reads data from the stream. - - Pointer to a buffer that receives the data. The caller must allocate the buffer. - Size of the buffer in bytes. - Receives the number of bytes that are copied into the buffer. - HRESULT - - - - Reads data from the stream. - - The buffer that receives the data. - The number of bytes to read. - HRESULT - buffer is null. - count is bigger than the length of the buffer. - - - - Begins an asynchronous read operation from the stream. - - Pointer to a buffer that receives the data. The caller must allocate the buffer. - Size of the buffer in bytes. - Pointer to the IMFAsyncCallback interface of a callback object. The caller must implement this interface. - Pointer to the IUnknown interface of a state object, defined by the caller. Can be Zero. - HRESULT - - - - Completes an asynchronous read operation. - - Pointer to the IMFAsyncResult interface. Pass in the same pointer that your callback object received in the IMFAsyncCallback::Invoke method. - Receives the number of bytes that were read. - HRESULT - - - - Writes data to the stream. - - Pointer to a buffer that contains the data to write. - Size of the buffer in bytes. - Receives the number of bytes that are written. - HRESULT - - - - Writes data to the stream. - - Buffer that contains the data to write. - The number of bytes to write. - The number of bytes that were written. - buffer is null. - count is bigger than the length of the buffer. - - - - Begins an asynchronous write operation to the stream. - - Pointer to a buffer containing the data to write. - Size of the buffer in bytes. - Pointer to the IMFAsyncCallback interface of a callback object. The caller must implement this interface. - Pointer to the IUnknown interface of a state object, defined by the caller. Can be Zero. - HRESULT - - - - Completes an asynchronous write operation. - - Pointer to the IMFAsyncResult interface. Pass in the same pointer that your callback object received in the IMFAsyncCallback::Invoke method. - Receives the number of bytes that were written. - HRESULT - - - - Moves the current position in the stream by a specified offset. - - Specifies the origin of the seek as a member of the enumeration. The offset is calculated relative to this position. - Specifies the new position, as a byte offset from the seek origin. - Specifies whether all pending I/O requests are canceled after the seek request completes successfully. - Receives the new position after the seek. - The new position after the seek. - - - - Moves the current position in the stream by a specified offset. - - Specifies the origin of the seek as a member of the enumeration. The offset is calculated relative to this position. - Specifies the new position, as a byte offset from the seek origin. - Specifies whether all pending I/O requests are canceled after the seek request completes successfully. - The new position after the seek. - - - - Clears any internal buffers used by the stream. If you are writing to the stream, the buffered data is written to the underlying file or device. - - HRESULT - - - - Clears any internal buffers used by the stream. If you are writing to the stream, the buffered data is written to the underlying file or device. - - - - - Closes the stream and releases any resources associated with the stream, such as sockets or file handles. This method also cancels any pending asynchronous I/O requests. - - HRESULT - - - - Closes the stream and releases any resources associated with the stream, such as sockets or file handles. This method also cancels any pending asynchronous I/O requests. - - - - - Releases the COM object. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Defines the characteristics of a . - - - - - None - - - - - The byte stream can be read. - - - - - The byte stream can be written to. - - - - - The byte stream can be seeked. - - - - - The byte stream is from a remote source, such as a network. - - - - - The byte stream represents a file directory. - - - - - Seeking within this stream might be slow. For example, the byte stream might download from a network. - - - - - The byte stream is currently downloading data to a local cache. Read operations on the byte stream might take longer until the data is completely downloaded.This flag is cleared after all of the data has been downloaded. - If the flag is also set, it means the byte stream must download the entire file sequentially. Otherwise, the byte stream can respond to seek requests by restarting the download from a new point in the stream. - - - - - Another thread or process can open this byte stream for writing. If this flag is present, the length of the byte stream could change while it is being read. - - Requires Windows 7 or later. - - - - The byte stream is not currently using the network to receive the content. Networking hardware may enter a power saving state when this bit is set. - - Requires Windows 8 or later. - - - - Specifies the origin for a seek request. - - - - - The seek position is specified relative to the start of the stream. - - - - - The seek position is specified relative to the current read/write position in the stream. - - - - - Provides the functionality to enumerate Mediafoundation-Transforms. - - - - - Enumerates Mediafoundation-Transforms that match the specified search criteria. - - A that specifies the category of MFTs to enumerate. - For a list of MFT categories, see . - The bitwise OR of zero or more flags from the enumeration. - Specifies an input media type to match. This parameter can be null. If null, all input types are matched. - Specifies an output media type to match. This parameter can be null. If null, all output types are matched. - A that can be used to iterate through the MFTs. - - - - Enumerates Media Foundation transforms (MFTs) in the registry. - - A that specifies the category of MFTs to enumerate. - For a list of MFT categories, see . - Specifies an input media type to match. This parameter can be null. If null, all input types are matched. - Specifies an output media type to match. This parameter can be null. If null, all output types are matched. - An array of CLSIDs. For more information, see . - On Windows 7/Windows Server 2008 R2, use the method instead. - - - - Defines the characteristics of a media source. - - For more information, see . - - - - This flag indicates a data source that runs constantly, such as a live presentation. If the source is stopped and then restarted, there will be a gap in the content. - - - - - The media source supports seeking. - - - - - The source can pause. - - - - - The media source downloads content. It might take a long time to seek to parts of the content that have not been downloaded. - - - - - The media source delivers a playlist, which might contain more than one entry. - - Requires Windows 7 or later. - - - - The media source can skip forward in the playlist. Applies only if the flag is present. - - Requires Windows 7 or later. - - - - The media source can skip backward in the playlist. Applies only if the flag is present. - - Requires Windows 7 or later. - - - - The media source is not currently using the network to receive the content. Networking hardware may enter a power saving state when this bit is set. - - Requires Windows 8 or later. - - - - Defines common audio subtypes. - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - - - - - Dolby Audio Types - - - - - Dolby Audio Types - - - - - μ-law coding - - - - - Adaptive delta pulse code modulation (ADPCM) - - - - - Dolby Digital Plus formatted for HDMI output. - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - Currently no flags are defined. - - - - - None - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Stream index to selected all streams. - - - - - MF_SINK_WRITER_MEDIASINK constant. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Initializes a new instance of the class with a underlying . - - The underlying to use. - Attributes to configure the . For more information, see . Use null/nothing as the default value. - - - - Adds a stream to the sink writer. - - - The target mediatype which specifies the format of the samples that will be written to the file. It does not need to match the input format. To set the input format, call . - Receives the zero-based index of the new stream. - HRESULT - - - - Adds a stream to the sink writer. - - The target mediatype which specifies the format of the samples that will be written to the file. It does not need to match the input format. To set the input format, call . - The zero-based index of the new stream. - - - - Sets the input format for a stream on the sink writer. - - - The zero-based index of the stream. The index is returned by the method. - The input media type that specifies the input format. - An attribute store. Use the attribute store to configure the encoder. This parameter can be NULL. - HRESULT - - - - Sets the input format for a stream on the sink writer. - - The zero-based index of the stream. The index is returned by the method. - The input media type that specifies the input format. - An attribute store. Use the attribute store to configure the encoder. This parameter can be NULL. - - - - Initializes the sink writer for writing. - - - HRESULT - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - The zero-based index of the stream for this sample. - The sample to write. - HRESULT - You must call before calling this method. - - - - Delivers a sample to the sink writer. - - The zero-based index of the stream for this sample. - The sample to write. - You must call before calling this method. - - - - Indicates a gap in an input stream. - - - The zero-based index of the stream. - The position in the stream where the gap in the data occurs. The value is given in 100-nanosecond units, relative to the start of the stream. - HRESULT - - - - Indicates a gap in an input stream. - - The zero-based index of the stream. - The position in the stream where the gap in the data occurs. The value is given in 100-nanosecond units, relative to the start of the stream. - - - - Places a marker in the specified stream. - - - The zero-based index of the stream. - Pointer to an application-defined value. The value of this parameter is returned to the caller in the pvContext parameter of the caller's IMFSinkWriterCallback::OnMarker callback method. The application is responsible for any memory allocation associated with this data. This parameter can be NULL. - HRESULT - - - - Places a marker in the specified stream. - - The zero-based index of the stream. - Pointer to an application-defined value. The value of this parameter is returned to the caller in the pvContext parameter of the caller's IMFSinkWriterCallback::OnMarker callback method. The application is responsible for any memory allocation associated with this data. This parameter can be NULL. - - - - Notifies the media sink that a stream has reached the end of a segment. - - - The zero-based index of a stream, or to signal that all streams have reached the end of a segment. - HRESULT - - - - Notifies the media sink that a stream has reached the end of a segment. - - The zero-based index of a stream, or to signal that all streams have reached the end of a segment. - - - - Flushes one or more streams. - - - The zero-based index of the stream to flush, or to flush all of the streams. - HRESULT - - - - Flushes one or more streams. - - The zero-based index of the stream to flush, or to flush all of the streams. - - - - Completes all writing operations on the sink writer. - - - HRESULT - - - - Completes all writing operations on the sink writer. - - Renamed from 'Finalize' to 'FinalizeWriting' to suppress "CS0465 warning". - - - - Queries the underlying media sink or encoder for an interface. - - - The zero-based index of a stream to query, or to query the media sink itself. - A service identifier GUID, or . If the value is , the method calls QueryInterface to get the requested interface. Otherwise, the method calls IMFGetService::GetService. - For a list of service identifiers, see . - The interface identifier (IID) of the interface being requested. - Receives a pointer to the requested interface. The caller must release the interface. - HRESULT - - - - Queries the underlying media sink or encoder for an interface. - - The zero-based index of a stream to query, or to query the media sink itself. - A service identifier GUID, or . If the value is , the method calls QueryInterface to get the requested interface. Otherwise, the method calls IMFGetService::GetService. - For a list of service identifiers, see . - The interface identifier (IID) of the interface being requested. - A pointer to the requested interface. The caller must release the interface. - - - - Gets statistics about the performance of the sink writer. - - The zero-based index of a stream to query, or to query the media sink itself. - Receives statistics about the performance of the sink writer. - HRESULT - - - - Gets statistics about the performance of the sink writer. - - The zero-based index of a stream to query, or to query the media sink itself. - Statistics about the performance of the sink writer. - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. The sink writer updates this value each time the application calls . - - - - - The time stamp of the most recent sample to be encoded. The sink writer updates this value whenever it calls IMFTransform::ProcessOutput on the encoder. - - - - - The time stamp of the most recent sample given to the media sink. The sink writer updates this value whenever it calls IMFStreamSink::ProcessSample on the media sink. - - - - - The time stamp of the most recent stream tick. The sink writer updates this value whenever the application calls . - - - - - The system time of the most recent sample request from the media sink. The sink writer updates this value whenever it receives an MEStreamSinkRequestSample event from the media sink. The value is the current system time. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Defines flags that indicate the status of the method. - - - - - None - - - - - An error occurred. If you receive this flag, do not make any further calls to - methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created. - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media - source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the - method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. This could be due to a - dynamic format change from a source or decoder that prevents custom transforms from being used because they cannot - handle the new media type. - - - - - Defines categories for Media Foundation transforms (MFTs). These categories are used to register and enumerate MFTs. - - For more information, see . - - - - Audio decoders. - - - - - Audio encoders. - - - - - Audio effects. - - - - - Video encoders. - - - - - Video decoders. - - - - - Video effects. - - - - - Video processors. - - - - - Demultiplexers. - - - - - Multiplexers. - - - - - Miscellaneous MFTs. - - - - - Defines flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - This flag does not apply to hardware transforms. - - - - - The MFT performs asynchronous data processing in software. See . - This flag does not apply to hardware transforms. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. MFTs in this category always process data asynchronously. - See . - - - - - Must be unlocked by the app before use. For more information, see . - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. For more information, see . - - - - - Bitwise OR of all the flags, excluding . - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The media subtype. - - - - - Defines flags for the method. - - - - - None - - - - - Retrieve any pending samples, but do not request any more samples from the media source. To get all of the pending samples, call with this flag until the method returns a NULL media sample pointer. - - - - - Defines the GUIDs for different types of container formats. - - - - - MPEG2 - - - - - ADTS - - - - - AC3 - - - - - 3GP - - - - - MP3 - - - - - MPEG4 - - - - - ASF - - - - - FMPEG4 - - - - - AMR - - - - - WAVE - - - - - AVI - - - - - Mediafoundation COM Exception - - - - - Initializes a new instance of the class. - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - - The StreamingContext object that supplies the contextual information about the source or - destination. - - - - - Throws an if the is not - . - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Indicates the degree of similarity between the two media types. - - - - - None - - - - - The major types are the same. - - - - - The subtypes are the same, or neither media type has a subtype. - - - - - The attributes in one of the media types are a subset of the attributes in the other, and the values of these - attributes match, excluding the value of the MF_MT_USER_DATA, MF_MT_FRAME_RATE_RANGE_MIN, and - MF_MT_FRAME_RATE_RANGE_MAX attributes. - - - - - The user data is identical, or neither media type contains user data. User data is specified by the MF_MT_USER_DATA - attribute. - - - - - Represents a MediaFoundation-attribute. - - The type of the value of the - - - - Gets the key of the attribute. - - - - - Gets the value of the attribute. - - - - - Initializes a new instance of the class. - - The key. - The value. - - - - Specifies how to compare the attributes on two objects. - - - - - Check whether all the attributes in pThis exist in pTheirs and have the same data, where pThis is the object whose - method is being called and pTheirs is the object given in the pTheirs - parameter. - - - - - Check whether all the attributes in pTheirs exist in pThis and have the same data, where pThis is the object whose - method is being called and pTheirs is the object given in the pTheirs - parameter. - - - - - Check whether both objects have identical attributes with the same data. - - - - - Check whether the attributes that exist in both objects have the same data. - - - - - Find the object with the fewest number of attributes, and check if those attributes exist in the other object and - have the same data. - - - - - Provides a generic way to store key/value pairs on an object. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a initial size. - - The initial size in bytes. - - - - Gets or sets an item specified by its index. - - The index of the item. - - - - Gets or sets an item specified by its key. - - The key of the item. - - - - Gets the number of attributes that are set on this object. - - - - - Retrieves the value associated with a key. - - A that identifies which value to retrieve. - A pointer to a that receives the value. - HRESULT - - For more information, see - . - - - - - Retrieves the value associated with a key. - - A that identifies which value to retrieve. - A that receives the value. - - For more information, see - . - - - - - Retrieves the data type of the value associated with a key. - - that identifies which value to query. - The type of the item, associated with the specified . - HRESULT - - For more information, see - . - - - - - Retrieves the data type of the value associated with a key. - - that identifies which value to query. - The type of the item, associated with the specified . - - For more information, see - . - - - - - Queries whether a stored attribute value equals a specified . - - that identifies which value to query. - that contains the value to compare. - - Receives a boolean value indicating whether the attribute matches the value given in - . - - HRESULT - - For more information, see - . - - - - - Queries whether a stored attribute value equals a specified . - - that identifies which value to query. - that contains the value to compare. - A boolean value indicating whether the attribute matches the value given in . - - For more information, see - . - - - - - Compares the attributes on this object with the attributes on another object. - - The interface of the object to compare with this object. - A value, specifying the type of comparison to make. - - Receives a Boolean value. The value is if the two sets of - attributes match in the way specified by the parameter. Otherwise, the value is - . - - HRESULT - - - - Compares the attributes on this object with the attributes on another object. - - The interface of the object to compare with this object. - A value, specifying the type of comparison to make. - - Returns true if the two sets of attributes match in the way specified by the - parameter; otherwise, false. - - - - - Retrieves a UINT32 value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - Receives a UINT32 value. If the key is found and the data type is , the method - copies the - value into this parameter. - - HRESULT - - - - Retrieves a UINT32 value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , the method returns the - associated value. - - - - - Retrieves a UINT64 value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - Receives a UINT64 value. If the key is found and the data type is , the method - copies the - value into this parameter. - - HRESULT - - - - Retrieves a UINT64 value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , the method returns the - associated value. - - - - - Retrieves a Double value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - Receives a Double value. If the key is found and the data type is , the method - copies the - value into this parameter. - - HRESULT - - - - Retrieves a Double value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , the method returns the - associated value. - - - - - Retrieves a Guid value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - Receives a Guid value. If the key is found and the data type is , the method - copies the - value into this parameter. - - HRESULT - - - - Retrieves a Guid value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , the method returns the - associated value. - - - - - Retrieves the length of a string value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , - this parameter receives the number of characters in the string, not including the terminating NULL character. - - HRESULT - - - - Retrieves the length of a string value associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - If the key is found and the data type is , - this method returns the number of characters in the string, not including the terminating NULL character. - - - - Retrieves a wide-character string associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - Pointer to a wide-character array allocated by the caller. - The array must be large enough to hold the string, including the terminating NULL character. - If the key is found and the value is a string type, the method copies the string into this buffer. - To find the length of the string, call . - - The size of the pwszValue array, in characters. This value includes the terminating NULL character. - Receives the number of characters in the string, excluding the terminating NULL character. This parameter can be NULL. - HRESULT - - - - Retrieves a wide-character string associated with a key. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the data type is , the method returns the - associated value. - - - - - Retrieves a wide-character string associated with a key. This method allocates the - memory for the string. - - - that identifies which value to retrieve. The attribute type must be - . - - - If the key is found and the value is a string type, this parameter receives a copy of the string. The caller must free the memory for the string by calling . - - - Receives the number of characters in the string, excluding the terminating NULL character. - HRESULT - - Don't use the method. Use the method instead. - - - - - Retrieves the length of a byte array associated with a key. - - that identifies which value to retrieve. The attribute type must be . - If the key is found and the value is a byte array, this parameter receives the size of the array, in bytes. - HRESULT - - - - Retrieves the length of a byte array associated with a key. - - that identifies which value to retrieve. The attribute type must be . - If the key is found and the value is a byte array, this method returns the size of the array, in bytes. - - - - Retrieves a byte array associated with a key. - - that identifies which value to retrieve. The attribute type must be . - Pointer to a buffer allocated by the caller. If the key is found and the value is a byte array, the method copies the array into this buffer. To find the required size of the buffer, call . - The size of the buffer, in bytes. - Receives the size of the byte array. This parameter can be . - HRESULT - - - - Retrieves a byte array associated with a key. - - that identifies which value to retrieve. The attribute type must be . - The byte array associated with the . - - - - Retrieves an object associated with a key. - - that identifies which value to retrieve. The attribute type must be . - The type of the object (type of the returned object -> see return value). - The object associated with the . - Type is null. - Internally this method retrieves a byte-array with gets converted to a instance of the specified . - - - - Retrieves a byte array associated with a key. - - that identifies which value to retrieve. The attribute type must be . - If the key is found and the value is a byte array, this parameter receives a copy of the array. - Receives the size of the array, in bytes. - HRESULT - - Obsolete, use the method instead. - - - - - Retrieves an interface pointer associated with a key. - - that identifies which value to retrieve. The attribute type must be . - Interface identifier (IID) of the interface to retrieve. - Receives a pointer to the requested interface. The caller must release the interface. - HRESULT - - - - Associates an attribute value with a key. - - A that identifies the value to set. If this key already exists, the method overwrites the old value. - A that contains the attribute value. The method copies the value. The type must be one of the types listed in the enumeration. - HRESULT - - - - Associates an attribute value with a key. - - A that identifies the value to set. If this key already exists, the method overwrites the old value. - A that contains the attribute value. The method copies the value. The type must be one of the types listed in the enumeration. - - - - Removes a key/value pair from the object's attribute list. - - that identifies the value to delete. - HRESULT - - - - Removes a key/value pair from the object's attribute list. - - that identifies the value to delete. - - - - Removes all key/value pairs from the object's attribute list. - - HRESULT - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - HRESULT - - - - Associates a UINT32 value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - - - - Associates a UINT64 value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - HRESULT - - - - Associates a UINT64 value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - - - - Associates a Double value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - HRESULT - - - - Associates a Double value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - - - - Associates a value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - HRESULT - - - - Associates a value with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - - - - Associates a wide-character string with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - HRESULT - Internally this method stores a copy of the string specified by the parameter. - - - - Associates a wide-character string with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - New value for this key. - Internally this method stores a copy of the string specified by the parameter. - - - - Associates a byte array with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - Pointer to a byte array to associate with this key. The method stores a copy of the array. - Size of the array, in bytes. - HRESULT - - - - Associates a byte array with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - The byte array to associate with the - - - - Associates an IUnknown pointer with a key. - - that identifies the value to set. If this key already exists, the method overwrites the old value. - IUnknown pointer to be associated with this key. - HRESULT - - - - Locks the attribute store so that no other thread can access it. If the attribute store is already locked by another thread, this method blocks until the other thread unlocks the object. After calling this method, call to unlock the object. - - HRESULT - - - - Locks the attribute store so that no other thread can access it. If the attribute store is already locked by another thread, this method blocks until the other thread unlocks the object. After calling this method, call to unlock the object. - - - - - Unlocks the attribute store after a call to the method. While the object is unlocked, multiple threads can access the object's attributes. - - HRESULT - - - - Unlocks the attribute store after a call to the method. While the object is unlocked, multiple threads can access the object's attributes. - - - - - Retrieves the number of attributes that are set on this object. - - Receives the number of attributes. - HRESULT - - - - Retrieves the number of attributes that are set on this object. - - Returns the number of attributes. - - - - Retrieves an attribute at the specified index. - - Index of the attribute to retrieve. To get the number of attributes, call . - Receives the that identifies this attribute. - Pointer to a that receives the value. This parameter can be . If it is not , the method fills the with a copy of the attribute value. Call to free the memory allocated by this method. - HRESULT - - - - Retrieves an attribute at the specified index. - - Index of the attribute to retrieve. To get the number of attributes, call . - Receives the that identifies this attribute. - Returns the value of the attribute specified by the . - - - - Copies all of the attributes from this object into another attribute store. - - The attribute store that recevies the copy. - HRESULT - - - - Copies all of the attributes from this object into another attribute store. - - The attribute store that recevies the copy. - - - - Determines whether the attribute store contains an attribute with the specified . - - The key of the attribute. - True if the attribute exists; otherwise, false - An unexpected error occurred. - - - - Gets the item which got associated with the specified . - - The key of the item. - The item which got associated with the specified . - The value type of the associated item is not supported. - - - - Gets the item which got associated with the specified . - - The key of the item. - Type of the returned item. - The item which got associated with the specified . - The specified is not supported. - - - - Sets the value of a property specified by its . - - The key of the property. - The value to set. - The type of the property. - The specified is not supported. - - - - Sets the value of a property specified by the key of the object. - - The type of the property. - Specifies the key of the property and the new value to set. - - - - Defines data types for key/value pairs. - - - - - Unsigned 32-bit integer. - - - - - Unsigned 64-bit integer. - - - - - Floating-point number. - - - - - value. - - - - - Wide-character string. - - - - - Byte array. - - - - - IUnknown pointer. - - - - - Represents a block of memory that contains media data. Use this interface to access the data in the buffer. - - - - - Gets or sets the length of the valid data, in bytes. If the buffer does not contain any valid data, the value is zero. - - - - - Gets the allocated size of the buffer, in bytes. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Initializes a new instance of the class with the specified maximum . - - The size of the in bytes. The specified will be the of the constructed . - The caller needs to release the allocated memory by disposing the . - - - - Gives the caller access to the memory in the buffer, for reading or writing. - - Receives a pointer to the start of the buffer. - Receives the maximum amount of data that can be written to the buffer. The same value is returned by the method. - Receives the length of the valid data in the buffer, in bytes. The same value is returned by the method. - HRESULT - When you are done accessing the buffer, call to unlock the buffer. You must call once for each call to . - - - - Gives the caller access to the memory in the buffer, for reading or writing. - - Receives the maximum amount of data that can be written to the buffer. The same value is returned by the method. - Receives the length of the valid data in the buffer, in bytes. The same value is returned by the method. - A pointer to the start of the buffer. - When you are done accessing the buffer, call to unlock the buffer. You must call once for each call to . - - - - Gives the caller access to the memory in the buffer, for reading or writing. - - A disposable object which provides the information returned by the method. Call its method to unlock the . - - This example shows how to use the method: - - partial class TestClass - { - public void DoStuff(MFMediaBuffer mediaBuffer) - { - using(var lock = mediaBuffer.Lock()) - { - //do some stuff - } - //the mediaBuffer gets automatically unlocked by the using statement after "doing your stuff" - } - } - - - - - - Unlocks a buffer that was previously locked. Call this method once for every call to . - - HRESULT - - - - Unlocks a buffer that was previously locked. Call this method once for every call to . - - - - - Retrieves the length of the valid data in the buffer. - - - Receives the length of the valid data, in bytes. If the buffer does not contain any valid data, the value is zero. - HRESULT - - - - Retrieves the length of the valid data in the buffer. - - - The length of the valid data, in bytes. If the buffer does not contain any valid data, the value is zero. - - - - Sets the length of the valid data in the buffer. - - - Length of the valid data, in bytes. This value cannot be greater than the allocated size of the buffer, which is returned by the method. - HRESULT - - - - Sets the length of the valid data in the buffer. - - - Length of the valid data, in bytes. This value cannot be greater than the allocated size of the buffer, which is returned by the method. - - - - Retrieves the allocated size of the buffer. - - - Receives the allocated size of the buffer, in bytes. - HRESULT - - - - Retrieves the allocated size of the buffer. - - - The allocated size of the buffer, in bytes. - - - - Used to unlock a after locking it by calling the method. - - - - - Gets a pointer to the start of the buffer. - - - - - Gets the maximum amount of data that can be written to the buffer. - - - - - Gets the length of the valid data in the buffer, in bytes. - - - - - Unlocks the locked . - - - - - Represents a description of a media format. - - - - - Creates an empty . - - Returns an empty . - - - - Creates a new based on a specified . - - which should be "converted" to a . - Returns a new . - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Gets or sets the number of channels. - - - - - Gets or sets the number of bits per sample. - - - - - Gets or sets the number of samples per second (for one channel each). - - - - - Gets or sets the channelmask. - - - - - Gets or sets the average number of bytes per second. - - - - - Gets or sets the audio subtype. - - - - - Gets or sets the major type. - - - - - Gets a value, indicating whether the media type is a temporally compressed format. - Temporal compression uses information from previously decoded samples when - decompressing the current sample. - - - - - Gets the major type of the format. - - Receives the major type . - The major type describes the broad category of the format, such as audio or video. For a list of possible values, see . - HRESULT - - - - Gets the major type of the format. - - The major type . The major type describes the broad category of the format, such as audio or video. For a list of possible values, see . - - - - Queries whether the media type is a temporally compressed format. Temporal compression - uses information from previously decoded samples when decompressing the current sample. - - Receives a Boolean value. The value is TRUE if the format uses temporal compression, or FALSE if the format does not use temporal compression. - HRESULT - - - - Queries whether the media type is a temporally compressed format. Temporal compression - uses information from previously decoded samples when decompressing the current sample. - - if the format uses temporal compression. if the format does not use temporal compression. - - - - Compares two media types and determines whether they are identical. If they are not - identical, the method indicates how the two formats differ. - - The to compare. - Receives a bitwise OR of zero or more flags, indicating the degree of similarity between the two media types. - HRESULT - - - - Compares two media types and determines whether they are identical. If they are not - identical, the method indicates how the two formats differ. - - The to compare. - A bitwise OR of zero or more flags, indicating the degree of similarity between the two media types. - - - - Retrieves an alternative representation of the media type. Currently only the DirectShow - AM_MEDIA_TYPE structure is supported. - - that specifies the representation to retrieve. The following values are defined. - Receives a pointer to a structure that contains the representation. The method allocates the memory for the structure. The caller must release the memory by calling . - HRESULT - For more information, see . - - - - Retrieves an alternative representation of the media type. Currently only the DirectShow - AM_MEDIA_TYPE structure is supported. - - that specifies the representation to retrieve. The following values are defined. - A pointer to a structure that contains the representation. The method allocates the memory for the structure. The caller must release the memory by calling . - For more information, see . - - - - Frees memory that was allocated by the method. - - that was passed to the method. - Pointer to the buffer that was returned by the method. - HRESULT - For more information, see . - - - - Frees memory that was allocated by the method. - - that was passed to the method. - Pointer to the buffer that was returned by the method. - For more information, see . - - - - Converts the to a . - - Contains a flag from the enumeration. - The which got created based on the . - - - - Represents a media sample, which is a container object for media data. For video, a sample typically contains one video frame. For audio data, a sample typically contains multiple audio samples, rather than a single sample of audio. - - - - - Initializes a new instance of the class. - - Calls the MFCreateSample function. - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Currently no flags are defined. Instead, metadata for samples is defined using - attributes. To get attibutes from a sample, use the object, which - inherits. - - Receives the value . - HRESULT - - - - Currently no flags are defined. Instead, metadata for samples is defined using - attributes. To get attibutes from a sample, use the object, which - inherits. - - Returns the . - - - - Currently no flags are defined. Instead, metadata for samples is defined using - attributes. To set attibutes on a sample, use the object, which - IMFSample inherits. - - Must be . - HRESULT - - - - Currently no flags are defined. Instead, metadata for samples is defined using - attributes. To set attibutes on a sample, use the object, which - IMFSample inherits. - - Must be . - - - - Retrieves the presentation time of the sample. - - Presentation time, in 100-nanosecond units. - HRESULT - - - - Retrieves the presentation time of the sample. - - Presentation time, in 100-nanosecond units. - - - - Sets the presentation time of the sample. - - The presentation time, in 100-nanosecond units. - HRESULT - - - - Sets the presentation time of the sample. - - The presentation time, in 100-nanosecond units. - - - - Retrieves the presentation time of the sample. - - Receives the presentation time, in 100-nanosecond units. - HRESULT - - - - Retrieves the presentation time of the sample. - - The presentation time, in 100-nanosecond units. - - - - Sets the duration of the sample. - - Duration of the sample, in 100-nanosecond units. - HRESULT - - - - Sets the duration of the sample. - - Duration of the sample, in 100-nanosecond units. - - - - Retrieves the number of buffers in the sample. - - Receives the number of buffers in the sample. A sample might contain zero buffers. - HRESULT - - - - Retrieves the number of buffers in the sample. - - The number of buffers in the sample. A sample might contain zero buffers. - - - - Gets a buffer from the sample, by index. - - Index of the buffer. To find the number of buffers in the sample, call . Buffers are indexed from zero. - Receives the instance. The caller must release the object. - HRESULT - - Note: In most cases, it is safer to use the method. - If the sample contains more than one buffer, the method replaces them with a single buffer, copies the original data into that buffer, and returns the new buffer to the caller. - The copy operation occurs at most once. On subsequent calls, no data is copied. - - - - - Gets a buffer from the sample, by index. - - Index of the buffer. To find the number of buffers in the sample, call . Buffers are indexed from zero. - The instance. The caller must release the object. - - Note: In most cases, it is safer to use the method. - If the sample contains more than one buffer, the method replaces them with a single buffer, copies the original data into that buffer, and returns the new buffer to the caller. - The copy operation occurs at most once. On subsequent calls, no data is copied. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - Receives a instance. The caller must release the instance. - HRESULT - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - A instance. The caller must release the instance. - - - - Adds a buffer to the end of the list of buffers in the sample. - - The to add. - HRESULT - - - - Adds a buffer to the end of the list of buffers in the sample. - - The to add. - - - - Removes a buffer at a specified index from the sample. - - Index of the buffer. To find the number of buffers in the sample, call . Buffers are indexed from zero. - HRESULT - - - - Removes a buffer at a specified index from the sample. - - Index of the buffer. To find the number of buffers in the sample, call . Buffers are indexed from zero. - - - - Removes all of the buffers from the sample. - - HRESULT - - - - Removes all of the buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. The length is calculated as the sum of the values retrieved by the method. - - Receives the total length of the valid data, in bytes. - HRESULT - - - - Retrieves the total length of the valid data in all of the buffers in the sample. The length is calculated as the sum of the values retrieved by the method. - - The total length of the valid data, in bytes. - - - - Copies the sample data to a buffer. This method concatenates the valid data from all of the buffers of the sample, in order. - - The object of the destination buffer. - The buffer must be large enough to hold the valid data in the sample. - To get the size of the data in the sample, call . - HRESULT - - - - Copies the sample data to a buffer. This method concatenates the valid data from all of the buffers of the sample, in order. - - The object of the destination buffer. - The buffer must be large enough to hold the valid data in the sample. - To get the size of the data in the sample, call . - - - - Implemented by the Microsoft Media Foundation source reader object. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Initializes a new instance of the class based on a given . - - The URL. - - - - Gets a value indicating whether this instance can seek. - - - true if this instance can seek; otherwise, false. - - - - - Gets the media source characteristics. - - - The media source characteristics. - - - - - Queries whether a stream is selected. - - The stream to query. For more information, see . - Receives if the stream is selected and will generate data. Receives if the stream is not selected and will not generate data. - HRESULT - - - - Queries whether a stream is selected. - - The stream to query. For more information, see . - if the stream is selected and will generate data; if the stream is not selected and will not generate data. - - - - Selects or deselects one or more streams. - - The stream to set. For more information, see . - Specify to select streams or to deselect streams. If a stream is deselected, it will not generate data. - HRESULT - - - - Selects or deselects one or more streams. - - The stream to set. For more information, see . - Specify to select streams or to deselect streams. If a stream is deselected, it will not generate data. - - - - Gets a format that is supported natively by the media source. - - Specifies which stream to query. For more information, see . - The zero-based index of the media type to retrieve. - Receives the . The caller must dispose the object. - HRESULT - - - - Gets a format that is supported natively by the media source. - - Specifies which stream to query. For more information, see . - The zero-based index of the media type to retrieve. - The . The caller must dispose the . - - - - Gets the current media type for a stream. - - Specifies which stream to query. For more information, see . - Receives the . The caller must dispose the . - HRESULT - - - - Gets the current media type for a stream. - - Specifies which stream to query. For more information, see . - The . The caller must dispose the . - - - - Sets the media type for a stream. - This media type defines the format that the produces as output. It can differ from the native format provided by the media source. See Remarks for more information. - - The stream to configure. For more information, see . - Reserved. Set to . - The media type to set. - HRESULT - - - - Sets the media type for a stream. - This media type defines the format that the produces as output. It can differ from the native format provided by the media source. See Remarks for more information. - - The stream to configure. For more information, see . - The media type to set. - - - - Seeks to a new position in the media source. - - A GUID that specifies the time format. The time format defines the units for the varPosition parameter. Pass for "100-nanosecond units". Some media sources might support additional values. - The position from which playback will be started. The units are specified by the parameter. If the parameter is , set the variant type to . - HRESULT - - - - Seeks to a new position in the media source. - - A GUID that specifies the time format. The time format defines the units for the varPosition parameter. Pass for "100-nanosecond units". Some media sources might support additional values. - The position from which playback will be started. The units are specified by the parameter. If the parameter is , set the variant type to . - - - - Reads the next sample from the media source. - - Index of the stream.The stream to pull data from. For more information, see . - A bitwise OR of zero or more flags from the enumeration. - Receives the zero-based index of the stream. - Receives a bitwise OR of zero or more flags from the enumeration. - Receives the time stamp of the sample, or the time of the stream event indicated in . The time is given in 100-nanosecond units. - Receives the instance or null. If this parameter receives a non-null value, the caller must release the received . - - HRESULT - - - - - Reads the next sample from the media source. - - Index of the stream.The stream to pull data from. For more information, see . - A bitwise OR of zero or more flags from the enumeration. - Receives the zero-based index of the stream. - Receives a bitwise OR of zero or more flags from the enumeration. - Receives the time stamp of the sample, or the time of the stream event indicated in . The time is given in 100-nanosecond units. - The instance or null. If this parameter receives a non-null value, the caller must release the received . - - - - Flushes one or more streams. - - The stream to flush. For more information, see . - HRESULT - - - - Flushes one or more streams. - - The stream to flush. For more information, see . - - - - Queries the underlying media source or decoder for an interface. - - The stream or object to query. For more information, see . - A service identifier . If the value is , the method calls QueryInterface to get the requested interface. Otherwise, the method calls the IMFGetService::GetService method. For a list of service identifiers, see . - The interface identifier (IID) of the interface being requested. - Receives a pointer to the requested interface. The caller must release the interface. - - HRESULT - - - - - Queries the underlying media source or decoder for an interface. - - The stream or object to query. For more information, see . - A service identifier . If the value is , the method calls QueryInterface to get the requested interface. Otherwise, the method calls the IMFGetService::GetService method. For a list of service identifiers, see . - The interface identifier (IID) of the interface being requested. - A pointer to the requested interface. The caller must release the interface. - - - - Gets an attribute from the underlying media source. - - The stream or object to query. For more information, see . - A that identifies the attribute to retrieve. For more information, see . - Receives a that receives the value of the attribute. Call the method to free the . - HRESULT - - - - Gets an attribute from the underlying media source. - - The stream or object to query. For more information, see . - A that identifies the attribute to retrieve. For more information, see . - A that receives the value of the attribute. Call the method to free the . - - - - Defines flags that specify how to convert an audio media type. - - - - - Convert the media type to a class if possible, or a class otherwise. - - - - - Convert the media type to a class.. - - - - - Defines multi media error codes. - - - - - No error. - - - - - Unspecified error. - - - - - Invalid device id. - - - - - Driver failed enable. - - - - - Device already allocated. - - - - - Device handle is invalid. - - - - - No device driver present. - - - - - Memory allocation error. - - - - - Function isn't supported. - - - - - Error value out of range. - - - - - Invalid flag passed. - - - - - Invalid parameter passed. - - - - - Handle being used simultaneously on another thread (eg callback). - - - - - Specified alias not found. - - - - - Bad registry database. - - - - - Registry key not found. - - - - - Registry read error. - - - - - Registry write error. - - - - - Registry delete error. - - - - - Registry value not found. - - - - - Driver does not call DriverCallback. - - - - - More data to be returned. - - - - - Unsupported wave format. - - - - - Still something playing. - - - - - Header not prepared. - - - - - Device is synchronous. - - - - - Defines the states of a . - - - - - The is currently recording. - - - - - The is currently stopped. - - - - - Provides data for the event. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The associated exception. Can be null. - - - - Captures audio data from a audio device (through Wasapi Apis). To capture audio from an output device, use the class. - Minimum supported OS: Windows Vista (see property). - - - - - Gets a value indicating whether the class is supported on the current platform. - If true, it is supported; otherwise false. - - - - - Reference time units per millisecond. - - - - - Reference time units per second. - - - - - Occurs when new data got captured and is available. - - - - - Occurs when stopped capturing audio. - - - - - Initializes a new instance of the class. - CaptureThreadPriority = AboveNormal. - DefaultFormat = null. - Latency = 100ms. - EventSync = true. - SharedMode = Shared. - - - - - Initializes a new instance of the class. - CaptureThreadPriority = AboveNormal. - DefaultFormat = null. - Latency = 100ms. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. Don't use this in combination with exclusive mode. - Specifies how to open the audio device. Note that if exclusive mode is used, the device can only be used once on the whole system. Don't use exclusive mode in combination with eventSync. - - - - Initializes a new instance of the class. - CaptureThreadPriority = AboveNormal. - DefaultFormat = null. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. Don't use this in combination with exclusive mode. - Specifies how to open the audio device. Note that if exclusive mode is used, the device can only be used once on the whole system. Don't use exclusive mode in combination with eventSync. - Latency of the capture specified in milliseconds. - - - - Initializes a new instance of the class. - CaptureThreadPriority = AboveNormal. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. Don't use this in combination with exclusive mode. - Specifies how to open the audio device. Note that if exclusive mode is used, the device can only be used once on the whole system. Don't use exclusive mode in combination with eventSync. - Latency of the capture specified in milliseconds. - The default WaveFormat to use for the capture. If this parameter is set to null, the best available format will be chosen automatically. - - - - Initializes a new instance of the class. SynchronizationContext = null. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. Don't use this in combination with exclusive mode. - Specifies how to open the audio device. Note that if exclusive mode is used, the device can only be used once on the whole system. Don't use exclusive mode in combination with eventSync. - Latency of the capture specified in milliseconds. - ThreadPriority of the capturethread which runs in background and provides the audiocapture itself. - The default WaveFormat to use for the capture. If this parameter is set to null, the best available format will be chosen automatically. - - - - Initializes a new instance of the class. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. Don't use this in combination with exclusive mode. - Specifies how to open the audio device. Note that if exclusive mode is used, the device can only be used once on the whole system. Don't use exclusive mode in combination with eventSync. - Latency of the capture specified in milliseconds. - ThreadPriority of the capturethread which runs in background and provides the audiocapture itself. - The default WaveFormat to use for the capture. If this parameter is set to null, the best available format will be chosen automatically. - The to use to fire events on. - The current platform does not support Wasapi. For more details see: . - The parameter is set to true while the is set to . - - - - Initializes WasapiCapture and prepares all resources for recording. - Note that properties like Device, etc. won't affect WasapiCapture after calling Initialize. - - - - - Start recording. - - - - - Stop recording. - - - - - Gets the RecordingState. - - - - - Gets or sets the capture device to use. - Set this property before calling Initialize. - - - - - Gets the OutputFormat. - - - - - Random ID based on internal audioclients memory address for debugging purposes. - - - - - Returns the default device. - - The default device. - - - - Returns the stream flags to use for the audioclient initialization. - - The stream flags to use for the audioclient initialization. - - - - Stops the capture and frees all resources. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Provides audio loopback capture through Wasapi. That enables a client to capture the audio stream that is being played by a rendering endpoint device (e.g. speakers, headset, etc.). - Minimum supported OS: Windows Vista (see property). - Read more about loopback recording here: http://msdn.microsoft.com/en-us/library/windows/desktop/dd316551(v=vs.85).aspx. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified in milliseconds. - - The latency specified in milliseconds. The default value is 100ms. - - - - Initializes a new instance of the class with the specified in milliseconds - and the to use. - - The latency specified in milliseconds. The default value is 100ms. - The default to use. - Note: The is just a suggestion. If the driver does not support this format, - any other format will be picked. After calling , the - property will return the actually picked . - - - - Initializes a new instance of the class with the specified in milliseconds, - the to use and the of the internal capture thread. - - The latency specified in milliseconds. The default value is 100ms. - The default to use. - Note: The is just a suggestion. If the driver does not support this format, - any other format will be picked. After calling , the - property will return the actually picked . - The , the internal capture thread will run on. - - - - Returns the default rendering device. - - Default rendering device. - - - - Returns the stream flags to use for the audioclient initialization. - - - The stream flags to use for the audioclient initialization. - - - - - Captures audio from a audio device (through WaveIn Apis). - - - - - Gets or sets the which should be used for capturing audio. - The property has to be set before initializing. The systems default recording device is used - as default value - of the property. - - The value must not be null. - - - - Gets or sets the latency of the wavein specified in milliseconds. - The property has to be set before initializing. - - - - - Initializes a new instance of the class using the a default format (44.1kHz, 16 bit, 2 channels, pcm). - - - - - Initializes a new instance of the class. - - The default format to use. The final format must not equal the specified . - waveFormat - - - - Occurs when new data got captured and is available. - - - - - Occurs when the recording stopped. - - - - - Gets the format of the captured audio data. - - - - - Initializes the instance. - - has to be . Call to stop. - - - - Starts recording. - - - - - Stops recording. - - - - - Gets the current . - - - - - Creates and returns the WaveOut handle. - - The waveformat to use. - A valid WaveOut handle. - - - - Disposes and stops the instance. - - - - - Disposes and stops the instance. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Represents a -device. - - - - - Enumerates the WaveIn devices installed on the system. - - A an iterator to iterate through all enumerated WaveIn devices. - - - - Gets the default WaveOut device. - - - - - Initializes a new instance of the class. - - The device identifier. - - - - Gets the device identifier. - - - - - Gets the name of the device. - - - - - Gets the version of the driver. - - - - - Gets the standard formats that are supported. - - - - - Gets the supported formats. - - - - - Provides data for the event. - - - - - Gets the available data. - - - - - Gets the number of available bytes. - - - - - Gets the zero-based offset inside of the array at which the available data starts. - - - - - Gets the format of the available . - - - - - Initializes a new instance of the class. - - A byte array which contains the data. - The offset inside of the array at which the available data starts. - The number of available bytes. - The format of the . - - data - or - format - - - offset must not be less than zero. - bytecount must not be or equal to zero. - - - - - Defines a interface for capturing audio. - - - - - Occurs when new data got captured and is available. - - - - - Occurs when the recording stopped. - - - - - Gets the format of the captured audio data. - - - - - Initializes the instance. - - - - - Starts capturing. - - - - - Stops capturing. - - - - - Gets the current . - - - - - Provides audioplayback through DirectSound. - - - - - Initializes an new instance of class. - Latency = 100. - EventSyncContext = SynchronizationContext.Current. - PlaybackThreadPriority = AboveNormal. - - - - - Initializes an new instance of class. - EventSyncContext = SynchronizationContext.Current. - PlaybackThreadPriority = AboveNormal. - - Latency of the playback specified in milliseconds. - - - - Initializes an new instance of class. - EventSyncContext = SynchronizationContext.Current. - - Latency of the playback specified in milliseconds. - - ThreadPriority of the playbackthread which runs in background and feeds the device - with data. - - - - - Initializes an new instance of class. - - Latency of the playback specified in milliseconds. - - ThreadPriority of the playbackthread which runs in background and feeds the device - with data. - - - The synchronizationcontext which is used to raise any events like the "Stopped"-event. - If the passed value is not null, the events will be called async through the SynchronizationContext.Post() method. - - - - - Random ID based on the internal directsounds memory address for debugging purposes. - - - - - Latency of the playback specified in milliseconds. - - - - - Gets or sets the device to use for the playing the waveform-audio data. Note that the - method has to get called - - - - - Occurs when the playback gets stopped. - - - - - Initializes and prepares all resources for playback. - Note that all properties like , ,... won't affect - after calling . - - The source to prepare for playback. - - - - Starts the playback. - Note: has to get called before calling Play. - If PlaybackState is Paused, Resume() will be called automatically. - - - - - Stops the playback and frees all allocated resources. - After calling the caller has to call again before another playback - can be started. - - - - - Resumes the paused playback. - - - - - Pauses the playback. - - - - - Gets the current of the playback. - - - - - The volume of the playback. Valid values are from 0.0 (0%) to 1.0 (100%). - - - Note that the if you for example set a volume of 33% => 0.33, the actual volume will be something like 0.33039999. - - - - - The currently initialized source. - To change the WaveSource property, call . - - - - - Disposes the instance and stops the playbacks. - - - - - Disposes and stops the instance. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls the method. - - - - - http: //msdn.microsoft.com/en-us/library/dd743869%28VS.85%29.aspx - - - - - WaveHeaderFlags: http://msdn.microsoft.com/en-us/library/aa909814.aspx#1 - - - - - pointer to locked data buffer (lpData) - - - - - length of data buffer (dwBufferLength) - - - - - used for input only (dwBytesRecorded) - - - - - for client's use (dwUser) - - - - - assorted flags (dwFlags) - - - - - loop control counter (dwLoops) - - - - - PWaveHdr, reserved for driver (lpNext) - - - - - reserved for driver - - - - - uMsg - http: //msdn.microsoft.com/en-us/library/dd743869%28VS.85%29.aspx - - - - - Defines standard formats for MmDevices. - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Defines functionalities supported by a device. - - - - - None - - - - - Supports pitch control. - - - - - Supports playback rate control. - - - - - Supports volume control. - - - - - Supports separate left and right volume control. - - - - - The driver is synchronous and will block while playing a buffer. - - - - - Returns sample-accurate position information. - - - - - DirectSound - - Not documented on msdn. - - - - Provides data for the event. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The associated exception. Can be null. - - - - Provides audioplayback through Wasapi. - Minimum supported OS: Windows Vista (see property). - - - - - Initializes an new instance of class. - EventSyncContext = SynchronizationContext.Current. - PlaybackThreadPriority = AboveNormal. - Latency = 100ms. - EventSync = False. - ShareMode = Shared. - - - - - Initializes an new instance of class. - EventSyncContext = SynchronizationContext.Current. - PlaybackThreadPriority = AboveNormal. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. - - Specifies how to open the audio device. Note that if exclusive mode is used, only one single - playback for the specified device is possible at once. - - Latency of the playback specified in milliseconds. - - - - Initializes an new instance of class. - EventSyncContext = SynchronizationContext.Current. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. - - Specifies how to open the audio device. Note that if exclusive mode is used, only one single - playback for the specified device is possible at once. - - Latency of the playback specified in milliseconds. - - ThreadPriority of the playbackthread which runs in background and feeds the device - with data. - - - - - Initializes an new instance of class. - - True, to use eventsynchronization instead of a simple loop and sleep behavior. - - Specifies how to open the audio device. Note that if exclusive mode is used, only one single - playback for the specified device is possible at once. - - Latency of the playback specified in milliseconds. - - of the playbackthread which runs in background and feeds the device - with data. - - - The which is used to raise any events like the -event. - If the passed value is not null, the events will be called async through the method. - - - - - Gets a value which indicates whether Wasapi is supported on the current Platform. True means that the current - platform supports ; False means that the current platform does not support - . - - - - - Sets a value indicating whether the Desktop Window Manager (DWM) has to opt in to or out of Multimedia Class Schedule Service (MMCSS) - scheduling while the current process is alive. - - - True to instruct the Desktop Window Manager to participate in MMCSS scheduling; False to opt out or end participation in MMCSS scheduling. - - DWM will be scheduled by the MMCSS as long as any process that called DwmEnableMMCSS to enable MMCSS is active and has not previously called DwmEnableMMCSS to disable MMCSS. - - - - Gets or sets the stream routing options. - - - The stream routing options. - - - The flag can only be used - if the is the default device. - That behavior can be changed by overriding the method. - - - - - Gets or sets the which should be used for playback. - The property has to be set before initializing. The systems default playback device is used - as default value - of the property. - - - Make sure to set only activated render devices. - - - - - Gets a random ID based on internal audioclients memory address for debugging purposes. - - - - - Gets or sets the latency of the playback specified in milliseconds. - The property has to be set before initializing. - - - - - Occurs when the playback stops. - - - - - Initializes WasapiOut instance and prepares all resources for playback. - Note that properties like , ,... won't affect WasapiOut after calling - . - - The source to prepare for playback. - - - - Starts the playback. - Note: has to get called before calling Play. - If is , will be - called automatically. - - - - - Stops the playback and frees most of allocated resources. - - - - - Resumes the paused playback. - - - - - Pauses the playback. - - - - - Gets the current of the playback. - - - - - Gets or sets the volume of the playback. - Valid values are in the range from 0.0 (0%) to 1.0 (100%). - - - - - The currently initialized source. - To change the WaveSource property, call . - - - The value of the WaveSource might not be the value which was passed to the method, because - WasapiOut (depending on the waveformat of the source) has to use a DmoResampler. - - - - - Gets or sets a value indicating whether should try to use all available channels. - - - - - Stops the playback (if playing) and cleans up all used resources. - - - - - Updates the stream routing options. - - - If the current is not the default device, - the flag will be removed. - - - - - Disposes and stops the instance. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Defines options for wasapi-streamrouting. - - - - - Disable stream routing. - - - - - Use stream routing when the device format has changed. - - - - - Use stream routing when the default device has changed. - - - - - Use stream routing when the current device was disconnected. - - - - - Combination of , and . - - - - - Provides audioplayback through the WaveOut api. - - - - - Initializes a new instance of the class with a latency of 100 ms. - - - - - Initializes a new instance of the class. - - Latency of the playback specified in milliseconds. - latency must not be less or equal to zero. - - - - Gets or sets the which should be used for playback. - The property has to be set before initializing. The systems default playback device is used - as default value - of the property. - - The value must not be null. - - - - Gets or sets the latency of the playback specified in milliseconds. - The property has to be set before initializing. - - - - - Starts the playback. - Note: has to get called before calling Play. - If is , will be - called automatically. - - - - - Pauses the playback. - - - - - Resumes the paused playback. - - - - - Stops the playback and frees most of allocated resources. - - - - - Initializes WaveOut instance and prepares all resources for playback. - Note that properties like , ,... won't affect WaveOut after calling - . - - The source to prepare for playback. - - - - Gets or sets the volume of the playback. - Valid values are in the range from 0.0 (0%) to 1.0 (100%). - - - - - The currently initialized source. - To change the WaveSource property, call . - - - The value of the WaveSource might not be the value which was passed to the method, - because - WaveOut uses the class to control the volume of the playback. - - - - - Gets the current of the playback. - - - - - Occurs when the playback stops. - - - - - Stops the playback (if playing) and cleans up all used resources. - - - - - Gets or sets a value indicating whether should try to use all available channels. - - - - - Creates and returns the WaveOut handle. - - The waveformat to use. - A valid WaveOut handle. - - - - Disposes and stops the instance. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Finalizes an instance of the class. - - - - - Represents a -device. - - - - - Enumerates the WaveOut devices installed on the system. - - A an iterator to iterate through all enumerated WaveOut devices. - - - - Gets the default WaveOut device. - - - - - Initializes a new instance of the class. - - The device identifier. - - - - Gets the device identifier. - - - - - Gets the name of the device. - - - - - Gets the supported functionalities of the device. - - - - - Gets the version of the driver. - - - - - Gets the standard formats that are supported. - - - - - Gets the supported formats. - - - - - Defines a interface for audio playbacks. - - - - - Starts the audio playback. - - - - - Pauses the audio playback. - - - - - Resumes the audio playback. - - - - - Stops the audio playback. - - - - - Initializes the for playing a . - - which provides waveform-audio data to play. - - - - Gets or sets the volume of the playback. The value of this property must be within the range from 0.0 to 1.0 where 0.0 equals 0% (muted) and 1.0 equals 100%. - - - - - Gets the which provides the waveform-audio data and was used to the . - - - - - Gets the of the . The playback state indicates whether the playback is currently playing, paused or stopped. - - - - - Occurs when the playback stops. - - - - - Defines playback states. - - - - - Playback is stopped. - - - - - Playback is playing. - - - - - Playback is paused. - - - - - Provides data for any stopped operations. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The associated exception. Can be null. - - - - Gets a value which indicates whether the operation stopped due to an error. True means that that the operation - stopped due to an error. False means that the operation did not stop due to an error. - - - - - Gets the associated which caused the operation to stop. - - Can be null. - - - - Cached wave source. - - - - - Initializes a new instance of the class. - - Source which will be copied to a cache. - - - - Creates a stream to buffer data in. - - An empty stream to use as buffer. - - - - Reads a sequence of bytes from the cache and advances the position within the cache by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the cache. - - - The zero-based byte offset in the at which to begin storing the data - read from the cache. - - The maximum number of bytes to read from the cache. - The total number of bytes read into the . - - - - Gets the Waveformat of the data stored in the cache. - - - - - Gets or sets the position. - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets the amount of bytes stored in the cache. - - - - - Disposes the cache. - - - - - Disposes the internal used cache. - - - - - - Finalizes an instance of the class. - - - - - NOT RELEASED YET! Provides conversion between a set of input and output channels using a . - - - - - Initializes a new instance of the class. - - The which provides input data. - The which defines the mapping of the input channels to the output channels. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets the output format. - - - - - Gets or sets the position in samples. - - - - - Gets the length in samples. - - - - - Defines possible values for the property. - Default value is . - - - - - 180° Phase. - - - - - 90° Phase. - Default value for . - - - - - 0° Phase. - - - - - -90° Phase. - - - - - -180° Phase. - - - - - Defines possible values for the property. - Default value is WaveformSin (used for ). - - - - - Sine - Default value for . - - - - - Trinagle - - - - - Represents the dmo chorus effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the number of milliseconds the input is delayed before it is played back, in the range from 0 to 20. The default value is 16 ms. - - - - - Gets or sets the percentage by which the delay time is modulated by the low-frequency oscillator, in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 10. - - - - - Gets or sets the percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is 25. - - - - - Gets or sets the frequency of the LFO, in the range from 0 to 10. The default value is 1.1. - - - - - Gets or sets the waveform shape of the LFO. By default, the waveform is a sine. - - - - - Gets or sets the phase differential between left and right LFOs. The default value is Phase90. - - - - - Gets or sets the ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet). The default value is 50. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - 180° Phase - - - - - 90° Phase - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - -180° Phase - - - - - -90° Phase - - - - - 0° Phase - - - - - Default value for the property. - - - - - Sine waveform - - - - - Triangle waveform - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Represents the dmo compressor effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the time before compression reaches its full value, in the range from 0.01 ms to 500 ms. The default value is 10 ms. - - - - - Gets or sets the output gain of signal after compression, in the range from -60 dB to 60 dB. The default value is 0 dB. - - - - - Gets or sets the time after is reached before attack phase is started, in milliseconds, in the range from 0 ms to 4 ms. The default value is 4 ms. - - - - - Gets or sets the compression ratio, in the range from 1 to 100. The default value is 3, which means 3:1 compression. - - - - - Gets or sets the speed at which compression is stopped after input drops below fThreshold, in the range from 50 ms to 3000 ms. The default value is 200 ms. - - - - - Gets or sets the point at which compression begins, in decibels, in the range from -60 dB to 0 dB. The default value is -20 dB. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Represents the dmo distortion effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the amount of signal change after distortion, in the range from -60 dB through 0 dB. The default value is -18 dB. - - - - - Gets or sets the percentage of distortion intensity, in the range in the range from 0 % through 100 %. The default value is 15 percent. - - - - - Gets or sets the center frequency of harmonic content addition, in the range from 100 Hz through 8000 Hz. The default value is 2400 Hz. - - - - - Gets or sets the width of frequency band that determines range of harmonic content addition, in the range from 100 Hz through 8000 Hz. The default value is 2400 Hz. - - - - - Gets or sets the filter cutoff for high-frequency harmonics attenuation, in the range from 100 Hz through 8000 Hz. The default value is 8000 Hz. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Represents the dmo echo effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from - 0 through 100 (all wet). The default value is 50. - - - - - Gets or sets the percentage of output fed back into input, in the range from 0 - through 100. The default value is 50. - - - - - Gets or sets the delay for left channel, in milliseconds, in the range from 1 - through 2000. The default value is 500 ms. - - - - - Gets or sets the delay for right channel, in milliseconds, in the range from 1 - through 2000. The default value is 500 ms. - - - - - Gets or sets the value that specifies whether to swap left and right delays with each successive echo. - The default value is false, meaning no swap. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Base class for all DMO effects. - - DMO effect itself. - Parameter struct of the DMO effect. - - - - Creates a new instance of class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Creates an MediaObject from the effect DMO. - - The input format of the to create. - The output format of the to create. - - The created to use for processing audio data. - - - - - Gets the output format of the effect. - - The output format of the effect. - - - - Gets the underlying effect. - - - - - Gets or sets whether the effect is enabled. - - - - - Sets the value for one of the effects parameter and updates the effect. - - Type of the . - Name of the field to set the value for. - Value to set. - - - - Reads a sequence of bytes from the stream and applies the Dmo effect to them (only if the property is set to true). - - An array of bytes. When this method returns, the buffer contains the read bytes. - The zero-based byte offset in buffer at which to begin storing the data read from the stream. - The maximum number of bytes to be read from the stream - The actual number of read bytes. - - - - Represents the dmo flanger effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the ratio of wet (processed) signal to dry (unprocessed) signal. Must be in the range from 0 through 100 (all wet). The default value is 50. - - - - - Gets or sets the percentage by which the delay time is modulated by the low-frequency oscillator (LFO), in hundredths of a percentage point. Must be in the range from 0 through 100. The default value is 100. - - - - - Gets or sets the percentage of output signal to feed back into the effect's input, in the range from -99 to 99. The default value is -50. - - - - - Gets or sets the frequency of the LFO, in the range from 0 to 10. The default value is 0.25. - - - - - Gets or sets the waveform shape of the LFO. By default, the waveform is a sine. - - - - - Gets or sets the number of milliseconds the input is delayed before it is played back, in the range from 0ms to 4ms. The default value is 2 ms. - - - - - Gets or sets the phase differential between left and right LFOs. The default value is . - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Represents the dmo gargle effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the rate of modulation, in Hertz. Must be in the range from 20Hz through 1000Hz. The default value is 20Hz. - - - - - Gets or sets the shape of the modulation waveform. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - Use the enumeration instead. - - - - Square Waveform. - - Use the enumeration instead. - - - - Triangle Waveform - - Use the enumeration instead. - - - - Represents the dmo waves reverb effect in form of an implementation. - - - - - Creates a new instance of the class. - - The base source, which feeds the effect with data. - - - - Creates and returns a new instance of the native COM object. - - A new instance of the native COM object. - - - - Gets or sets the input gain of signal, in decibels (dB), in the range from -96 dB through 0 dB. The default value is 0 dB. - - - - - Gets or sets the reverb mix, in dB, in the range from -96 dB through 0 dB. The default value is 0 dB. - - - - - Gets or sets the reverb time, in milliseconds, in the range from 0.001 through 3000. The default value is 1000. - - - - - Gets or sets the high-frequency reverb time ratio, in the range from 0.001 through 0.999. The default value is 0.001. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Default value for the property. - - - - - Maximum value for the property. - - - - - Minimum value for the property. - - - - - Represents an equalizer which can be dynamically modified by adding, removing or modifying - . - - - - - Initializes a new instance of the class based on an underlying wave stream. - - The underlying wave stream. - - - - Gets a list which contains all used by the equalizer. - - - None of the - - - - - Returns a new instance of the class with 10 preset . - - The underlying sample source which provides the data for the equalizer. - A new instance of the class with 10 preset . - - - - Returns a new instance of the class with 10 preset . - - The underlying sample source which provides the data for the equalizer. - The bandwidth to use for the 10 . The default value is 18. - - The default gain to use for the 10 . The default value is zero - which means that the data, passed through the equalizer won't be affected by the . - - A new instance of the class with 10 preset . - - - - Reads a sequence of samples from the underlying , applies the equalizer - effect and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Represents an EqualizerFilter for a single channel. - - - - - Initializes a new instance of the class. - - The sampleRate of the audio data to process. - The center frequency to adjust. - The bandWidth. - The gain value in dB. - - - - Gets or sets the gain value in dB. - - - - - Gets or sets the bandwidth. - - - - - Gets the frequency. - - - - - Gets the samplerate. - - - - - Returns a copy of the . - - A copy of the - - - - Processes an array of input samples. - - The input samples to process. - The zero-based offset in the buffer to start at. - The number of samples to process. - Specifies the channel to process as a zero-based index. - The total number of channels. - - - - Represents an EqualizerFilter which holds an for each channel. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The number of channels to use. - The channel filter which should be used for all channels. - - - - Gets all underlying as a dictionary where the key represents the channel - index and the value to itself. - - - - - Gets the average frequency of all . - - - - - Gets or sets the average gain value of all . - - - When using the setter of the property, the new gain value will be applied to all - . - - - - - Returns an enumerator that iterates through the . - - - A that can be used to iterate through the . - - - - - Returns an enumerator that iterates through a . - - - An object that can be used to iterate through the . - - - - - Returns a new instance of the class. - - The number of channels to use. - The samplerate of the data to process. - The frequency of the filter. - The bandwidth. - The gain value. - A new instance of the class. - - - - Defines possible values for the property. - The default value is . - - - - - 180° Phase. - - - - - 90° Phase. - Default value for . - - - - - 0° Phase. - - - - - -90° Phase. - - - - - -180° Phase. - - - - - Defines possible values for the property. - The default value is . - - - - - Triangle. - - - - - Sine. Default value. - - - - - Defines possible values for the property. - The default value is . - - - - - Triangle - Default value. - - - - - Square - - - - - A pitch shifting effect. - - - The internal pitch shifting code is based on the implementation of - Stephan M. Bernsee smb@dspdimension.com (see http://www.dspdimension.com) and - Michael Knight madmik3@gmail.com (http://sites.google.com/site/mikescoderama/) who - translated Stephan's code to C#. - - Both gave the explicit permission to republish the code as part of CSCore under the MS-PL. - Big thanks! - - - - - Gets or sets the pitch shift factor. - - - A pitch shift factor value which is between 0.5 - (one octave down) and 2. (one octave up). A value of exactly 1 does not change - the pitch. - - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - - - - Reads a sequence of samples from the , applies the pitch shifting to them - and advances the position within the stream by the number of samples read. - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source including the applied pitch shift. - The zero-based offset in the at which to begin storing the data - read from the current stream. - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - - - - Provides the ability use an implementation of the interface fade waveform-audio data. - - - - - Initializes a new instance of the class. - - The underlying source to use. - - - - Gets or sets the fade strategy to use. - - - - - Reads a sequence of samples from the class and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Compared to the , the property of the accepts any value. - - - - - Initializes a new instance of the class. - - The underlying base source. - - - - Gets or sets the volume. A value of 1.0 will set the volume to 100%. A value of 0.0 will set the volume to 0%. - - Since there is no validation of the value, this property can be used to set the gain value to any value. - - - - Gets or sets a value indicating whether the method should clip overflows. The default value is true. - - - true if the method should clip overflows; otherwise, false. - - Clipping the overflows means, that all samples which are not in the range from -1 to 1, will be clipped to that range. - For example if a sample has a value of 1.3, it will be clipped to a value of 1.0. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. After reading the samples, the specified gain value will get applied and the overflows will be clipped (optionally). - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - The zero-based offset in the at which to begin storing the data - read from the current stream. - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - - - - Provides a mechanism for fading in/out audio. - - - The - and the -property must be set before the - can be used. - - - - - Gets a value which indicates whether the current volume equals the target volume. If not, the - property returns false. - - - - - Gets or sets the sample rate to use. - - - - - Gets or sets the number of channels. - - - - - Occurs when the fading process has reached its target volume. - - - - - Applies the fading algorithm to the waveform-audio data. - - Float-array which contains IEEE-Float samples. - Zero-based offset of the . - The number of samples, the fading algorithm has to be applied on. - - - - Starts fading a specified volume another volume. - - - The start volume in the range from 0.0 to 1.0. If no value gets specified, the default volume will be used. - The default volume is typically 100% or the current volume. - - The target volume in the range from 0.0 to 1.0. - The duration. - - - - Starts fading a specified volume another volume. - - - The start volume in the range from 0.0 to 1.0. If no value gets specified, the default volume will be used. - The default volume is typically 100% or the current volume. - - The target volume in the range from 0.0 to 1.0. - The duration in milliseconds. - - - - Stops the fading. - - - - - Provides a linear fading algorithm. - - - - - Gets the current volume. - - - - - Gets the target volume. - - - - - Occurs when the fading process has reached its target volume. - - - - - Gets a value which indicates whether the class is fading. - True means that the class is fading audio data. - False means that the equals the . - - - - - Gets or sets the sample rate to use. - - - - - Gets or sets the number of channels. - - - - - Starts fading a specified volume another volume. - - - The start volume in the range from 0.0 to 1.0. If no value gets specified, the default volume will be used. - The default volume is typically 100% or the current volume. - - The target volume in the range from 0.0 to 1.0. - The duration. - - - - Starts fading a specified volume another volume. - - - The start volume in the range from 0.0 to 1.0. If no value gets specified, the default volume will be used. - The default volume is typically 100% or the current volume. - - The target volume in the range from 0.0 to 1.0. - The duration in milliseconds. - - - - Stops the fading. - - - - - Applies the fading algorithm to the . - - Float-array which contains IEEE-Float samples. - Zero-based offset of the . - The number of samples, the fading algorithm has to be applied on. - - - - Provides data for the event. - - - - - Gets the individual peak value for each channel. - - - - - Gets the master peak value. - - - - - Initializes a new instance of the class. - - The channel peak values. - The master peak value. - is null or empty. - - - - Represents a peak meter. - - - - - Gets the average value of all . - - - - - Gets the peak values for all channels. - - - - - Obsolete - - - - - Gets or sets the interval at which to raise the event. - The interval is specified in milliseconds. - - - - - Event which gets raised when a new peak value is available. - - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - source - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Sets all ChannelPeakValues to zero and resets the amount of processed blocks. - - - - - Converts a 32-bit PCM to a . - - - - - Initializes a new instance of the class. - - The underlying 32-bit POCM instance which has to get converted to a . - is null. - The format of the is not 32-bit PCM. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Converts a to a 32-bit PCM . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a 32-bit PCM . - is null. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Converts a to a 32-bit IeeeFloat . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a 32-bit IeeeFloat . - is null. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Converts a to a 24-bit PCM . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a 24-bit PCM . - is null. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Converts a to a 8-bit PCM . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a 8-bit PCM . - is null. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Converts a 32-bit IeeeFloat to a . - - - - - Initializes a new instance of the class. - - The underlying 32-bit IeeeFloat instance which has to get converted to a . - is null. - The format of the is not 32-bit IeeeFloat. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Converts a to a 16-bit PCM . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a 16-bit PCM . - is null. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Converts a to a . - - - - - The underlying source which provides samples. - - - - - The buffer to use for reading from the . - - - - - Initializes a new instance of the class. - - The underlying which has to get converted to a . - The of the Output-. - The of the Output-. - The is null. - Invalid number of bits per sample specified by the argument. - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets the of the output waveform-audio data. - - - - - Gets or sets the current position. - - - - - Gets the length of the waveform-audio data. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the instance. - - - - - Disposes the underlying . - - Not used. - - - - Calls . - - - - - Converts a 16-bit PCM to a . - - - - - Initializes a new instance of the class. - - The underlying 16-bit POCM instance which has to get converted to a . - is null. - The format of the is not 16-bit PCM. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Converts a 24-bit PCM to a . - - - - - Initializes a new instance of the class. - - The underlying 24-bit POCM instance which has to get converted to a . - is null. - The format of the is not 24-bit PCM. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Converts a 8-bit PCM to a . - - - - - Initializes a new instance of the class. - - The underlying 8-bit POCM instance which has to get converted to a . - is null. - The format of the is not 8-bit PCM. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Converts a to a . - - - - - The underlying source which provides the raw data. - - - - - The buffer to use for reading from the . - - - - - Initializes a new instance of the class. - - The underlying instance which has to get converted to a . - The argument is null. - - - - Reads a sequence of samples from the and advances the position within the stream by the - number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets the of the waveform-audio data. - - - - - Gets or sets the current position in samples. - - - - - Gets the length of the waveform-audio data in samples. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the . - - - - - Disposes the . - - Not used. - - - - Finalizes an instance of the class. - - - - - Returns an implementation of the interface which converts the specified to a . - - The instance to convert. - Returns an implementation of the interface which converts the specified to a . - is null. - The of the is not supported. - - - - A thread-safe (synchronized) wrapper around the specified a . - - The type of the underlying . - The type of the data read by the method. - - - - Initializes a new instance of the class. - - The underlying source to synchronize. - - - - Gets the output of the . - - - - - Gets or sets the position of the . - - - - - Gets the length of the . - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets or sets the . - - - - - Reads a sequence of elements from the and advances its position by the - number of elements read. - - - An array of elements. When this method returns, the contains the specified - array of elements with the values between and ( + - - 1) replaced by the elements read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of elements to read from the current source. - The total number of elements read into the buffer. - - - - Defines an explicit conversation of a to its - . - - Instance of the . - The of the . - - - - Disposes the and releases all allocated resources. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Disposes the and releases all allocated resources. - - - - - Finalizes an instance of the class. - - - - - Buffered WaveSource which overrides the allocated memory after the internal buffer got full. - - - - - Gets or sets a value which specifies whether the method should clear the specified buffer with zeros before reading any data. - - - - - Gets the maximum size of the buffer in bytes. - - - The maximum size of the buffer in bytes. - - - - - Initializes a new instance of the class with a default buffersize of 5 seconds. - - The WaveFormat of the source. - - - - Initializes a new instance of the class. - - The WaveFormat of the source. - Buffersize in bytes. - - - - Adds new data to the internal buffer. - - A byte-array which contains the data. - Zero-based offset in the (specified in bytes). - Number of bytes to add to the internal buffer. - Number of added bytes. - - - - Reads a sequence of bytes from the internal buffer of the and advances the position within the internal buffer by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the internal buffer. - - - The zero-based byte offset in the at which to begin storing the data - read from the internal buffer. - - The maximum number of bytes to read from the internal buffer. - The total number of bytes read into the . - - - - Gets the of the waveform-audio data. - - - - - Not supported. - - - - - Gets the number of stored bytes inside of the internal buffer. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the and its internal buffer. - - - - - Disposes the and its internal buffer. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Default destructor which calls . - - - - - Reads data from the and stores the read data in a buffer. - - - - - Initializes a new instance of the class. - - The to buffer. - Size of the buffer. - is out of range. - - - - Reads a sequence of bytes from internal buffer and advances the position by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the . - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the . - The total number of bytes read into the buffer. - BufferSource - - - - Resets/Clears the buffer. - - BufferSource - - - - Gets or sets the position of the source. - - - BufferSource - - - - - Gets the length of the source. - - - - - Disposes the and releases all allocated resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fire the event after every block read. - - - - - Occurs when the method reads a block. - - If the method reads n during a single call, the event will get fired n times. - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - source - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. Fires the event for each block it reads (one block = (number of channels) samples). - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - The zero-based offset in the at which to begin storing the data - read from the current stream. - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - - - - Provides data for the event. - - - - - Gets the sample of the left channel. - - - - - Gets the sample of the right channel. - - - - - Gets the samples of all channels if the number of is greater or equal to three. - - If the number of is less than three, the value of the property is null. - - - - Gets the number of channels. - - - - - Initializes a new instance of the class. - - The samples. - The index inside of the -array. - The number of channels. - - - - Provides data for the event. - - Type of the array. - - - - Gets the number of read elements. - - - - - Gets the array which contains the read data. - - - - - Initializes a new instance of the class. - - The read data. - The number of read elements. - - - - Converts a mono source to a stereo source. - - - - - Initializes a new instance of the class. - - The underlying mono source. - The has more or less than one channel. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets or sets the position in samples. - - - - - Gets the length in samples. - - - - - Gets the of the waveform-audio data. - - - - - Disposes the and the underlying . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Notifies the client when a certain amount of data got read. - - Can be used as some kind of a timer for playbacks,... - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - source is null. - - - - Gets or sets the interval in blocks. One block equals one sample for each channel. - - - - - Gets or sets the interval in milliseconds. - - - - - Occurs when a specified amount of data got read. - - - The - or the -property specifies how many samples have to get - read to trigger the event. - - - - - Reads a sequence of samples from the and advances the position within the - stream by - the number of samples read. When the [(number of total samples read) / (number of channels)] % - = 0, the event gets triggered. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - - - - Provides control over the balance between the left and the right channel of an audio source. - - - - - Gets or sets the balance. The valid range is from -1 to 1. -1 will mute the right channel, 1 will mute left channel. - - The value is not within the specified range. - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - Source has to be stereo. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - The zero-based offset in the at which to begin storing the data - read from the current stream. - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - Read samples has to be a multiple of two. - - - - Notifies the client when a specific number of samples got read and when the method got called. - - Compared to the , none of both events won't provide the read data. - - - - Initializes a new instance of the class. - - Underlying base source which provides audio data. - source - - - - Gets or sets the interval (in which to fire the event) in blocks. One block equals one - sample for each channel. - - - - - Gets or sets the interval (in which to fire the event) in milliseconds. - - - - - Occurs when the method got called. - - - - - Occurs when a specified amount of data got read. - - - The - or the -property specifies how many samples have to get - read to trigger the event. - - - - - Reads a sequence of samples from the and advances the position within the - stream by - the number of samples read. Triggers the event and if the [(number of total samples read) / - (number of channels)] % - = 0, the event gets triggered. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - - The total number of samples read into the buffer. - - - - - Provides the ability to adjust the volume of an audio stream. - - - - - The epsilon which is used to compare for almost-equality of the volume in . - - - - - Gets or sets the volume specified by a value in the range from 0.0 to 1.0. - - - - - Initializes a new instance of the class. - - The underlying base source. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. After reading the samples, the volume of the read samples gets manipulated. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Represents an implementation of the interface which provides the data provided by a specified object. - - - - - Occurs when new data is available. - - - - - Gets the underlying instance. - - - - - Initializes a new instance of the class with a default bufferSize of 5 seconds. - - The soundIn which provides recorded data. - - Note that soundIn has to be already initialized. - Note that old data ("old" gets specified by the bufferSize) gets overridden. - For example, if the bufferSize is about 5 seconds big, data which got recorded 6 seconds ago, won't be available anymore. - - - - - Initializes a new instance of the class. - - The soundIn which provides recorded data. - Size of the internal buffer in bytes. - - Note that soundIn has to be already initialized. - Note that old data ("old" gets specified by the bufferSize) gets overridden. - For example, if the bufferSize is about 5 seconds big, data which got recorded 6 seconds ago, won't be available anymore. - - - - - Reads a sequence of bytes from the internal stream which holds recorded data and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets the of the recorded data. - - - - - Gets or sets the current position in bytes. This property is currently not supported. - - - - - Gets the length in bytes. This property is currently not supported. - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets or sets a value which indicates whether the method should always provide the requested amount of data. - For the case that the internal buffer can't offer the requested amount of data, the rest of the requested bytes will be filled up with zeros. - - - - - Disposes the . - - - - - Disposes the . - - Not used. - - - - Destructor of the class which calls the method. - - - - - Converts a stereo source to a mono source. - - - - - Initializes a new instance of the class. - - The underlying stereo source. - The has more or less than two channels. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets or sets the position in samples. - - - - - Gets the length in samples. - - - - - Gets the of the waveform-audio data. - - - - - Disposes the and the underlying . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - A Stream which can be used for endless looping. - - - - - Initializes a new instance of the class. - - The underlying . - - - - Gets or sets whether looping is enabled. - - - - - Occurs when the underlying reaches its end. - If the property is set to true, the Position of the - will be reseted to zero. - - - - - Reads from the underlying . If the - does not provide any more data, its position gets reseted to zero. - - Buffer which receives the read data. - Zero-based offset offset in the at which to begin storing data. - The maximum number of bytes to read. - Actual number of read bytes. - - - - Generates a sine wave. - - - - - Gets or sets the frequency of the sine wave. - - - - - Gets or sets the amplitude of the sine wave. - - - - - Gets or sets the phase of the sine wave. - - - - - 1000Hz, 0.5 amplitude, 0.0 phase - - - - - Initializes a new instance of the class. - - Specifies the frequency of the sine wave in Hz. - Specifies the amplitude of the sine wave. Use a value between 0 and 1. - Specifies the initial phase. Use a value between 0 and 1. - - - - Reads a sequence of samples from the . - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets the of the waveform-audio data. - - - - - Not supported. - - - - - Not supported. - - - - - Gets a value indicating whether the supports seeking. - - - - - Not used. - - - - - Defines all known encoding types. Primary used in the class. See - . - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - WAVE_FORMAT_NMS_VBXADPCM - - - WAVE_FORMAT_CS_IMAADPCM - - - WAVE_FORMAT_ECHOSC3 - - - WAVE_FORMAT_ROCKWELL_ADPCM - - - WAVE_FORMAT_ROCKWELL_DIGITALK - - - WAVE_FORMAT_XEBEC - - - WAVE_FORMAT_G721_ADPCM - - - WAVE_FORMAT_G728_CELP - - - WAVE_FORMAT_MSG723 - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - WAVE_FORMAT_RT24 - - - WAVE_FORMAT_PAC - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - WAVE_FORMAT_LUCENT_G723 - - - WAVE_FORMAT_CIRRUS - - - WAVE_FORMAT_ESPCM - - - WAVE_FORMAT_VOXWARE - - - WAVE_FORMAT_CANOPUS_ATRAC - - - WAVE_FORMAT_G726_ADPCM - - - WAVE_FORMAT_G722_ADPCM - - - WAVE_FORMAT_DSAT_DISPLAY - - - WAVE_FORMAT_VOXWARE_BYTE_ALIGNED - - - WAVE_FORMAT_VOXWARE_AC8 - - - WAVE_FORMAT_VOXWARE_AC10 - - - WAVE_FORMAT_VOXWARE_AC16 - - - WAVE_FORMAT_VOXWARE_AC20 - - - WAVE_FORMAT_VOXWARE_RT24 - - - WAVE_FORMAT_VOXWARE_RT29 - - - WAVE_FORMAT_VOXWARE_RT29HW - - - WAVE_FORMAT_VOXWARE_VR12 - - - WAVE_FORMAT_VOXWARE_VR18 - - - WAVE_FORMAT_VOXWARE_TQ40 - - - WAVE_FORMAT_SOFTSOUND - - - WAVE_FORMAT_VOXWARE_TQ60 - - - WAVE_FORMAT_MSRT24 - - - WAVE_FORMAT_G729A - - - WAVE_FORMAT_MVI_MVI2 - - - WAVE_FORMAT_DF_G726 - - - WAVE_FORMAT_DF_GSM610 - - - WAVE_FORMAT_ISIAUDIO - - - WAVE_FORMAT_ONLIVE - - - WAVE_FORMAT_SBC24 - - - WAVE_FORMAT_DOLBY_AC3_SPDIF - - - WAVE_FORMAT_MEDIASONIC_G723 - - - WAVE_FORMAT_PROSODY_8KBPS - - - WAVE_FORMAT_ZYXEL_ADPCM - - - WAVE_FORMAT_PHILIPS_LPCBB - - - WAVE_FORMAT_PACKED - - - WAVE_FORMAT_MALDEN_PHONYTALK - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - WAVE_FORMAT_RHETOREX_ADPCM - - - WAVE_FORMAT_IRAT - - - WAVE_FORMAT_VIVO_G723 - - - WAVE_FORMAT_VIVO_SIREN - - - WAVE_FORMAT_DIGITAL_G723 - - - WAVE_FORMAT_SANYO_LD_ADPCM - - - WAVE_FORMAT_SIPROLAB_ACEPLNET - - - WAVE_FORMAT_SIPROLAB_ACELP4800 - - - WAVE_FORMAT_SIPROLAB_ACELP8V3 - - - WAVE_FORMAT_SIPROLAB_G729 - - - WAVE_FORMAT_SIPROLAB_G729A - - - WAVE_FORMAT_SIPROLAB_KELVIN - - - WAVE_FORMAT_G726ADPCM - - - WAVE_FORMAT_QUALCOMM_PUREVOICE - - - WAVE_FORMAT_QUALCOMM_HALFRATE - - - WAVE_FORMAT_TUBGSM - - - WAVE_FORMAT_MSAUDIO1 - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - WAVE_FORMAT_UNISYS_NAP_ADPCM - - - WAVE_FORMAT_UNISYS_NAP_ULAW - - - WAVE_FORMAT_UNISYS_NAP_ALAW - - - WAVE_FORMAT_UNISYS_NAP_16K - - - WAVE_FORMAT_CREATIVE_ADPCM - - - WAVE_FORMAT_CREATIVE_FASTSPEECH8 - - - WAVE_FORMAT_CREATIVE_FASTSPEECH10 - - - WAVE_FORMAT_UHER_ADPCM - - - WAVE_FORMAT_QUARTERDECK - - - WAVE_FORMAT_ILINK_VC - - - WAVE_FORMAT_RAW_SPORT - - - WAVE_FORMAT_ESST_AC3 - - - WAVE_FORMAT_IPI_HSX - - - WAVE_FORMAT_IPI_RPELP - - - WAVE_FORMAT_CS2 - - - WAVE_FORMAT_SONY_SCX - - - WAVE_FORMAT_FM_TOWNS_SND - - - WAVE_FORMAT_BTV_DIGITAL - - - WAVE_FORMAT_QDESIGN_MUSIC - - - WAVE_FORMAT_VME_VMPCM - - - WAVE_FORMAT_TPC - - - WAVE_FORMAT_OLIGSM - - - WAVE_FORMAT_OLIADPCM - - - WAVE_FORMAT_OLICELP - - - WAVE_FORMAT_OLISBC - - - WAVE_FORMAT_OLIOPR - - - WAVE_FORMAT_LH_CODEC - - - WAVE_FORMAT_NORRIS - - - WAVE_FORMAT_SOUNDSPACE_MUSICOMPRESS - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - MPEG_RAW_AAC - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - See . - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. See . - - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - - Raw AAC1 - - - - - Windows Media Audio Voice (WMA Voice) - - - - Extensible - - - WAVE_FORMAT_DEVELOPMENT - - - - FLAC - - - - - WARNING: If MimeType equals "-->" the picture will be downloaded from the web. - Use GetURL() the get the url to the picture. If not, data, contained by the frame will - be used. - - - - - Range from 1(worst) to 255(best). Zero -> Rating disabled. - - - - - - 1 -> ommit the counter. Default length is 4 byte. If 4 byte is not enough to hold the - number, a byte will be added(up to 8 bytes total). - - - - - Gets the formatstring of the timestamp - - length of the string which has to be parsed - - - - - Exception class for all ID3-Tag related Exceptions. - - - - - encoded with ISO-8859-1 [ISO-8859-1] or UTF-8 [UTF-8] - - - - - Defines a base class for all time converts. A time converter can be used to convert raw positions (depending on the implementation i.e. bytes or samples) to a human - readable . - - - - - A for objects. - - - - - A for objects. - - - - - Converts a back to raw elements, a source works with. The unit of these raw elements depends on the implementation. For more information, see . - - The of the source which gets used to convert the . - The to convert to raw elements. - The converted in raw elements. - - - - Converts raw elements to a value. The unit of these raw elements depends on the implementation. For more information, see . - - The of the source which gets used to convert the . - The raw elements to convert to a . - The . - - - - Specifies which to use. - - - - - Gets the type of the to use. - - - - - Gets or sets the arguments to pass to the constructor of the . For more information, see . - - - - - Gets or sets a value indicating whether a new instance of the specified should be created each time the queries the . - The default value is false. - - - - - Initializes a new instance of the class based on the type of the to use. - - Type of the to use. - timeConverterType - Specified type is no time converter.;timeConverterType - - - - Provides s for converting raw time values (e.g. bytes, samples,...) to a and back. - - - - - Gets the default instance of the factory. - - - - - Registers a new for a specific source type. - - The to register. - The source type. - timeConverter is null. - There is already a registered for the specified . - The class uses the source type to find choose the best for an . For more information, see . - - - - Unregisters a previously registered . - - The source type, that got passed to the method previously. - The specified source type could not be found. - - - - Gets the for the specified . - - The object to get the for. - The type of the . - The best for the specified . - The specified is null. - - Specified type is no AudioSource.;type - or - No registered time converter for the specified source type was found. - or - Multiple possible time converters, for the specified source type, were found. Specify which time converter to use, through the . - - - The chooses the best for the specified . - If there is no applied to the object (the ), it looks up the inheritance hierarchy (interfaces included) of the object - and searches for all registered source types. If there is a match it returns the associated . If there are more or less than one match BUT no - it throws an exception. - - - - Gets the for the specified source type. - - The type of the source. - The best for the specified source type. - - Specified type is no AudioSource.;type - or - No registered time converter for the specified source type was found. - or - Multiple possible time converters, for the specified source type, were found. Specify which time converter to use, through the . - - - The chooses the best for the specified source type. - If there is no applied to the object, it looks up the inheritance hierarchy (interfaces included) of the object - and searches for all registered source types. If there is a match it returns the associated . If there are more or less than one match BUT no - it throws an exception. - - - - Gets the for the specified . - - The to get the associated for. - The best for the specified . - - Specified type is no AudioSource.;type - or - No registered time converter for the specified source type was found. - or - Multiple possible time converters, for the specified source type, were found. Specify which time converter to use, through the . - - - The chooses the best for the specified . - If there is no applied to the object (the ), it looks up the inheritance hierarchy (interfaces included) of the object - and searches for all registered source types. If there is a match it returns the associated . If there are more or less than one match BUT no - it throws an exception. - - - - Clears the internal cache. - - - - - Defines a 3D vector. - - - - - Retrieves or sets the x component of the 3D vector. - - - - - Retrieves or sets the y component of the 3D vector. - - - - - Retrieves or sets the z component of the 3D vector. - - - - - Initializes a new instance of the structure. - - The value to use for the x, y and z component of the 3D vector. - - - - Initializes a new instance of the structure. - - The x component of the 3D vector. - The y component of the 3D vector.. - The z component of the 3D vector. - - - - Returns a string that represents the 3D vector. - - A string that represents the 3D vector. - - - - This class is based on the CUETools.NET BitReader (see http://sourceforge.net/p/cuetoolsnet/code/ci/default/tree/CUETools.Codecs/BitReader.cs) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - Represents a read- and writeable buffer which can hold a specified number of elements. - - Specifies the type of the elements to store. - - - - Initializes a new instance of the class. - - Size of the buffer. - - - - Adds new data to the internal buffer. - - Array which contains the data. - Zero-based offset in the (specified in "elements"). - Number of elements to add to the internal buffer. - Number of added elements. - - - - Reads a sequence of elements from the internal buffer of the . - - - An array of elements. When this method returns, the contains the specified - array with the values between and ( + - - 1) replaced by the elements read from the internal buffer. - - - The zero-based offset in the at which to begin storing the data - read from the internal buffer. - - The maximum number of elements to read from the internal buffer. - The total number of elements read into the . - - - - Gets the size of the internal buffer. - - - - - Gets the number of buffered elements. - - - - - Clears the internal buffer. - - - - - Disposes the and releases the internal used buffer. - - - - - Disposes the and releases the internal used buffer. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Default destructor which calls the method. - - - - - Represents a complex number. - - - - - A complex number with a total length of zero. - - - - - Imaginary component of the complex number. - - - - - Real component of the complex number. - - - - - Initializes a new instance of the structure. - - The real component of the complex number. - The imaginary component of the complex number will be set to zero. - - - - Initializes a new instance of the structure. - - The real component of the complex number. - The imaginary component of the complex number. - - - - Gets the absolute value of the complex number. - - - - - Defines an implicit conversion of a complex number to a single-precision floating-point number. - - Complex number. - The absolute value of the . - - - - Defines an implicit conversion of a complex number to a double-precision floating-point number. - - Complex number. - The absolute value of the . - - - - Implements the operator ==. - - The complex1. - The complex2. - - The result of the operator. - - - - - Implements the operator !=. - - The complex1. - The complex2. - - The result of the operator. - - - - - Indicates whether the current complex value is equal to another complex value. - - A complex value to compare with this complex value. - - true if the current complex value is equal to the complex value; otherwise, false. - - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - This class is based on the CUETools.NET project (see http://sourceforge.net/p/cuetoolsnet/) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - This class is based on the CUETools.NET project (see http://sourceforge.net/p/cuetoolsnet/) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - This class is based on the CUETools.NET project (see http://sourceforge.net/p/cuetoolsnet/) - The author "Grigory Chudov" explicitly gave the permission to use the source as part of the cscore source code which got licensed under the ms-pl. - - - - - Values that are used in activation calls to indicate the execution contexts in which an object is to be run. - - - - - The code that creates and manages objects of this class is a DLL that runs in the same process as the caller of the function specifying the class context. - - - - - Indicates a handler dll, which runs on the same process as the caller. - - - - - Indicates a server executable, which runs on the same machine but on a different process than the caller. - - - - - Obsolete. - - - - - Indicates a server executable, which runs on a different machine than the caller. - - - - - Obsolete. - - - - - Reserved. - - - - - Reserved. - - - - - Reserved. - - - - - Reserved. - - - - - Indicates that code should not be allowed to be downloaded from the Directory Service (if any) or the Internet. - - - - - Reserved. - - - - - Specify if you want the activation to fail if it uses custom marshalling. - - - - - Enables the downloading of code from the directory service or the Internet. - - - - - Indicates that no log messages about activation failure should be written to the Event Log. - - - - - Indicates that activate-as-activator capability is disabled for this activation only. - - - - - Indicates that activate-as-activator capability is enabled for this activation only. - - - - - Indicates that activation should begin from the default context of the current apartment. - - - - - Activate or connect to a 32-bit version of the server; fail if one is not registered. - - - - - Activate or connect to a 64 bit version of the server; fail if one is not registered. - - - - - When this flag is specified, COM uses the impersonation token of the thread, if one is present, for the activation request made by the thread. When this flag is not specified or if the thread does not have an impersonation token, COM uses the process token of the thread's process for the activation request made by the thread. - - - - - Indicates activation is for an app container. Reserved for internal use. - - - - - Specify this flag for Interactive User activation behavior for As-Activator servers. - - - - - Used for loading Proxy/Stub DLLs. - - - - - Bitwise combination of the and the constants. - - - - - Bitwise combination of the , the and the constants. - - - - - Bitwise combination of the and the constants. - - - - - Managed implementation of the interface. See . - - - - - Initializes a new instance of the class. - - Underlying . - - - - Initializes a new instance of the class. - - Underlying . - Indicates whether the underlying stream should be disposed on . - - - - Creates a new stream object with its own seek pointer that references the same bytes as the original stream. - - When this method returns, contains the new stream object. This parameter is passed uninitialized. - HRESULT - - - - Ensures that any changes made to a stream object that is open in transacted mode are reflected in the parent storage. - - A value that controls how the changes for the stream object are committed. - HRESULT - - - - Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. - - A reference to the destination stream. - The number of bytes to copy from the source stream. - On successful return, contains the actual number of bytes read from the source. - On successful return, contains the actual number of bytes written to the destination. - HRESULT - - - - Restricts access to a specified range of bytes in the stream. - - The byte offset for the beginning of the range. - The length of the range, in bytes, to restrict. - The requested restrictions on accessing the range. - HRESULT - - - - Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. - - When this method returns, contains the data read from the stream. This parameter is passed uninitialized. - The number of bytes to read from the stream object. - A pointer to a ULONG variable that receives the actual number of bytes read from the stream object. - HRESULT - - - - Discards all changes that have been made to a transacted stream since the last Commit call. - - HRESULT - - - - Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer. - - The displacement to add to dwOrigin. - The origin of the seek. The origin can be the beginning of the file, the current seek pointer, or the end of the file. - On successful return, contains the offset of the seek pointer from the beginning of the stream. - HRESULT - - - - Changes the size of the stream object. - - The new size of the stream as a number of bytes. - HRESULT - - - - Retrieves the STATSTG structure for this stream. - - When this method returns, contains a STATSTG structure that describes this stream object. This parameter is passed uninitialized. - Members in the STATSTG structure that this method does not return, thus saving some memory allocation operations. - HRESULT - - - - Removes the access restriction on a range of bytes previously restricted with the LockRegion method. - - The byte offset for the beginning of the range. - The length, in bytes, of the range to restrict. - The access restrictions previously placed on the range. - HRESULT - - - - Writes a specified number of bytes into the stream object starting at the current seek pointer. - - The buffer to write this stream to. - he number of bytes to write to the stream. - On successful return, contains the actual number of bytes written to the stream object. If the caller sets this pointer to Zero, this method does not provide the actual number of bytes written. - HRESULT - - - - Gets a value indicating whether the current stream supports reading. - - - - - Gets a value indicating whether the current stream supports seeking. - - - - - Gets a value indicating whether the current stream supports writing. - - - - - Clears all buffers for this stream and causes any buffered data to be written to the underlying device. - - - - - Gets the length in bytes of the stream. - - - - - Gets or sets the position within the current stream. - - - - - Reads a sequence of bytes from the current stream and advances the position within the stream by the number of bytes read. - - An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the current source. - The zero-based byte offset in buffer at which to begin storing the data read from the current stream. - The maximum number of bytes to be read from the current stream. - The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available, or zero (0) if the end of the stream has been reached. - - - - Sets the position within the current stream. - - A byte offset relative to the origin parameter. - A value of type indicating the reference point used to obtain the new position. - The new position within the current stream. - - - - Sets the length of the current stream. - - The desired length of the current stream in bytes. - - - - Writes a sequence of bytes to the current stream and advances the current position within this stream by the number of bytes written. - - An array of bytes. This method copies count bytes from buffer to the current stream. - The zero-based byte offset in buffer at which to begin copying bytes to the current stream. - The number of bytes to be written to the current stream. - - - - Releases the unmanaged resources used by the Stream and optionally releases the managed resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Closes the current stream and releases any resources (such as sockets and file handles) associated with the current stream. - - - - - Provides the managed definition of the IStream interface. - - - - - Reads a specified number of bytes from the stream object into memory starting at the current seek pointer. - - When this method returns, contains the data read from the stream. This parameter is passed uninitialized. - The number of bytes to read from the stream object. - A pointer to a ULONG variable that receives the actual number of bytes read from the stream object. - HRESULT - - - - Writes a specified number of bytes into the stream object starting at the current seek pointer. - - The buffer to write this stream to. - he number of bytes to write to the stream. - On successful return, contains the actual number of bytes written to the stream object. If the caller sets this pointer to Zero, this method does not provide the actual number of bytes written. - HRESULT - - - - Changes the seek pointer to a new location relative to the beginning of the stream, to the end of the stream, or to the current seek pointer. - - The displacement to add to dwOrigin. - The origin of the seek. The origin can be the beginning of the file, the current seek pointer, or the end of the file. - On successful return, contains the offset of the seek pointer from the beginning of the stream. - HRESULT - - - - Changes the size of the stream object. - - The new size of the stream as a number of bytes. - HRESULT - - - - Copies a specified number of bytes from the current seek pointer in the stream to the current seek pointer in another stream. - - A reference to the destination stream. - The number of bytes to copy from the source stream. - On successful return, contains the actual number of bytes read from the source. - On successful return, contains the actual number of bytes written to the destination. - HRESULT - - - - Ensures that any changes made to a stream object that is open in transacted mode are reflected in the parent storage. - - A value that controls how the changes for the stream object are committed. - HRESULT - - - - Discards all changes that have been made to a transacted stream since the last Commit call. - - HRESULT - - - - Restricts access to a specified range of bytes in the stream. - - The byte offset for the beginning of the range. - The length of the range, in bytes, to restrict. - The requested restrictions on accessing the range. - HRESULT - - - - Removes the access restriction on a range of bytes previously restricted with the LockRegion method. - - The byte offset for the beginning of the range. - The length, in bytes, of the range to restrict. - The access restrictions previously placed on the range. - HRESULT - - - - Retrieves the STATSTG structure for this stream. - - When this method returns, contains a STATSTG structure that describes this stream object. This parameter is passed uninitialized. - Members in the STATSTG structure that this method does not return, thus saving some memory allocation operations. - HRESULT - - - - Creates a new stream object with its own seek pointer that references the same bytes as the original stream. - - When this method returns, contains the new stream object. This parameter is passed uninitialized. - HRESULT - - - - Exception for Com Exceptions. - - - - - Throws an if the is not . - - Errorcode. - Name of the interface which contains the COM-function which returned the specified . - Name of the COM-function which returned the specified . - - - - Name of the Cominterface which caused the error. - - - - - Name of the member of the Cominterface which caused the error. - - - - - Initializes a new instance of the class. - - Errorcode. - Name of the interface which contains the COM-function which returned the specified . - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - The StreamingContext object that supplies the contextual information about the source or destination. - - - - Populates a with the data needed to serialize the target object. - - The to populate with data. - The destination (see StreamingContext) for this serialization. - - - - Exposes methods for enumerating, getting, and setting property values. - - - For more information, - . - - - - - Device description - key - - - - - Device interface enabled - key - - - - - Device interface CLSID - key - - - - - Device friendly name - key - - - - - Audio Endpoint Path - key - - - - - Audio Engine Device Format - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Gets the number of properties available. - - - - - Gets or sets the at the specified index. - - - The . - - The index. - The at the specified index. - - - - Gets or sets the for the specified . - - The key. - - - - Returns an enumerator that iterates through the . - - - A that can be used to iterate through the . - - - - - Returns an enumerator that iterates through the . - - - An object that can be used to iterate through the . - - - - - Gets data for a specific property. - - The zero-based index of the property. - The data of the specified property. - The is bigger or equal to . - - - - Gets data for a specific property. - - The of the property. The key can be obtained by calling the method. - The data of the specified property. - - - - Gets a property key from an item's array of properties. - - The zero-based index of the property key in the array of structures. - The . - - - - Sets a new property value, or replaces or removes an existing value. - - The index of the property. - The new property data. - The is bigger or equal to . - - - - Sets a new property value, or replaces or removes an existing value. - - The of the property. The key can be obtained by calling the method. - The new property data. - - - - Saves a property change. - - - For more information see - . - - - - - Represents a native 4 byte boolean value. - - - - - Represents the boolean value true as a . - - - - - Represents the boolean value false as a . - - - - - Initializes a new instance of the structure based on a boolean value. - - The boolean value. - - - - Returns a value indicating whether this instance is equal to a object. - - A value to compare to this instance. - true if obj has the same value as this instance; otherwise, false. - - - - Returns a value indicating whether this instance is equal to a specified object. - - An object to compare to this instance. - true if obj is a and has the same value as this instance; otherwise, false. - - - - Returns the hash code for this instance. - - A hash code for the current . - - - - Implements the operator ==. - - The left. - The right. - - The result of the operator. - - - - - Implements the operator !=. - - The left. - The right. - - The result of the operator. - - - - - Performs an implicit conversion from to . - - The value. - - The result of the conversion. - - - - - Performs an implicit conversion from to . - - if set to true [value]. - - The result of the conversion. - - - - - Converts the value of this instance to its equivalent string representation (either "True" or "False"). - - The string representation of this instance. - - - - Defines common HRESULT error codes. - - - - - S_OK - - - - - S_FALSE - - - - - E_ABORT - - - - - E_ACCESSDENIED - - - - - E_NOINTERFACE - - - - - E_FAIL - - - - - E_INVALIDARG - - - - - E_POINTER - - - - - E_NOTIMPL - - - - - E_NOTFOUND - - - - - MF_E_ATTRIBUTENOTFOUND - - - - - MF_E_SHUTDOWN - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_INVALIDATED - - - - - AUDCLNT_S_BUFFER_EMPTY - - - - - Blob - - - - - Number of bytes stored in the blob. - - - - - Pointer to a byte array which stores the data. - - - - - Returns the data stored in the . - - The data stored in the - - - - Converts the data stored in the based on an to a string and returns the string. - - Encoding used to convert the data to a string. - String of the stored data. - - - - Returns a that represents the data stored in the as hex string. - - - A that represents the data stored in the as hex string. - - - - - Specifies the FMTID/PID identifier that programmatically identifies a property. - - - For more information, see - . - - - - - A unique GUID for the property. - - - - - A property identifier (PID). - - - - - Initializes a new instance of the struct. - - The unique GUID for the property. - The property identifier (PID). - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - The structure is used to store data. - - For more information, see . - - - - Value type tag. - - - - - Reserved for future use. - - - - - Reserved for future use. - - - - - Reserved for future use. - - - - - VT_I1, Version 1 - - - - - VT_UI1 - - - - - VT_I2 - - - - - VT_UI2 - - - - - VT_I4 - - - - - VT_UI4 - - - - - VT_INT, Version 1 - - - - - VT_UINT, Version 1 - - - - - VT_I8 - - - - - VT_UI8 - - - - - VT_R4 - - - - - VT_R8 - - - - - VT_BOOL - - - - - VT_ERROR - - - - - VT_DATE - - - - - VT_FILETIME - - - - - VT_BLOB - - - - - VT_PTR - - - - - Gets or sets the datatype of the . - - - - - Returns the associated value of the . The type of the returned value is defined through the property. - - The associated value of the . If the datatype is not supported, the method will return null. - Not all datatypes are supported. - - - - Releases the associated memory by calling the PropVariantClear function. - - - - - Returns a that represents the value of this instance. - - - A that represents the value of this instance. - - - - - Represents a native COM object. - - - - - Unsafe native pointer to the COM object. - - - - - Gets a value which indicates whether the got already disposed. - - - - - Native pointer to the COM object. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - The native pointer of the COM object. - - - - Queries supported interfaces/objects on a . - - The being requested. - The queried com interface/object. - - - - Retrieves a pointer to the supported interface on an object. - - Type of the requested . - A pointer to the requested interface. - - - - Retrieves pointers to the supported interfaces on an object. - - The identifier of the interface being requested. - The address of a pointer variable that receives the interface pointer requested in the parameter. - This method returns S_OK if the interface is supported, and E_NOINTERFACE otherwise. If ppvObject is NULL, this method returns E_POINTER. - - - - Retrieves pointers to the supported interfaces on an object. - - The identifier of the interface being requested. - The address of a pointer variable that receives the interface pointer requested in the parameter. - This method returns S_OK if the interface is supported, and E_NOINTERFACE otherwise. If ppvObject is NULL, this method returns E_POINTER. - - - - Increments the reference count for an interface on an object. This method should be called for every new copy of a pointer to an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Increments the reference count for an interface on an object. This method should be called for every new copy of a pointer to an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Decrements the reference count for an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Decrements the reference count for an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Releases the COM object. - - - - - Releases the COM object. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Finalizes an instance of the class. - - - - - Enables clients to get pointers to other interfaces on a given object through the method, and manage the existence of the object through the and methods. - - - - - Retrieves pointers to the supported interfaces on an object. - - The identifier of the interface being requested. - The address of a pointer variable that receives the interface pointer requested in the parameter. - This method returns S_OK if the interface is supported, and E_NOINTERFACE otherwise. If ppvObject is NULL, this method returns E_POINTER. - - - - Increments the reference count for an interface on an object. This method should be called for every new copy of a pointer to an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Decrements the reference count for an interface on an object. - - The method returns the new reference count. This value is intended to be used only for test purposes. - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Contains the new global debug configuration for XAudio2. Used with the - function. - - - - - Bitmask of enabled debug message types. For a list of possible values take look at: - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.xaudio2.xaudio2_debug_configuration(v=vs.85).aspx. - - - - - Message types that will cause an immediate break. For a list of possible values take look at: - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.xaudio2.xaudio2_debug_configuration(v=vs.85).aspx. - - - - - Indicates whether to log the thread ID with each message. - - - - - Indicates whether to log source files and line numbers. - - - - - Indicates whether to log function names. - - - - - Indicates whether to log message timestamps. - - - - - Provides information about an audio device. - - - - - Gets the of the Device. - - - - - Gets the of the Device. - - - - - Gets the of the Device. - - - - - Gets the of the Device. - - - - - Defines an effect chain. - - - - - Number of effects in the effect chain for the voice. - - - - - Pointer to an array of structures containing pointers to XAPO instances. - - - - - Contains information about an XAPO for use in an effect chain. - - - - - Pointer to the IUnknown interface of the XAPO object. - - - - - TRUE if the effect should begin in the enabled state. Otherwise, FALSE. - - - - - Number of output channels the effect should produce. - - - - - Defines filter parameters for a source voice. - - - - - The . - - - - - Filter radian frequency calculated as (2 * sin(pi * (desired filter cutoff frequency) / sampleRate)). - The frequency must be greater than or equal to 0 and less than or equal to 1.0f. - The maximum frequency allowable is equal to the source sound's sample rate divided by - six which corresponds to the maximum filter radian frequency of 1. - For example, if a sound's sample rate is 48000 and the desired cutoff frequency is the maximum - allowable value for that sample rate, 8000, the value for Frequency will be 1. - - - - - Reciprocal of Q factor. Controls how quickly frequencies beyond Frequency are dampened. Larger values - result in quicker dampening while smaller values cause dampening to occur more gradually. - Must be greater than 0 and less than or equal to 1.5f. - - - - - Indicates the filter type. - - - Note Note that the DirectX SDK versions of XAUDIO2 do not support the LowPassOnePoleFilter or the - HighPassOnePoleFilter. - - - - - Attenuates (reduces) frequencies above the cutoff frequency. - - - - - Attenuates frequencies outside a given range. - - - - - Attenuates frequencies below the cutoff frequency. - - - - - Attenuates frequencies inside a given range. - - - - - XAudio2.8 only: Attenuates frequencies above the cutoff frequency. This is a one-pole filter, and - has no effect. - - - - - XAudio2.8 only: Attenuates frequencies below the cutoff frequency. This is a one-pole filter, and - has no effect. - - - - - Flags controlling which voice state data should be returned. - - - - - Calculate all values. - - - - - Calculate all values except . - - - - - Internal used IXAudio2EngineCallback-wrapper. The default implementation of this interface is - . - - - - - OnProcessingPassStart - - - - - OnProcessingPassEnd - - - - - OnCriticalError - - Errorcode - - - - The IXAudio2VoiceCallback interface contains methods that notify the client when certain events happen in a given - . - - - - - Called during each processing pass for each voice, just before XAudio2 reads data from the voice's buffer queue. - - - The number of bytes that must be submitted immediately to avoid starvation. This allows the implementation of - just-in-time streaming scenarios; the client can keep the absolute minimum data queued on the voice at all times, - and pass it fresh data just before the data is required. This model provides the lowest possible latency attainable - with XAudio2. For xWMA and XMA data BytesRequired will always be zero, since the concept of a frame of xWMA or XMA - data is meaningless. - Note: In a situation where there is always plenty of data available on the source voice, BytesRequired should - always report zero, because it doesn't need any samples immediately to avoid glitching. - - - - - Called just after the processing pass for the voice ends. - - - - - Called when the voice has just finished playing a contiguous audio stream. - - - - - Called when the voice is about to start processing a new audio buffer. - - - Context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when the voice finishes processing a buffer. - - - Context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when the voice reaches the end position of a loop. - - - Context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when a critical error occurs during voice processing. - - - Context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - The HRESULT code of the error encountered. - - - - Specifies values for the and - . - - - - - Log nothing. - - - - - Log error messages. - - - - - Log warning messages. Note: Enabling also enables . - - - - - Log informational messages. - - - - - Log detailed informational messages. Note: Enabling also enables . - - - - - Log public API function entries and exits. - - - - - Log internal function entries and exits. Note: Enabling also enables - . - - - - - Log delays detected and other timing data. - - - - - Log usage of critical sections and mutexes. - - - - - Log memory heap usage information. - - - - - Log audio streaming information. - - - - - All - - - - - Contains performance information. Used by . - - - - - CPU cycles spent on audio processing since the last call to the or - function. - - - - - Total CPU cycles elapsed since the last call. Note: This only counts cycles on the CPU on which XAudio2 is running. - - - - - Fewest CPU cycles spent on processing any single audio quantum since the last call. - - - - - Most CPU cycles spent on processing any single audio quantum since the last call. - - - - - Total memory currently in use. - - - - - Minimum delay that occurs between the time a sample is read from a source buffer and the time it reaches the - speakers. - - - - - Total audio dropouts since the engine started. - - - - - Number of source voices currently playing. - - - - - Total number of source voices currently in existence. - - - - - Number of submix voices currently playing. - - - - - Number of resampler xAPOs currently active. - - - - - Number of matrix mix xAPOs currently active. - - - - - Not supported on Windows. Xbox 360. Number of source voices decoding XMA data. - - - - - Not supported on Windows. A voice can use more than one XMA stream. - - - - - Flags that specify how a is stopped. - - - - - None - - - - - Continue emitting effect output after the voice is stopped. - - - - - Extends the the to enable real-time audio streaming. - - - - - Initializes a new instance of the class with a default buffer size of 100ms. - - Instance of the class, used to create the . - The instance which provides audio data to play. - - - - Initializes a new instance of the class. - - Instance of the class, used to create the . - The instance which provides audio data to play. - - Buffersize of the internal buffers, in milliseconds. Values in the range from 70ms to - 200ms are recommended. - - - - - Initializes a new instance of the class. - - Pointer to a object. - - instance which receives notifications from the - which got passed as a pointer (see the argument). - - which provides the audio data to stream. - - Buffersize of the internal used buffers in milliseconds. Values in the range from 70ms to - 200ms are recommended. - - It is recommended to use the method instead of the this constructor. - - - - Creates an instance of the class. - - Instance of the class. - which provides the audio data to stream. - - Buffersize of the internal used buffers in milliseconds. Values in the range from 70ms to - 200ms are recommended. - - Configured instance. - - - - Occurs when the playback stops and no more data is available. - - This event occurs whenever the event occurs. - - - - Notifies the class that new data got requested. If there are any buffers which - are currently not queued and the underlying holds any more data, this data refills the - internal used buffers and provides audio data to play. - - - - - Stops and disposes the , closes the internal used waithandle and frees the - allocated memory of all used buffers. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Provides a mechanism for playing instances. - - - - - Maximum amount of instances a can - contain. - - Limited by the method. - - - - Gets the default singleton instance. - - - - - Gets the number of items which got added to the . - - - - - Disposes the . - - - - - Adds a to the . - - - The instance to add to the - . - - - - - Removes a from the . - - - The instance to remove from the - . - - - - - Disposes the and stops the internal playback thread. - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls the method. - - - - - Default implementation of the interface. - - - - - Called during each processing pass for each voice, just before XAudio2 reads data from the voice's buffer queue. - The only argument passed to the eventhandler is the number of required bytes: - The number of bytes that must be submitted immediately to avoid starvation. This allows the implementation of - just-in-time streaming scenarios; the client can keep the absolute minimum data queued on the voice at all times, - and pass it fresh data just before the data is required. This model provides the lowest possible latency attainable - with XAudio2. For xWMA and XMA data BytesRequired will always be zero, since the concept of a frame of xWMA or XMA - data is meaningless. - Note: In a situation where there is always plenty of data available on the source voice, BytesRequired should - always report zero, because it doesn't need any samples immediately to avoid glitching. - - - - - Called just after the processing pass for the voice ends. - - - - - Called when the voice has just finished playing a contiguous audio stream. - - - - - Called when the voice is about to start processing a new audio buffer. - The only argument passed to the eventhandler is a context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when the voice finishes processing a buffer. - The only argument passed to the eventhandler is a context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when the voice reaches the end position of a loop. - The only argument passed to the eventhandler is a context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - - - - - Called when a critical error occurs during voice processing. - The first argument passed to the eventhandler is a context pointer that was assigned to the pContext member of the - structure when the buffer was submitted. - The second argument passed to the eventhandler is the HRESULT error code of the critical error. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - 2 - - - - Contains information about the creation flags, input channels, and sample rate of a voice. - - - - - Flags used to create the voice; see the individual voice interfaces for more information. - - - - - Flags that are currently set on the voice. - - - - - The number of input channels the voice expects. - - - - - The input sample rate the voice expects. - - - - - VoiceFlags - - - - - None - - - - - No pitch control is available on the voice. - - - - - No sample rate conversion is available on the voice. The voice's outputs must have the same sample rate. - - - - - The filter effect should be available on this voice. - - - - - XAudio2.8 only: Not supported on Windows. - - - - - XAudio2.7 only: Indicates that no samples were played. - - - - - Defines a destination voice that is the target of a send from another voice and specifies whether a filter should - be used. - - - - - Either or . - - - - - The destination voice. - - - - - Creates a new instance of the structure. - - The . Must be either or . - The destination voice. Must not be null. - - - - Creates a new instance of the structure. - - The . Must be either or . - Pointer to the destination voice. Must not be . - - - - VoiceSendFlags - - - - - None. - - - - - Indicates a filter should be used on a voice send. - - - - - Defines a set of voices to receive data from a single output voice. - - - - - Number of voices to receive the output of the voice. An OutputCount value of 0 indicates the voice should not send - output to any voices. - - - - - Array of s. - - - - - Returns the voice's current state and cursor position data. - - - - - Pointer to a buffer context provided in the that is processed currently, or, - if the voice is stopped currently, to the next buffer due to be processed. - is NULL if there are no buffers in the queue. - - - - - Number of audio buffers currently queued on the voice, including the one that is processed currently. - - - - - Total number of samples processed by this voice since it last started, or since the last audio stream ended (as - marked with the flag). - This total includes samples played multiple times due to looping. - Theoretically, if all audio emitted by the voice up to this time is captured, this parameter would be the length of - the audio stream in samples. - If you specify when you call - , - this member won't be calculated, and its value is unspecified on return from - . - takes about one-third as much time to - complete when you specify . - - - - - Flags which define calculate flags for calculating the 3D audio parameters. - - - - - Enables matrix coefficient table calculation. - - - - - Enables delay time array calculation (stereo only). - - - - - Enables low pass filter (LPF) direct-path coefficient calculation. - - - - - Enables LPF reverb-path coefficient calculation. - - - - - Enables reverb send level calculation. - - - - - Enables Doppler shift factor calculation. - - - - - Enables emitter-to-listener interior angle calculation. - - - - - Fills the center channel with silence. This flag allows you to keep a 6-channel matrix so you do not have to remap the channels, but the center channel will be silent. This flag is only valid if you also set . - - - - - Applies an equal mix of all source channels to a low frequency effect (LFE) destination channel. It only applies to matrix calculations with a source that does not have an LFE channel and a destination that does have an LFE channel. This flag is only valid if you also set . - - - - - Specifies directionality for a single-channel non-Low-Frequency-Effect emitter by scaling DSP behavior with respect to the emitter's orientation. - - - For a detailed explanation of sound cones see . - - - - - X3DAUDIO_2PI - - - - - Inner cone angle in radians. This value must be within 0.0f to . - - - - - Outer cone angle in radians. This value must be within InnerAngle to . - - - - - Volume scaler on/within inner cone. This value must be within 0.0f to 2.0f. - - - - - Volume scaler on/beyond outer cone. This value must be within 0.0f to 2.0f. - - - - - LPF direct-path or reverb-path coefficient scaler on/within inner cone. This value is only used for LPF calculations and must be within 0.0f to 1.0f. - - - - - LPF direct-path or reverb-path coefficient scaler on or beyond outer cone. This value is only used for LPF calculations and must be within 0.0f to 1.0f. - - - - - Reverb send level scaler on or within inner cone. This must be within 0.0f to 2.0f. - - - - - Reverb send level scaler on/beyond outer cone. This must be within 0.0f to 2.0f. - - - - - Defines a DSP setting at a given normalized distance. - - - - - Normalized distance. This must be within 0.0f to 1.0f. - - - - - DSP control setting. - - - - - Receives the results from a call to . - See http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.x3daudio.x3daudio_dsp_settings%28v=vs.85%29.aspx for more details. - - - - - Caller provided array that will be initialized with the volume level of each source channel present in each - destination channel. The array must have at least ( × ) - elements. The array is arranged with the source channels as the column index of the array and the destination - channels as the row index of the array. - - - - - Caller provided delay time array, which receives delays for each destination channel in milliseconds. This array - must have at least elements. X3DAudio doesn't actually perform the delay. It simply - returns the - coefficients that may be used to adjust a delay DSP effect placed in the effect chain. The - member can - be NULL if the flag is not specified when calling - . - Note This member is only returned when X3DAudio is initialized for stereo output. For typical Xbox 360 usage, it - will not return any data at all. - - - - - Number of source channels. This must be initialized to the number of emitter channels before calling - . - - - - - Number of source channels. This must be initialized to the number of emitter channels before calling - . - - - - - LPF direct-path coefficient. Only calculated if the flag is specified when - calling . - When using X3DAudio with XAudio2 the value returned in the LPFDirectCoefficient member would be applied to a low - pass filter on a source voice with . - - - - - LPF reverb-path coefficient. Only calculated if the flag is specified when - calling . - - - - - Reverb send level. Only calculated if the flag is specified when calling - . - - - - - Doppler shift factor. Scales the resampler ratio for Doppler shift effect, where: - effective_frequency = DopplerFactor × original_frequency. - Only calculated if the flag is specified when calling - . - When using X3DAudio with XAudio2 the value returned in the DopplerFactor would be applied to a source voice with - . - - - - - Emitter-to-listener interior angle, expressed in radians with respect to the emitter's front orientation. - Only calculated if the flag is specified when calling - . - - - - - Distance in user-defined world units from the listener to the emitter base position. - - - - - Component of emitter velocity vector projected onto emitter-to-listener vector in user-defined world units per - second. - Only calculated if the flag is specified when calling - . - - - - - Component of listener velocity vector projected onto the emitter->listener vector in user-defined world units per - second. Only calculated if the flag is specified when calling - . - - - - - Gets the caller provided array that will be initialized with the volume level of each source channel present in each - destination channel. The array must have at least ( × ) - elements. The array is arranged with the source channels as the column index of the array and the destination - channels as the row index of the array. - - - - - Gets the caller provided delay time array, which receives delays for each destination channel in milliseconds. This array - must have at least elements. X3DAudio doesn't actually perform the delay. It simply - returns the - coefficients that may be used to adjust a delay DSP effect placed in the effect chain. This won't be calculated if the flag is not specified when calling - . - - - - - Gets the number of source channels. - - - - - Gets the number of source channels. - - - - - Gets the LPF direct-path coefficient. Only calculated if the flag is specified when - calling . - When using X3DAudio with XAudio2 the value returned in the LPFDirectCoefficient member would be applied to a low - pass filter on a source voice with . - - - - - Gets the LPF reverb-path coefficient. Only calculated if the flag is specified when - calling . - - - - - Gets the reverb send level. Only calculated if the flag is specified when calling - . - - - - - Gets the doppler shift factor. Scales the resampler ratio for Doppler shift effect, where: - effective_frequency = DopplerFactor × original_frequency. - Only calculated if the flag is specified when calling - . - When using X3DAudio with XAudio2 the value returned in the DopplerFactor would be applied to a source voice with - . - - - - - Gets the emitter-to-listener interior angle, expressed in radians with respect to the emitter's front orientation. - Only calculated if the flag is specified when calling - . - - - - - Gets the distance in user-defined world units from the listener to the emitter base position. - - - - - Gets the component of emitter velocity vector projected onto emitter-to-listener vector in user-defined world units per - second. - Only calculated if the flag is specified when calling - . - - - - - Gets the component of listener velocity vector projected onto the emitter->listener vector in user-defined world units per - second. Only calculated if the flag is specified when calling - . - - - - - Initializes a new instance of the class. - - The number of source channels. - The number of destination channels. - - - - Defines a single-point or multiple-point 3D audio source that is used with an arbitrary number of sound channels. - - - - - Gets or sets the sound cone. Used only with single-channel emitters for matrix, LPF (both direct and reverb paths), and reverb calculations. NULL specifies the emitter is omnidirectional. - - - - - Gets or sets the orientation of the front direction. This value must be orthonormal with . must be normalized when used. For single-channel emitters without cones is only used for emitter angle calculations. For multi channel emitters or single-channel with cones is used for matrix, LPF (both direct and reverb paths), and reverb calculations. - - - - - Gets or sets the orientation of the top direction. This value must be orthonormal with . is only used with multi-channel emitters for matrix calculations. - - - - - Gets or sets the position in user-defined world units. This value does not affect . - - - - - Gets or sets the velocity vector in user-defined world units/second. This value is used only for doppler calculations. It does not affect . - - - - - Gets or sets the value to be used for the inner radius calculations. If is 0, then no inner radius is used, but may still be used. This value must be between 0.0f and FLT_MAX. - - - - - Gets or sets the value to be used for the inner radius angle calculations. This value must be between 0.0f and /4.0 (which equals 45°). - - - - - Gets or sets the number of emitters defined by the class. Must be greater than 0. - - - - - Gets or sets the distance from that channels will be placed if is greater than 1. is only used with multi-channel emitters for matrix calculations. Must be greater than or equal to 0.0f. - - - - - Gets or sets the table of channel positions, expressed as an azimuth in radians along the channel radius with respect to the front orientation vector in the plane orthogonal to the top orientation vector. An azimuth of 2* specifies a channel is a low-frequency effects (LFE) channel. LFE channels are positioned at the emitter base and are calculated with respect to only, never . must have at least elements, but can be NULL if = 1. The table values must be within 0.0f to 2*. is used with multi-channel emitters for matrix calculations. - - - - - Gets or sets the volume-level distance curve, which is used only for matrix calculations. NULL specifies a specialized default curve that conforms to the inverse square law, such that when distance is between 0.0f and × 1.0f, no attenuation is applied. When distance is greater than × 1.0f, the amplification factor is (× 1.0f)/distance. At a distance of × 2.0f, the sound will be at half volume or -6 dB, at a distance of × 4.0f, the sound will be at one quarter volume or -12 dB, and so on. and are independent of each other. does not affect LFE channel volume. - - - - - Gets or sets the LFE roll-off distance curve, or NULL to use default curve: [0.0f, ×1.0f], [ ×1.0f, 0.0f]. A NULL value for specifies a default curve that conforms to the inverse square law with distances <= clamped to no attenuation. and are independent of each other. does not affect non LFE channel volume. - - - - - Gets or sets the low-pass filter (LPF) direct-path coefficient distance curve, or NULL to use the default curve: [0.0f, 1.0f], [1.0f, 0.75f]. is only used for LPF direct-path calculations. - - - - - Gets or sets the LPF reverb-path coefficient distance curve, or NULL to use default curve: [0.0f, 0.75f], [1.0f, 0.75f]. is only used for LPF reverb path calculations. - - - - - Gets or sets the reverb send level distance curve, or NULL to use default curve: [0.0f, 1.0f], [1.0f, 0.0f]. - - - - - Gets or sets the curve distance scaler that is used to scale normalized distance curves to user-defined world units, and/or to exaggerate their effect. This does not affect any other calculations. The value must be within the range FLT_MIN to FLT_MAX. is only used for matrix, LPF (both direct and reverb paths), and reverb calculations. - - - - - Doppler shift scaler that is used to exaggerate Doppler shift effect. is only used for Doppler calculations and does not affect any other calculations. The value must be within the range 0.0f to FLT_MAX. - - - - - Defines a point of 3D audio reception. - - - A listener's front and top vectors must be orthonormal. To be considered orthonormal, a pair of vectors must - have a magnitude of 1 +- 1x10-5 and a dot product of 0 +- 1x10-5. - - - - - Gets or sets the orientation of front direction. When is NULL OrientFront is used only for - matrix and delay calculations. When is not NULL OrientFront is used for matrix, LPF (both - direct and reverb paths), and reverb calculations. This value must be orthonormal with - when used. - - - - - Gets or sets the orientation of top direction, used only for matrix and delay calculations. This value must be - orthonormal with when used. - - - - - Gets or sets the position in user-defined world units. This value does not affect . - - - - - Gets or sets the velocity vector in user-defined world units per second, used only for doppler calculations. This - value does not affect . - - - - - Gets or sets the to use. Providing a listener cone will specify that additional calculations - are performed when determining the volume and filter DSP parameters for individual sound sources. A NULL - value specifies an omnidirectional sound and no cone processing is applied. - is only used for matrix, LPF (both direct and reverb paths), and reverb calculations. - - - - - Provides access to the X3DAudio functions. - - - - - Initializes a new instance of the class. - - Assignment of channels to speaker positions. This value must not be zero. - - - - Initializes a new instance of class. - - - Speed of sound, in user-defined world units per second. Use this value only for doppler - calculations. It must be greater than or equal to zero. - - Assignment of channels to speaker positions. This value must not be zero. - - - - Calculates DSP settings with respect to 3D parameters. - - Represents the point of reception. - Represents the sound source. - Bitwise combination of specifying which 3D parameters to calculate. - - Instance of the class that receives the calculation results. - - - - - Disposes the instance. - - - - - Destructor which calls . - - - - - X3DAUDIO_HANDLE is an opaque data structure. Because the operating system doesn't allocate any additional storage - for the 3D audio instance handle, you don't need to free or close it. - - - - - is the class for the XAudio2 object that manages all audio engine states, the audio - processing thread, the voice graph, and so forth. - - - - - The denominator of a quantum unit. In 10ms chunks (= 1/100 seconds). - - - - - Minimum sample rate is 1000 Hz. - - - - - Maximum sample rate is 200 kHz. - - - - - The minimum frequency ratio is 1/1024. - - - - - Maximum frequency ratio is 1024. - - - - - The default value for the frequency ratio is 4. - - - - - The maximum number of supported channels is 64. - - - - - Value which indicates that the default number of channels should be used. - - - - - Values which indicates that the default sample rate should be used. - - - - - Value which can be used in combination with the method to commit all - changes. - - - - - Values which indicates that the made changes should be commited instantly. - - - - - Fired by XAudio2 just before an audio processing pass begins. - - - - - Fired by XAudio2 just after an audio processing pass ends. - - - - - Fired if a critical system error occurs that requires XAudio2 to be closed down and restarted. - - - - - Internal default ctor. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - The XAudio2 subversion to use. - - - - Gets current resource usage details, such as available memory or CPU usage. - - - - - Gets the default device which can be used to create a mastering voice. - - Using XAudio2.7 the default device is 0 (as an integer). Using XAudio2.8 the default device is null. - - - - Gets the of the XAudio2 object. - - - - - Creates a new instance of the class. - If no supported XAudio2 version is available, the CreateXAudio2 method throws an - . - - A new instance. - - - - Creates a new instance of the class. - If no supported XAudio2 version is available, the CreateXAudio2 method throws an - . - - The to use. - A new instance. - - - - Adds an from the engine callback list. - - - object to add to the engine - callback list. - - HRESULT - - - - Adds an from the engine callback list. - - - object to add to the engine - callback list. - - - - - Removes an from the engine callback list. - - - object to remove from the engine - callback list. If the given interface is present more than once in the list, only the first instance in the list - will be removed. - - - - - Creates and configures a source voice. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2.ixaudio2.createsourcevoice(v=vs.85).aspx. - - If successful, returns a pointer to the new object. - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The sample - rate of a source voice must be between and . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - - Highest allowable frequency ratio that can be set on this voice. The value for this - argument must be between and . - - - Client-provided callback interface, . This parameter is - optional and can be null. - - - List of structures that describe the set of destination voices for the - source voice. If is NULL, the send list defaults to a single output to the first - mastering - voice created. - - - List of structures that describe an effect chain to use in the - source voice. This parameter is optional and can be null. - - HRESULT -
- - - Creates and configures a source voice. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2.ixaudio2.createsourcevoice(v=vs.85).aspx. - - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The - sample rate of a source voice must be between and - . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - - Highest allowable frequency ratio that can be set on this voice. The value for this - argument must be between and . - - - Client-provided callback interface, . This parameter is - optional and can be null. - - - List of structures that describe the set of destination voices for the - source voice. If is NULL, the send list defaults to a single output to the first - mastering - voice created. - - - List of structures that describe an effect chain to use in the - source voice. This parameter is optional and can be null. - - If successful, returns a pointer to the new object. -
- - - Creates and configures a source voice. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2.ixaudio2.createsourcevoice(v=vs.85).aspx. - - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The - sample rate of a source voice must be between and - . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - - Highest allowable frequency ratio that can be set on this voice. The value for this - argument must be between and . - - - Client-provided callback interface, . This parameter is - optional and can be null. - - - List of structures that describe the set of destination voices for the - source voice. If is NULL, the send list defaults to a single output to the first - mastering - voice created. - - - List of structures that describe an effect chain to use in the - source voice. This parameter is optional and can be null. - - If successful, returns a new object. -
- - - Creates and configures a source voice. - - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The - sample rate of a source voice must be between and - . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - If successful, returns a new object. -
- - - Creates and configures a source voice. - - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The - sample rate of a source voice must be between and - . - - If successful, returns a new object. -
- - - Creates and configures a submix voice. - - On success, returns a pointer to the new object. - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - - An arbitrary number that specifies when this voice is processed with respect to other - submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices - that include a smaller value and before all other voices that include a larger - value. Voices that include the same value - are - processed in any order. A submix voice cannot send to another submix voice with a lower or equal - value. This prevents audio being lost due to a submix cycle. - - - List of structures that describe the set of destination voices for the - submix voice. If is NULL, the send list will default to a single output to the first - mastering voice created. - - - List of structures that describe an effect chain to use in the - submix voice. This parameter is optional and can be null. - - HRESULT - - - - Creates and configures a submix voice. - - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - - An arbitrary number that specifies when this voice is processed with respect to other - submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices - that include a smaller value and before all other voices that include a larger - value. Voices that include the same value - are - processed in any order. A submix voice cannot send to another submix voice with a lower or equal - value. This prevents audio being lost due to a submix cycle. - - - List of structures that describe the set of destination voices for the - submix voice. If is NULL, the send list will default to a single output to the first - mastering voice created. - - - List of structures that describe an effect chain to use in the - submix voice. This parameter is optional and can be null. - - On success, returns a pointer to the new object. - - - - Creates and configures a submix voice. - - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - - An arbitrary number that specifies when this voice is processed with respect to other - submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices - that include a smaller value and before all other voices that include a larger - value. Voices that include the same value - are - processed in any order. A submix voice cannot send to another submix voice with a lower or equal - value. This prevents audio being lost due to a submix cycle. - - - List of structures that describe the set of destination voices for the - submix voice. If is NULL, the send list will default to a single output to the first - mastering voice created. - - - List of structures that describe an effect chain to use in the - submix voice. This parameter is optional and can be null. - - On success, returns a new object. - - - - Creates and configures a submix voice. - - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - On success, returns a new object. - - - - Creates and configures a mastering voice. - - If successful, returns a pointer to the new object. - - Number of channels the mastering voice expects in its input audio. must be less - than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - Flags that specify the behavior of the mastering voice. Must be 0. - - Identifier of the device to receive the output audio. - Specifying the default value of NULL (for XAudio2.8) or 0 (for XAudio2.7) causes - XAudio2 to select the global default audio device. - - On XAudio2.7: Use the and the method to enumerate device. Pass its index (valid range from 0 to ) to the argument. - On XAudio2.8: Use the class to enumerate objects. Pass its to the argument. - - - structure that describes an effect chain to use in the mastering - voice, or NULL to use no effects. - - The audio stream category to use for this mastering voice. - HRESULT - - - - Creates and configures a mastering voice. - - - Number of channels the mastering voice expects in its input audio. must be less - than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - Flags that specify the behavior of the mastering voice. Must be 0. - - Identifier of the device to receive the output audio. - Specifying the default value of NULL (for XAudio2.8) or 0 (for XAudio2.7) causes - XAudio2 to select the global default audio device. - - On XAudio2.7: Use the and the method to enumerate device. Pass its index (valid range from 0 to ) to the argument. - On XAudio2.8: Use the class to enumerate objects. Pass its to the argument. - - - structure that describes an effect chain to use in the mastering - voice, or NULL to use no effects. - - The audio stream category to use for this mastering voice. - If successful, returns a pointer to the new object. - - - - Creates and configures a mastering voice. - - - Number of channels the mastering voice expects in its input audio. must be less - than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - - Identifier of the device to receive the output audio. - Specifying the default value of NULL (for XAudio2.8) or 0 (for XAudio2.7) causes - XAudio2 to select the global default audio device. - - On XAudio2.7: Use the and the method to enumerate device. Pass its index (valid range from 0 to ) to the argument. - On XAudio2.8: Use the class to enumerate objects. Pass its to the argument. - - - structure that describes an effect chain to use in the mastering - voice, or NULL to use no effects. - - XAudio2.8 only: The audio stream category to use for this mastering voice. - If successful, returns a new object. - - - - Creates and configures a mastering voice. - - - Number of channels the mastering voice expects in its input audio. must be less - than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - - Identifier of the device to receive the output audio. - Specifying the default value of NULL (for XAudio2.8) or 0 (for XAudio2.7) causes - XAudio2 to select the global default audio device. - - On XAudio2.7: Use the and the method to enumerate device. Pass its index (valid range from 0 to ) to the argument. - On XAudio2.8: Use the class to enumerate objects. Pass its to the argument. - - If successful, returns a new object. - - - - Creates and configures a mastering voice. - - - Number of channels the mastering voice expects in its input audio. must be less - than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - If successful, returns a new object. - - - - Creates and configures a mastering voice. - - If successful, returns a new object. - - - - Starts the audio processing thread. - - HRESULT - - - - Starts the audio processing thread. - - - - - Stops the audio processing thread. - - - - - Atomically applies a set of operations that are tagged with a given identifier. - - - Identifier of the set of operations to be applied. To commit all pending operations, pass - . - - HRESULT - - - - Atomically applies a set of operations that are tagged with a given identifier. - - - Identifier of the set of operations to be applied. To commit all pending operations, pass - . - - - - - Atomically applies a set of operations that are tagged with a given identifier. - - - - - Returns current resource usage details, such as available memory or CPU usage. - - - On success, pointer to an structure that is - returned. - - HRESULT - - - - Changes global debug logging options for XAudio2. - - structure that contains the new debug configuration. - Reserved parameter. Must me NULL. - HRESULT - - - - Changes global debug logging options for XAudio2. - - structure that contains the new debug configuration. - - - - Returns the default device. - - The default device. - - - - Initializes the engine callback. - - - - - Represents an audio data buffer. - - - - - Maximum non-infinite LoopCount. - - - - - Infinite Loop. - - - - - MaxBufferBytes. See . - - - - - Flags that provide additional information about the audio buffer. - May be or . - - - - - Size of the audio data, in bytes. Must be no larger than for PCM data. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.xaudio2.xaudio2_buffer(v=vs.85).aspx. - - - - - Pointer to the audio data. - - - - - First sample in the buffer that should be played. - For XMA buffers this value must be a multiple of 128 samples. - - - - - Length of the region to be played, in samples. - A value of zero means to play the entire buffer, and, in this case, must be zero as well. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.xaudio2.xaudio2_buffer(v=vs.85).aspx. - - - - - First sample of the region to be looped. The value of must be less than - + . - can be less than . must be 0 if - is 0. - - - - - Length of the loop region, in samples. - The value of + must be greater than and - less than + . - must be zero if is 0. - If is not 0 then a loop length of zero indicates the entire sample should be looped. - - - - - Number of times to loop through the loop region. - This value can be between 0 and . - If LoopCount is zero no looping is performed and and must be 0. - To loop forever, set to . - - - - - Context value to be passed back in callbacks to the client. This may be . - - - - - Initializes a new instance of the structure. - - - - - - Returns a instance for the underlying . - - Call - - - - - - - Frees the allocated memory. - - - - - Frees the allocated memory. - - - - - Provides data for the , the and the - event. - - - - - Initializes a new instance of the class. - - - The context pointer that was assigned to the member - of the structure when the buffer was submitted. - - - - - Gets the context pointer that was assigned to the member of the - structure when the buffer was submitted. - - - - - Flags that provide additional information about the audio buffer. - - - - - None - - - - - Indicates that there cannot be any buffers in the queue after this buffer. The only effect of this flag is to - suppress debug output warnings caused by starvation of the buffer queue. - - - - - XAudio2CriticalErrorEventArgs - - - - - Initializes a new instance of the class. - - Errorcode - - - - Errorcode - - - - - Describes device roles of an XAudio2 Device. Used in . - - - - - Device is not used as the default device for any applications. - - - - - Device is used in audio console applications. - - - - - Device is used to play multimedia. - - - - - Device is used for voice communication. - - - - - Device is used in for games. - - - - - Devices is the default device for all applications. - - - - - The role of the device is not valid. - - - - - XAudio2EngineCallback - - - - - Fired by XAudio2 just before an audio processing pass begins. - - - - - Fired by XAudio2 just after an audio processing pass ends. - - - - - Fired if a critical system error occurs that requires XAudio2 to be closed down and restarted. - - - - - XAudio2-COMException. - - - - - Initializes a new instance of the class. - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - - The StreamingContext object that supplies the contextual information about the source or - destination. - - - - - Throws an if the is not . - - Errorcode. - - Name of the interface which contains the COM-function which returned the specified - . - - Name of the COM-function which returned the specified . - - - - A mastering voice is used to represent the audio output device. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - The to use. - - - - XAudio2.8 only: Gets the channel mask for this voice. - - - - - XAudio2.8 only: Returns the channel mask for this voice. - - - Returns the channel mask for this voice. This corresponds to the - member of the class. - - HRESULT - - - - Provides data for the event. - - - - - Initializes a new instance of the class. - - The number of bytes that must be submitted immediately to avoid starvation. - - - - Gets the number of bytes that must be submitted immediately to avoid starvation. - - - - - Defines values to use with XAudio2Create to specify available processors. - - - - - Processor 1 - - - - - Processor 2 - - - - - Processor 3 - - - - - Processor 4 - - - - - Processor 5 - - - - - Processor 6 - - - - - Processor 7 - - - - - Processor 8 - - - - - Processor 9 - - - - - Processor 10 - - - - - Processor 11 - - - - - Processor 12 - - - - - Processor 13 - - - - - Processor 14 - - - - - Processor 15 - - - - - Processor 16 - - - - - Processor 17 - - - - - Processor 18 - - - - - Processor 19 - - - - - Processor 20 - - - - - Processor 21 - - - - - Processor 22 - - - - - Processor 23 - - - - - Processor 24 - - - - - Processor 25 - - - - - Processor 26 - - - - - Processor 27 - - - - - Processor 28 - - - - - Processor 29 - - - - - Processor 30 - - - - - Processor 31 - - - - - Processor 32 - - - - - Any processor - - - - - Default processor for XAudio2.7, which is defined as . - - - - - Default processor for XAudio2.8, which is defined as . - - - - - Use a source voice to submit audio data to the XAudio2 processing pipeline.You must send voice data to a mastering - voice to be heard, either directly or through intermediate submix voices. - - - - - Gets the of the source voice. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - The to use. - - - - Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering - voices, or to the output device. - - Flags that control how the voice is started. Must be 0. - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering - voices, or to the output device. - - Flags that control how the voice is started. Must be 0. - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Starts consumption and processing of audio by the voice. Delivers the result to any connected submix or mastering - voices, or to the output device. - - - - - Stops consumption of audio by the current voice. - - - Flags that control how the voice is stopped. Can be or - . - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Stops consumption of audio by the current voice. - - - - - Stops consumption of audio by the current voice. - - - Flags that control how the voice is stopped. Can be or - . - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Adds a new audio buffer to the voice queue. - - Pointer to an structure to queue. - Pointer to an additional XAudio2BufferWma structure used when submitting WMA data. - HRESULT - - See - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.submitsourcebuffer(v=vs.85).aspx. - - - - - Adds a new audio buffer to the voice queue. - - structure to queue. - - See - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.submitsourcebuffer(v=vs.85).aspx. - - - - - Removes all pending audio buffers from the voice queue. If the voice is started, the buffer that is currently - playing is not removed from the queue. - - HRESULT - - See - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.flushsourcebuffers(v=vs.85).aspx. - - - - - Removes all pending audio buffers from the voice queue. If the voice is started, the buffer that is currently - playing is not removed from the queue. - - - See - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2sourcevoice.ixaudio2sourcevoice.flushsourcebuffers(v=vs.85).aspx. - - - - - Notifies an XAudio2 voice that no more buffers are coming after the last one that is currently in its queue. - - HRESULT - - - - Notifies an XAudio2 voice that no more buffers are coming after the last one that is currently in its queue. - - - - - Stops looping the voice when it reaches the end of the current loop region. - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Stops looping the voice when it reaches the end of the current loop region. - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Stops looping the voice when it reaches the end of the current loop region. - - - - - Returns the voice's current cursor position data. - - structure containing the state of the voice. - - - - Returns the voice's current cursor position data. - - - XAudio2.8 only: Flags controlling which voice state data should be returned. - Valid values are or . - The default value is . If you specify - , GetState - returns only the buffer state, not the sampler state. - GetState takes roughly one-third as much time to complete when you specify - . - - structure containing the state of the voice. - If the is not the parameter will be ignored. - - - - Sets the frequency adjustment ratio of the voice. - - - Frequency adjustment ratio. This value must be between and - the MaxFrequencyRatio parameter specified when the voice was created - - . - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Sets the frequency adjustment ratio of the voice. - - - Frequency adjustment ratio. This value must be between and - the MaxFrequencyRatio parameter specified when the voice was created - - . - - - Identifies this call as part of a deferred batch. For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Sets the frequency adjustment ratio of the voice. - - - Frequency adjustment ratio. This value must be between and - the MaxFrequencyRatio parameter specified when the voice was created - - . - - - - - Returns the frequency adjustment ratio of the voi - - Current frequency adjustment ratio if successful. - - - - Reconfigures the voice to consume source data at a different sample rate than the rate specified when the voice was - created. - - - The new sample rate the voice should process submitted data at. Valid sample rates - are 1kHz to 200kHz. - - HRESULT - - - - Reconfigures the voice to consume source data at a different sample rate than the rate specified when the voice was - created. - - - The new sample rate the voice should process submitted data at. Valid sample rates - are 1kHz to 200kHz. - - - - - A submix voice is used primarily for performance improvements and effects processing. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - The to use. - - - - Defines supported XAudio2 subversions. - - - - - XAudio2.7 - - - - - XAudio2.8 - - - - - Represents the base class from which , and - are derived. - - - - - Gets the XAudio2 Version. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - The to use. - - - - Gets the of the . - These details include information about the number of input channels, the sample rate and the - . - - - - - Gets or sets the of the . - - - - - Gets or sets the volume of the . The default value is 1.0. - - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Returns information about the creation flags, input channels, and sample rate of a voice. - - object containing information about the voice. - HRESULT - - - - Designates a new set of submix or mastering voices to receive the output of the voice. - - - VoiceSends structure which contains Output voices. If is null, the voice will send - its output to the current mastering voice. All of the voices in a send list must have the same input sample rate. - - HRESULT - - - - Designates a new set of submix or mastering voices to receive the output of the voice. - - - Array of s. if is null, the voice will send - its output to the current mastering voice. - All voices in the must have the same input sample rate. - - - - - Replaces the effect chain of the voice. - - - Describes the new effect chain to use. - If null is passed, the current effect chain is removed. - - HRESULT - - - - Replaces the effect chain of the voice. - - - Describes the new effect chain to use. - If null is passed, the current effect chain is removed. - - - - - Enables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Enables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Enables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - - - Disables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Disables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Disables the effect at a given position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - - - - Returns the running state of the effect at a specified position in the effect chain of the voice. - - Zero-based index of an effect in the effect chain of the voice. - Returns true if the effect is enabled. If the effect is disabled, returns false. - - - - Returns whether the effect at the specified position in the effect chain is enabled. - - Zero-based index of an effect in the effect chain of the voice. - Returns true if the effect is enabled. If the effect is disabled, returns false. - - - - Sets parameters for a given effect in the voice's effect chain. - - Zero-based index of an effect within the voice's effect chain. - New values of the effect-specific parameters. - Size of the array in bytes. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Sets parameters for a given effect in the voice's effect chain. - - Effect parameter. - Zero-based index of an effect within the voice's effect chain. - New values of the effect-specific parameters. - - - - Sets parameters for a given effect in the voice's effect chain. - - Effect parameter. - Zero-based index of an effect within the voice's effect chain. - New values of the effect-specific parameters. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Returns the current effect-specific parameters of a given effect in the voice's effect chain. - - Zero-based index of an effect within the voice's effect chain. - Returns the current values of the effect-specific parameters. - Size of the array in bytes. - HRESULT - - - - Returns the current effect-specific parameters of a given effect in the voice's effect chain. - - Effect parameters. - Zero-based index of an effect within the voice's effect chain. - Effect parameters value. - - - - Sets the voice's filter parameters. - - - structure containing the filter - information. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Sets the voice's filter parameters. - - - structure containing the filter - information. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Gets the voice's filter parameters. - - - structure containing the filter - information. - - HRESULT - - - - Gets the voice's filter parameters. - - structure containing the filter information. - - - - Sets the filter parameters on one of this voice's sends. - - The destination voice of the send whose filter parameters will be set. - - structure containing the filter - information. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Sets the filter parameters on one of this voice's sends. - - The destination voice of the send whose filter parameters will be set. - - structure containing the filter - information. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Sets the filter parameters on one of this voice's sends. - - The destination voice of the send whose filter parameters will be set. - - structure containing the filter - information. - - - - - Returns the filter parameters from one of this voice's sends. - - The destination voice of the send whose filter parameters will be read. - - structure containing the filter - information. - - HRESULT - - - - Returns the filter parameters from one of this voice's sends. - - The destination voice of the send whose filter parameters will be read. - structure containing the filter information. - - - - Sets the overall volume level for the voice. - - Overall volume level to use. See Remarks for more information on volume levels. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Sets the overall volume level for the voice. - - Overall volume level to use. See Remarks for more information on volume levels. - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Gets the current overall volume level of the voice. - - - Returns the current overall volume level of the voice. See Remarks for more information on volume - levels. - - HRESULT - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Gets the current overall volume level of the voice. - - The current overall volume level of the voice. See Remarks for more information on volume levels. - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Sets the volume levels for the voice, per channel. This method is valid only for source and submix voices, because - mastering voices do not specify volume per channel. - - Number of channels in the voice. - - Array containing the new volumes of each channel in the voice. The array must have - elements. See Remarks for more information on volume levels. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Sets the volume levels for the voice, per channel. This method is valid only for source and submix voices, because - mastering voices do not specify volume per channel. - - Number of channels in the voice. - - Array containing the new volumes of each channel in the voice. The array must have - elements. See Remarks for more information on volume levels. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Sets the volume levels for the voice, per channel. This method is valid only for source and submix voices, because - mastering voices do not specify volume per channel. - - Number of channels in the voice. - - Array containing the new volumes of each channel in the voice. The array must have - elements. See Remarks for more information on volume levels. - - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Returns the volume levels for the voice, per channel. - These settings are applied after the effect chain is applied. - This method is valid only for source and submix voices, because mastering voices do not specify volume per channel. - - Confirms the channel count of the voice. - - Returns the current volume level of each channel in the voice. The array must have at least - elements. - See remarks for more information on volume levels. - - HRESULT - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Returns the volume levels for the voice, per channel. - These settings are applied after the effect chain is applied. - This method is valid only for source and submix voices, because mastering voices do not specify volume per channel. - - Confirms the channel count of the voice. - - Returns the current volume level of each channel in the voice. The has at least - elements. - - - The master volume level is applied at different times depending on the type of voice. - For submix and mastering voices the volume level is applied just before the voice's built in filter and effect - chain is applied. - For source voices the master volume level is applied after the voice's filter and effect - chain is applied. Volume levels are expressed as floating-point amplitude multipliers - between -2^24 and 2^24, with a maximum - gain of 144.5 dB. A volume level of 1.0 means there is no attenuation or gain and 0 means silence. - Negative levels can be used to invert the audio's phase. - - - - - Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input - channels of a specified destination voice. - - - Destination for which to set volume levels. - If the voice sends to a single target voice then specifying null will cause SetOutputMatrix to operate on that - target voice. - - - Confirms the output channel count of the voice. This is the number of channels that are - produced by the last effect in the chain. - - Confirms the input channel count of the destination voice. - - Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. - The level sent from source channel S to destination channel D is specified in the form levelMatrix[SourceChannels × - D + S]. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.setoutputmatrix(v=vs.85).aspx. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - HRESULT - - - - Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input - channels of a specified destination voice. - - - Destination for which to set volume levels. - If the voice sends to a single target voice then specifying null will cause SetOutputMatrix to operate on that - target voice. - - - Confirms the output channel count of the voice. This is the number of channels that are - produced by the last effect in the chain. - - Confirms the input channel count of the destination voice. - - Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. - The level sent from source channel S to destination channel D is specified in the form levelMatrix[SourceChannels × - D + S]. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.setoutputmatrix(v=vs.85).aspx. - - - Identifies this call as part of a deferred batch. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/ee415807(v=vs.85).aspx. - - - - - Sets the volume level of each channel of the final output for the voice. These channels are mapped to the input - channels of a specified destination voice. - - - Destination for which to set volume levels. - If the voice sends to a single target voice then specifying null will cause SetOutputMatrix to operate on that - target voice. - - - Confirms the output channel count of the voice. This is the number of channels that are - produced by the last effect in the chain. - - Confirms the input channel count of the destination voice. - - Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. - The level sent from source channel S to destination channel D is specified in the form levelMatrix[SourceChannels × - D + S]. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.setoutputmatrix(v=vs.85).aspx. - - - - - Gets the volume level of each channel of the final output for the voice. These channels are mapped to the input - channels of a specified destination voice. - - The destination to retrieve the output matrix for. - - Confirms the output channel count of the voice. This is the number of channels that are - produced by the last effect in the chain. - - Confirms the input channel count of the destination voice. - - Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. - The level sent from source channel S to destination channel D is specified in the form levelMatrix[SourceChannels × - D + S]. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.getoutputmatrix(v=vs.85).aspx. - - HRESULT - - - - Gets the volume level of each channel of the final output for the voice. These channels are mapped to the input - channels of a specified destination voice. - - The destination to retrieve the output matrix for. - - Confirms the output channel count of the voice. This is the number of channels that are - produced by the last effect in the chain. - - Confirms the input channel count of the destination voice. - - Array of [SourceChannels × DestinationChannels] volume levels sent to the destination voice. - The level sent from source channel S to destination channel D is specified in the form levelMatrix[SourceChannels × - D + S]. - For more details see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2voice.ixaudio2voice.getoutputmatrix(v=vs.85).aspx. - - - - - Destroys the voice. If necessary, stops the voice and removes it from the XAudio2 graph. - - - - - Disposes the and calls the method.. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Provides data for the event. - - - - - Initializes a new instance of the class. - - - The context pointer that was assigned to the member - of the structure when the buffer was submitted. - - The HRESULT code of the error encountered - - - - Gets the HRESULT code of the error encountered. - - - - - is the class for the XAudio2 object that manages all audio engine states, the audio - processing thread, the voice graph, and so forth. - - - - - The denominator of a quantum unit. In 10ms chunks (= 1/100 seconds). - - - - - Minimum sample rate is 1000 Hz. - - - - - Maximum sample rate is 200 kHz. - - - - - The minimum frequency ratio is 1/1024. - - - - - Maximum frequency ratio is 1024. - - - - - The default value for the frequency ratio is 4. - - - - - The maximum number of supported channels is 64. - - - - - Value which indicates that the default number of channels should be used. - - - - - Values which indicates that the default sample rate should be used. - - - - - Value which can be used in combination with the method to commit all changes. - - - - - Values which indicates that the made changes should be commited instantly. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - - - - Initializes a new instance of the class. - - This constructor already calls . Don't call it a second time. - - - - Initializes a new instance of the class. - - - Specifies whether the XAudio2 engine should be created in debug mode. Pass true to enable the debug - mode. - - - Specifies which CPU to use. Use as - default value. - - This constructor already calls . Don't call it a second time. - - - - Returns the number of available audio output devices. - - Number of available audio output devices. - HRESULT - - - - Returns the number of available audio output devices. - - Number of available audio output devices. - - - - Returns information about an audio output device. - - - Index of the device to be queried. This value must be less than the count returned by - . - - structure. - HRESULT - - - - Returns information about an audio output device. - - - Index of the device to be queried. This value must be less than the count returned by - . - - structure. - - - - Sets XAudio2 parameters and prepares XAudio2 for use. - - Flags that specify the behavior of the XAudio2 object. This value must be 0. - - Specifies which CPU to use. Use as default value. - - HRESULT - - - - Sets XAudio2 parameters and prepares XAudio2 for use. - - Flags that specify the behavior of the XAudio2 object. This value must be 0. - - Specifies which CPU to use. Use as default value. - - - - - Adds an from the engine callback list. - - - object to add to the engine - callback list. - - HRESULT - - - - Removes an from the engine callback list. - - - object to remove from the engine - callback list. If the given interface is present more than once in the list, only the first instance in the list - will be removed. - - - - - Creates and configures a source voice. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2.ixaudio2.createsourcevoice(v=vs.85).aspx. - - If successful, returns a pointer to the new object. - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The sample - rate of a source voice must be between and . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - - Highest allowable frequency ratio that can be set on this voice. The value for this - argument must be between and . - - - Client-provided callback interface, . This parameter is - optional and can be null. - - - List of structures that describe the set of destination voices for the - source voice. If is NULL, the send list defaults to a single output to the first mastering - voice created. - - - List of structures that describe an effect chain to use in the - source voice. This parameter is optional and can be null. - - HRESULT -
- - - Creates and configures a submix voice. - - On success, returns a pointer to the new object. - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - - An arbitrary number that specifies when this voice is processed with respect to other - submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices - that include a smaller value and before all other voices that include a larger - value. Voices that include the same value are - processed in any order. A submix voice cannot send to another submix voice with a lower or equal - value. This prevents audio being lost due to a submix cycle. - - - List of structures that describe the set of destination voices for the - submix voice. If is NULL, the send list will default to a single output to the first - mastering voice created. - - - List of structures that describe an effect chain to use in the - submix voice. This parameter is optional and can be null. - - HRESULT - - - - Creates and configures a mastering voice. - - If successful, returns a pointer to the new object. - - Number of channels the mastering voice expects in its input audio. must be less than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - Flags that specify the behavior of the mastering voice. Must be 0. - - Identifier of the device to receive the output audio. Specifying the default value of 0 (zero) - causes XAudio2 to select the global default audio device. - - - structure that describes an effect chain to use in the mastering - voice, or NULL to use no effects. - - Not valid for XAudio 2.7. - HRESULT - - - - Starts the audio processing thread. - - HRESULT - - - - Stops the audio processing thread. - - - - - Atomically applies a set of operations that are tagged with a given identifier. - - - Identifier of the set of operations to be applied. To commit all pending operations, pass - . - - HRESULT - - - - Returns current resource usage details, such as available memory or CPU usage. - - - On success, pointer to an structure that is - returned. - - HRESULT - - - - Changes global debug logging options for XAudio2. - - structure that contains the new debug configuration. - Reserved parameter. Must me NULL. - HRESULT - - - - Returns the default device. - - The default device. - - - - is the class for the XAudio2 object that manages all audio engine states, the audio - processing thread, the voice graph, and so forth. - - - - - The denominator of a quantum unit. In 10ms chunks (= 1/100 seconds). - - - - - Minimum sample rate is 1000 Hz. - - - - - Maximum sample rate is 200 kHz. - - - - - The minimum frequency ratio is 1/1024. - - - - - Maximum frequency ratio is 1024. - - - - - The default value for the frequency ratio is 4. - - - - - The maximum number of supported channels is 64. - - - - - Value which indicates that the default number of channels should be used. - - - - - Values which indicates that the default sample rate should be used. - - - - - Value which can be used in combination with the method to commit all changes. - - - - - Values which indicates that the made changes should be commited instantly. - - - - - Initializes a new instance of the class. - - Native pointer of the object. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - Specifies which CPU to use. Use as - default value. - - - - - Adds an from the engine callback list. - - - object to add to the engine - callback list. - - HRESULT - - - - Removes an from the engine callback list. - - - object to remove from the engine - callback list. If the given interface is present more than once in the list, only the first instance in the list - will be removed. - - - - - Creates and configures a source voice. For more information see - http://msdn.microsoft.com/en-us/library/windows/desktop/microsoft.directx_sdk.ixaudio2.ixaudio2.createsourcevoice(v=vs.85).aspx. - - If successful, returns a pointer to the new object. - - Pointer to a . The following formats are supported: -
    -
  • 8-bit (unsigned) integer PCM
  • 16-bit integer PCM (optimal format for XAudio2)
  • -
  • 20-bit integer PCM (either in 24 or 32 bit containers)
  • -
  • 24-bit integer PCM (either in 24 or 32 bit containers)
  • 32-bit integer PCM
  • -
  • 32-bit float PCM (preferred format after 16-bit integer)
  • -
- The number of channels in a source voice must be less than or equal to . The sample - rate of a source voice must be between and . - - - that specify the behavior of the source voice. A flag can be - or a combination of one or more of the following. - Possible values are , and - . is not supported on Windows. - - - Highest allowable frequency ratio that can be set on this voice. The value for this - argument must be between and . - - - Client-provided callback interface, . This parameter is - optional and can be null. - - - List of structures that describe the set of destination voices for the - source voice. If is NULL, the send list defaults to a single output to the first mastering - voice created. - - - List of structures that describe an effect chain to use in the - source voice. This parameter is optional and can be null. - - HRESULT -
- - - Creates and configures a submix voice. - - On success, returns a pointer to the new object. - - Number of channels in the input audio data of the submix voice. The - must be less than or equal to . - - - Sample rate of the input audio data of submix voice. This rate must be a multiple of - . InputSampleRate must be between and - . - - - Flags that specify the behavior of the submix voice. It can be or - . - - - An arbitrary number that specifies when this voice is processed with respect to other - submix voices, if the XAudio2 engine is running other submix voices. The voice is processed after all other voices - that include a smaller value and before all other voices that include a larger - value. Voices that include the same value are - processed in any order. A submix voice cannot send to another submix voice with a lower or equal - value. This prevents audio being lost due to a submix cycle. - - - List of structures that describe the set of destination voices for the - submix voice. If is NULL, the send list will default to a single output to the first - mastering voice created. - - - List of structures that describe an effect chain to use in the - submix voice. This parameter is optional and can be null. - - HRESULT - - - - Creates and configures a mastering voice. - - If successful, returns a pointer to the new object. - - Number of channels the mastering voice expects in its input audio. must be less than - or equal to . - You can set InputChannels to , which causes XAudio2 to try to detect the system - speaker configuration setup. - - - Sample rate of the input audio data of the mastering voice. This rate must be a multiple of - . must be between - and . - You can set InputSampleRate to , with the default being determined by the current - platform. - - Flags that specify the behavior of the mastering voice. Must be 0. - - Identifier of the device to receive the output audio. Specifying the default value of NULL - causes XAudio2 to select the global default audio device. - - - structure that describes an effect chain to use in the mastering - voice, or NULL to use no effects. - - The audio stream category to use for this mastering voice. - HRESULT - - - - Starts the audio processing thread. - - HRESULT - - - - Stops the audio processing thread. - - - - - Atomically applies a set of operations that are tagged with a given identifier. - - - Identifier of the set of operations to be applied. To commit all pending operations, pass - . - - HRESULT - - - - Returns current resource usage details, such as available memory or CPU usage. - - - On success, pointer to an structure that is - returned. - - HRESULT - - - - Changes global debug logging options for XAudio2. - - structure that contains the new debug configuration. - Reserved parameter. Must me NULL. - HRESULT - - - - Returns the default device. - - The default device. - - - - Defines the format of waveform-audio data for formats having more than two channels or higher sample resolutions - than allowed by . - Can be used to define any format that can be defined by . - For more information see and - . - - - - - Returns the SubType-Guid of a . If the specified does - not contain a SubType-Guid, the gets converted to the equal SubType-Guid - using the method. - - which gets used to determine the SubType-Guid. - SubType-Guid of the specified . - - - - Gets the number of bits of precision in the signal. - Usually equal to . However, is the - container size and must be a multiple of 8, whereas can be any value not - exceeding the container size. For example, if the format uses 20-bit samples, - must be at least 24, but is 20. - - - - - Gets the number of samples contained in one compressed block of audio data. This value is used in buffer - estimation. This value is used with compressed formats that have a fixed number of samples within each block. This - value can be set to 0 if a variable number of samples is contained in each block of compressed audio data. In this - case, buffer estimation and position information needs to be obtained in other ways. - - - - - Gets a bitmask specifying the assignment of channels in the stream to speaker positions. - - - - - Subformat of the data, such as . The subformat information is similar to - that provided by the tag in the class's member. - - - - - Initializes a new instance of the class. - - - Samplerate of the waveform-audio. This value will get applied to the - property. - - - Bits per sample of the waveform-audio. This value will get applied to the - property and the property. - - - Number of channels of the waveform-audio. This value will get applied to the - property. - - Subformat of the data. This value will get applied to the property. - - - - Initializes a new instance of the class. - - - Samplerate of the waveform-audio. This value will get applied to the - property. - - - Bits per sample of the waveform-audio. This value will get applied to the - property and the property. - - - Number of channels of the waveform-audio. This value will get applied to the - property. - - Subformat of the data. This value will get applied to the property. - - Bitmask specifying the assignment of channels in the stream to speaker positions. Thie value - will get applied to the property. - - - - - Converts the instance to a raw instance by converting - the to the equal . - - A simple instance. - - - - Creates a new object that is a copy of the current instance. - - - A copy of the current instance. - - - - - Returns a string which describes the . - - A string which describes the . - - - - Defines the base for all audio streams which provide samples instead of raw byte data. - - - Compared to the , the provides samples instead of raw bytes. - That means that the and the properties - are expressed in samples. - Also the method provides samples instead of raw bytes. - - - - - Defines the base for all aggregators. - - - - - Defines the base for all aggregators. - - - - - Defines the base for all aggregators. - - The type of data, the aggregator provides. - The type of the aggreator type. - - - - Gets the underlying . - - - The underlying . - - - - - Defines the base for all audio streams which provide raw byte data. - - - Compared to the , the provides raw bytes instead of samples. - That means that the and the properties are - expressed in bytes. - Also the method provides samples instead of raw bytes. - - - - - Defines the base for all audio streams. - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets the of the waveform-audio data. - - - - - Gets or sets the current position. The unit of this property depends on the implementation of this interface. Some - implementations may not support this property. - - - - - Gets the length of the waveform-audio data. The unit of this property depends on the implementation of this - interface. Some implementations may not support this property. - - - - - Exception class for all MM-APIs like waveOut or ACM. - - - - - Throws an if the is not - . - - Errorcode. - Name of the function which returned the specified . - - - - Gets the which describes the error. - - - - - Gets the name of the function which caused the error. - - - - - Gets the name of the function which caused the error. - - - - - Initializes a new instance of the class. - - Errorcode. - Name of the function which returned the specified . - - - - Initializes a new instance of the class from serialization data. - - The object that holds the serialized object data. - The StreamingContext object that supplies the contextual information about the source or destination. - - - - Populates a with the data needed to serialize the target object. - - The to populate with data. - The destination (see StreamingContext) for this serialization. - - - - Base class for most of the sample sources. - - - - - Creates a new instance of the class. - - Underlying base source which provides audio data. - - - - Reads a sequence of samples from the and advances the position within the stream by - the number of samples read. - - - An array of floats. When this method returns, the contains the specified - float array with the values between and ( + - - 1) replaced by the floats read from the current source. - - - The zero-based offset in the at which to begin storing the data - read from the current stream. - - The maximum number of samples to read from the current source. - The total number of samples read into the buffer. - - - - Gets the of the waveform-audio data. - - - - - Gets or sets the position in samples. - - - - - Gets the length in samples. - - - - - Gets a value indicating whether the supports seeking. - - - - - Gets or sets the underlying sample source. - - - - - Gets or sets a value which indicates whether to dispose the - on calling . - - - - - Disposes the and the underlying . - - - - - Disposes the and the underlying . - - - True to release both managed and unmanaged resources; false to release only unmanaged - resources. - - - - - Destructor which calls . - - - - - Provides a few basic extensions. - - - - - Gets the length of a as a . - - The source to get the length for. - The length of the specified as a value. - - - - Gets the position of a as a value. - - The source to get the position of. - The position of the specified as a value. - The source must support seeking to get or set the position. - Use the property to determine whether the stream supports seeking. - Otherwise a call to this method may result in an exception. - - - - Sets the position of a as a value. - - The source to set the new position for. - The new position as a value. - - The source must support seeking to get or set the position. - Use the property to determine whether the stream supports seeking. - Otherwise a call to this method may result in an exception. - - - - - Converts a duration in raw elements to a value. For more information about "raw elements" see remarks. - - The instance which provides the used - to convert the duration in "raw elements" to a value. - The duration in "raw elements" to convert to a value. - The duration as a value. - - source - or - elementCount - - - The term "raw elements" describes the elements, an audio source uses. - What type of unit an implementation of the interface uses, depends on the implementation itself. - For example, a uses bytes while a uses samples. - That means that a provides its position, length,... in bytes - while a provides its position, length,... in samples. - - To get the length or the position of a as a value, use the - or the property. - - Internally this method uses the class. - - - - - Converts a duration in raw elements to a duration in milliseconds. For more information about "raw elements" see remarks. - - The instance which provides the used - to convert the duration in "raw elements" to a duration in milliseconds. - The duration in "raw elements" to convert to duration in milliseconds. - The duration in milliseconds. - - source - or - elementCount - - - The term "raw elements" describes the elements, an audio source uses. - What type of unit an implementation of the interface uses, depends on the implementation itself. - For example, a uses bytes while a uses samples. - That means that a provides its position, length,... in bytes - while a provides its position, length,... in samples. - - To get the length or the position of a as a value, use the - or the property. - - Internally this method uses the class. - - - - - Converts a duration as a to a duration in "raw elements". For more information about "raw elements" see remarks. - - - instance which provides the used to convert - the duration as a to a duration in "raw elements". - - Duration as a to convert to a duration in "raw elements". - Duration in "raw elements". - source - - The term "raw elements" describes the elements, an audio source uses. - What type of unit an implementation of the interface uses, depends on the implementation itself. - For example, a uses bytes while a uses samples. - That means that a provides its position, length,... in bytes - while a provides its position, length,... in samples. - - To get the length or the position of a as a value, use the - or the property. - - Internally this method uses the class. - - - - - Converts a duration in milliseconds to a duration in "raw elements". For more information about "raw elements" see remarks. - - instance which provides the used to convert - the duration in milliseconds to a duration in "raw elements". - Duration in milliseconds to convert to a duration in "raw elements". - - Duration in "raw elements". - - - The term "raw elements" describes the elements, an audio source uses. - What type of unit an implementation of the interface uses, depends on the implementation itself. - For example, a uses bytes while a uses samples. - That means that a provides its position, length,... in bytes - while a provides its position, length,... in samples. - - To get the length or the position of a as a value, use the - or the property. - - Internally this method uses the class. - - source - milliseconds is less than zero. - - - - Creates a new file, writes all audio data of the to the file, and then closes the file. If the target file already exists, it is overwritten. - - Source which provides the audio data to write to the file. - The file to write to. - source - - - - Writes all audio data of the to a wavestream (including a wav header). - - Source which provides the audio data to write to the . - to store the audio data in. - - source - or - stream - - Stream is not writeable.;stream - - - - Writes all audio data of the to a stream. In comparison to the method, - the method won't encode the provided audio to any particular format. No wav, aiff,... header won't be included. - - The waveSource which provides the audio data to write to the . - The to store the audio data in. - - waveSource - or - stream - - Stream is not writeable.;stream - - - - Checks the length of an array. - - Type of the array. - The array to check. This parameter can be null. - The target length of the array. - A value which indicates whether the length of the array has to fit exactly the specified . - Array which fits the specified requirements. Note that if a new array got created, the content of the old array won't get copied to the return value. - - - - Blocks the current thread until the playback of the specified instance stops or the specified timeout expires. - - The instance to wait for its playback to stop. - The number of milliseconds to wait. Pass to wait indefinitely. - true if the got stopped; false if the specified expired. - - - - Blocks the current thread until the playback of the specified instance stops. - - The instance to wait for its playback to stop. - - - - Base class for all wave aggregators. - - - - - Creates a new instance of class. - - - - - Creates a new instance of class. - - Underlying base stream. - - - - Gets or sets a value which indicates whether to dispose the - on calling . - - - - - Gets or sets the underlying base stream of the WaveAggregator. - - - - - Gets the output WaveFormat. - - - - - Reads a sequence of bytes from the and advances the position within the stream by the - number of bytes read. - - - An array of bytes. When this method returns, the contains the specified - byte array with the values between and ( + - - 1) replaced by the bytes read from the current source. - - - The zero-based byte offset in the at which to begin storing the data - read from the current stream. - - The maximum number of bytes to read from the current source. - The total number of bytes read into the buffer. - - - - Gets or sets the position of the source. - - - - - Gets the length of the source. - - - - - Gets a value indicating whether the supports seeking. - - - - - Disposes the source and releases all allocated resources. - - - - - Disposes the and releases all allocated resources. - - True to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Destructor which calls . - - - - - Defines the format of waveform-audio data. - - - - - Gets the number of channels in the waveform-audio data. Mono data uses one channel and stereo data uses two - channels. - - - - - Gets the sample rate, in samples per second (hertz). - - - - - Gets the required average data transfer rate, in bytes per second. For example, 16-bit stereo at 44.1 kHz has an - average data rate of 176,400 bytes per second (2 channels — 2 bytes per sample per channel — 44,100 samples per - second). - - - - - Gets the block alignment, in bytes. The block alignment is the minimum atomic unit of data. For PCM data, the block - alignment is the number of bytes used by a single sample, including data for both channels if the data is stereo. - For example, the block alignment for 16-bit stereo PCM is 4 bytes (2 channels x 2 bytes per sample). - - - - - Gets the number of bits, used to store one sample. - - - - - Gets the size (in bytes) of extra information. This value is mainly used for marshalling. - - - - - Gets the number of bytes, used to store one sample. - - - - - Gets the number of bytes, used to store one block. This value equals multiplied with - . - - - - - Gets the waveform-audio format type. - - - - - Initializes a new instance of the class with a sample rate of 44100 Hz, bits per sample - of 16 bit, 2 channels and PCM as the format type. - - - - - Initializes a new instance of the class with PCM as the format type. - - Samples per second. - Number of bits, used to store one sample. - Number of channels in the waveform-audio data. - - - - Initializes a new instance of the class. - - Samples per second. - Number of bits, used to store one sample. - Number of channels in the waveform-audio data. - Format type or encoding of the wave format. - - - - Initializes a new instance of the class. - - Samples per second. - Number of bits, used to store one sample. - Number of channels in the waveform-audio data. - Format type or encoding of the wave format. - Size (in bytes) of extra information. This value is mainly used for marshalling. - - - - Converts a duration in milliseconds to a duration in bytes. - - Duration in millisecond to convert to a duration in bytes. - Duration in bytes. - - - - Converts a duration in bytes to a duration in milliseconds. - - Duration in bytes to convert to a duration in milliseconds. - Duration in milliseconds. - - - - Indicates whether the current object is equal to another object of the same type. - - The to compare with this . - true if the current object is equal to the other parameter; otherwise, false. - - - - Returns a string which describes the . - - A string which describes the . - - - - Creates a new object that is a copy of the current instance. - - A copy of the current instance. - - - - Updates the - and the -property. - - -
-
diff --git a/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.dll b/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.dll deleted file mode 100644 index 9e6ddff..0000000 Binary files a/packages/CSCore.1.2.1.2/lib/net35-client/CSCore.dll and /dev/null differ diff --git a/packages/Costura.Fody.4.1.0/.signature.p7s b/packages/Costura.Fody.4.1.0/.signature.p7s deleted file mode 100644 index c9950d4..0000000 Binary files a/packages/Costura.Fody.4.1.0/.signature.p7s and /dev/null differ diff --git a/packages/Costura.Fody.4.1.0/Costura.Fody.4.1.0.nupkg b/packages/Costura.Fody.4.1.0/Costura.Fody.4.1.0.nupkg deleted file mode 100644 index 175f3c3..0000000 Binary files a/packages/Costura.Fody.4.1.0/Costura.Fody.4.1.0.nupkg and /dev/null differ diff --git a/packages/Costura.Fody.4.1.0/build/Costura.Fody.props b/packages/Costura.Fody.4.1.0/build/Costura.Fody.props deleted file mode 100644 index a189a9a..0000000 --- a/packages/Costura.Fody.4.1.0/build/Costura.Fody.props +++ /dev/null @@ -1,5 +0,0 @@ - - - - - \ No newline at end of file diff --git a/packages/Costura.Fody.4.1.0/lib/net40/Costura.dll b/packages/Costura.Fody.4.1.0/lib/net40/Costura.dll deleted file mode 100644 index 27d80be..0000000 Binary files a/packages/Costura.Fody.4.1.0/lib/net40/Costura.dll and /dev/null differ diff --git a/packages/Costura.Fody.4.1.0/lib/net40/Costura.xml b/packages/Costura.Fody.4.1.0/lib/net40/Costura.xml deleted file mode 100644 index 7e9ca15..0000000 --- a/packages/Costura.Fody.4.1.0/lib/net40/Costura.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - Costura - - - - - Contains methods for interacting with the Costura system. - - - - - Call this to Initialize the Costura system. - - - - diff --git a/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.dll b/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.dll deleted file mode 100644 index d74ccba..0000000 Binary files a/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.dll and /dev/null differ diff --git a/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.xcf b/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.xcf deleted file mode 100644 index 0f0424e..0000000 --- a/packages/Costura.Fody.4.1.0/weaver/Costura.Fody.xcf +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - A list of assembly names to exclude from the default action of "embed all Copy Local references", delimited with line breaks - - - - - A list of assembly names to include from the default action of "embed all Copy Local references", delimited with line breaks. - - - - - A list of unmanaged 32 bit assembly names to include, delimited with line breaks. - - - - - A list of unmanaged 64 bit assembly names to include, delimited with line breaks. - - - - - The order of preloaded assemblies, delimited with line breaks. - - - - - - This will copy embedded files to disk before loading them into memory. This is helpful for some scenarios that expected an assembly to be loaded from a physical file. - - - - - Controls if .pdbs for reference assemblies are also embedded. - - - - - Embedded assemblies are compressed by default, and uncompressed when they are loaded. You can turn compression off with this option. - - - - - As part of Costura, embedded assemblies are no longer included as part of the build. This cleanup can be turned off. - - - - - Costura by default will load as part of the module initialization. This flag disables that behavior. Make sure you call CosturaUtility.Initialize() somewhere in your code. - - - - - Costura will by default use assemblies with a name like 'resources.dll' as a satellite resource and prepend the output path. This flag disables that behavior. - - - - - A list of assembly names to exclude from the default action of "embed all Copy Local references", delimited with | - - - - - A list of assembly names to include from the default action of "embed all Copy Local references", delimited with |. - - - - - A list of unmanaged 32 bit assembly names to include, delimited with |. - - - - - A list of unmanaged 64 bit assembly names to include, delimited with |. - - - - - The order of preloaded assemblies, delimited with |. - - - \ No newline at end of file diff --git a/packages/DotNetZip.Reduced.1.9.1.8/.signature.p7s b/packages/DotNetZip.Reduced.1.9.1.8/.signature.p7s deleted file mode 100644 index 0595426..0000000 Binary files a/packages/DotNetZip.Reduced.1.9.1.8/.signature.p7s and /dev/null differ diff --git a/packages/DotNetZip.Reduced.1.9.1.8/DotNetZip.Reduced.1.9.1.8.nupkg b/packages/DotNetZip.Reduced.1.9.1.8/DotNetZip.Reduced.1.9.1.8.nupkg deleted file mode 100644 index b399cd0..0000000 Binary files a/packages/DotNetZip.Reduced.1.9.1.8/DotNetZip.Reduced.1.9.1.8.nupkg and /dev/null differ diff --git a/packages/DotNetZip.Reduced.1.9.1.8/lib/net20/Ionic.Zip.Reduced.dll b/packages/DotNetZip.Reduced.1.9.1.8/lib/net20/Ionic.Zip.Reduced.dll deleted file mode 100644 index 9622cc5..0000000 Binary files a/packages/DotNetZip.Reduced.1.9.1.8/lib/net20/Ionic.Zip.Reduced.dll and /dev/null differ diff --git a/packages/FCTB.2.16.24/.signature.p7s b/packages/FCTB.2.16.24/.signature.p7s deleted file mode 100644 index 4c8b749..0000000 Binary files a/packages/FCTB.2.16.24/.signature.p7s and /dev/null differ diff --git a/packages/FCTB.2.16.24/FCTB.2.16.24.nupkg b/packages/FCTB.2.16.24/FCTB.2.16.24.nupkg deleted file mode 100644 index 56d508d..0000000 Binary files a/packages/FCTB.2.16.24/FCTB.2.16.24.nupkg and /dev/null differ diff --git a/packages/FCTB.2.16.24/lib/FastColoredTextBox.dll b/packages/FCTB.2.16.24/lib/FastColoredTextBox.dll deleted file mode 100644 index 1f426e4..0000000 Binary files a/packages/FCTB.2.16.24/lib/FastColoredTextBox.dll and /dev/null differ diff --git a/packages/FCTB.2.16.24/lib/FastColoredTextBox.xml b/packages/FCTB.2.16.24/lib/FastColoredTextBox.xml deleted file mode 100644 index 55d36af..0000000 --- a/packages/FCTB.2.16.24/lib/FastColoredTextBox.xml +++ /dev/null @@ -1,3243 +0,0 @@ - - - - FastColoredTextBox - - - - - Item of autocomplete menu - - - - - Returns text for inserting into Textbox - - - - - Compares fragment text with this item - - - - - Returns text for display into popup menu - - - - - This method is called after item inserted into text - - - - - Title for tooltip. - - Return null for disable tooltip for this item - - - - Tooltip text. - - For display tooltip text, ToolTipTitle must be not null - - - - Menu text. This text is displayed in the drop-down menu. - - - - - Fore color of text of item - - - - - Back color of item - - - - - Item do not appears - - - - - Item appears - - - - - Item appears and will selected - - - - - Autocomplete item for code snippets - - Snippet can contain special char ^ for caret position. - - - - Compares fragment text with this item - - - - - This autocomplete item appears after dot - - - - - This Item does not check correspondence to current text fragment. - SuggestItem is intended for dynamic menus. - - - - - Popup menu for autocomplete - - - - - Regex pattern for serach fragment around caret - - - - - Minimum fragment length for popup - - - - - User selects item - - - - - It fires after item inserting - - - - - Occurs when popup menu is opening - - - - - Allow TAB for select menu item - - - - - Interval of menu appear (ms) - - - - - Sets the max tooltip window size - - - - - Tooltip will perm show and duration will be ignored - - - - - Back color of selected item - - - - - Border color of hovered item - - - - - Shows popup menu immediately - - If True - MinFragmentLength will be ignored - - - - Minimal size of menu - - - - - Image list of menu - - - - - Tooltip duration (ms) - - - - - Tooltip - - - - - Base class for bookmark collection - - - - - Collection of bookmarks - - - - - Removes bookmark by line index - - - - - Returns Bookmark by index. - - - - - Bookmark of FastColoredTextbox - - - - - Name of bookmark - - - - - Line index - - - - - Color of bookmark sign - - - - - Scroll textbox to the bookmark - - - - - Char and style - - - - - Unicode character - - - - - Style bit mask - - Bit 1 in position n means that this char will rendering by FastColoredTextBox.Styles[n] - - - - Shows document map of FCTB - - - - - Scale - - - - - Scrollbar visibility - - - - - Exports colored text as HTML - - At this time only TextStyle renderer is supported. Other styles is not exported. - - - - Use nbsp; instead space - - - - - Use nbsp; instead space in beginning of line - - - - - Use original font - - - - - Use style tag instead style attribute - - - - - Use 'br' tag instead of '\n' - - - - - Includes line numbers - - - - - Exports colored text as RTF - - At this time only TextStyle renderer is supported. Other styles are not exported. - - - - Includes line numbers - - - - - Use original font - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Collection of Hints. - This is temporary buffer for currently displayed hints. - - - - - Clears all displayed hints - - - - - Add and shows the hint - - - - - - Is collection contains the hint? - - - - - Count of hints - - - - - Hint of FastColoredTextbox - - - - - Text of simple hint - - - - - Linked range - - - - - Backcolor - - - - - Second backcolor - - - - - Border color - - - - - Fore color - - - - - Text alignment - - - - - Font - - - - - Occurs when user click on simple hint - - - - - Inner control - - - - - Docking (allows None and Fill only) - - - - - Width of hint (if Dock is None) - - - - - Height of hint - - - - - Host panel - - - - - Tag - - - - - Cursor - - - - - Inlining. If True then hint will moves apart text. - - - - - Scroll textbox to the hint - - - - - Creates Hint - - Linked range - Text for simple hint - Inlining. If True then hint will moves apart text - Docking. If True then hint will fill whole line - - - - Creates Hint - - Linked range - Text for simple hint - - - - Creates Hint - - Linked range - Inner control - Inlining. If True then hint will moves apart text - Docking. If True then hint will fill whole line - - - - Creates Hint - - Linked range - Inner control - - - - Returns edited hotkey map - - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - This class records, stores and executes the macros. - - - - - Allows to user to record macros - - - - - Returns current recording state. Set to True/False to start/stop recording programmatically. - - - - - FCTB - - - - - Executes recorded macro - - - - - - Adds the char to current macro - - - - - Adds keyboard key to current macro - - - - - Clears last recorded macro - - - - - Returns True if last macro is empty - - - - - Macros as string. - - - - - Dictionary of shortcuts for FCTB - - - - - Actions for shortcuts - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Highlights syntax for given language - - - - - Highlights syntax for given XML description file - - - - - Uses the given to parse a XML description and adds it as syntax descriptor. - The syntax descriptor is used for highlighting when - - Language property of FCTB is set to - DescriptionFile property of FCTB has the same value as the method parameter - - - Name of the description file - XmlDocument to parse - - - - Adds the given as resilient style. A resilient style is additionally available when highlighting is - based on a syntax descriptor that has been derived from a XML description file. In the run of the highlighting routine - the styles used by the FCTB are always dropped and replaced with the (initial) ones from the syntax descriptor. Resilient styles are - added afterwards and can be used anyway. - - Style to add - - - - Highlights C# code - - - - - - Highlights VB code - - - - - - Highlights HTML code - - - - - - Highlights XML code - - - - - - Highlights SQL code - - - - - - Highlights PHP code - - - - - - Highlights JavaScript code - - - - - - Highlights Lua code - - - - - - String style - - - - - Comment style - - - - - Number style - - - - - C# attribute style - - - - - Class name style - - - - - Keyword style - - - - - Style of tags in comments of C# - - - - - HTML attribute value style - - - - - HTML tag brackets style - - - - - HTML tag name style - - - - - HTML Entity style - - - - - XML attribute style - - - - - XML attribute value style - - - - - XML tag brackets style - - - - - XML tag name style - - - - - XML Entity style - - - - - XML CData style - - - - - Variable style - - - - - Specific PHP keyword style - - - - - Specific PHP keyword style - - - - - SQL Statements style - - - - - SQL Functions style - - - - - SQL Types style - - - - - Language - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Fast colored textbox - - - - - Constructor - - - - - AutoComplete brackets - - - - - Colors of some service visual markers - - - - - Contains UniqueId of start lines of folded blocks - - This dictionary remembers folding state of blocks. - It is needed to restore child folding after user collapsed/expanded top-level folding block. - - - - Strategy of search of brackets to highlighting - - - - - Automatically shifts secondary wordwrap lines on the shift amount of the first line - - - - - Indent of secondary wordwrap lines (in chars) - - - - - MacrosManager records, stores and executes the macroses - - - - - Allows drag and drop - - - - - Collection of Hints. - This is temporary buffer for currently displayed hints. - - You can asynchronously add, remove and clear hints. Appropriate hints will be shown or hidden from the screen. - - - - Delay (ms) of ToolTip - - - - - ToolTip component - - - - - Color of bookmarks - - - - - Bookmarks - - - - - Enables virtual spaces - - - - - Strategy of search of end of folding block - - - - - Indicates if tab characters are accepted as input - - - - - Indicates if return characters are accepted as input - - - - - Shows or hides the caret - - - - - Enables caret blinking - - - - - Draw caret when the control is not focused - - - - - Color of border of text area - - - - - Type of border of text area - - - - - Background color for current line - - - - - Background color for highlighting of changed lines - - - - - Fore color (default style color) - - - - - Height of char in pixels (includes LineInterval) - - - - - Interval between lines (in pixels) - - - - - Width of char in pixels - - - - - Spaces count for tab - - - - - Text was changed - - - - - Text version - - This counter is incremented each time changes the text - - - - Read only - - - - - Shows line numbers. - - - - - Shows vertical lines between folding start line and folding end line. - - - - - Rectangle where located text - - - - - Color of line numbers. - - - - - Start value of first line number. - - - - - Background color of indent area - - - - - Background color of padding area - - - - - Color of disabled component - - - - - Color of caret - - - - - Wide caret - - - - - Color of service lines (folding lines, borders of blocks etc.) - - - - - Padings of text area - - - - - --Do not use this property-- - - - - - Color of folding area indicator - - - - - Enables folding indicator (left vertical line between folding bounds) - - - - - Left distance to text beginning - - - - - Left padding in pixels - - - - - This property draws vertical line after defined char position. - Set to 0 for disable drawing of vertical line. - - - - - Styles - - - - - Hotkeys. Do not use this property in your code, use HotkeysMapping property. - - - - - Hotkeys mapping - - - - - Default text style - This style is using when no one other TextStyle is not defined in Char.style - - - - - Style for rendering Selection area - - - - - Style for folded block rendering - - - - - Style for brackets highlighting - - - - - Style for alternative brackets highlighting - - - - - Opening bracket for brackets highlighting. - Set to '\x0' for disable brackets highlighting. - - - - - Closing bracket for brackets highlighting. - Set to '\x0' for disable brackets highlighting. - - - - - Alternative opening bracket for brackets highlighting. - Set to '\x0' for disable brackets highlighting. - - - - - Alternative closing bracket for brackets highlighting. - Set to '\x0' for disable brackets highlighting. - - - - - Comment line prefix. - - - - - This property specifies which part of the text will be highlighted as you type (by built-in highlighter). - - When a user enters text, a component refreshes highlighting (because the text was changed). - This property specifies exactly which section of the text will be re-highlighted. - This can be useful to highlight multi-line comments, for example. - - - - Is keyboard in replace mode (wide caret) ? - - - - - Allows text rendering several styles same time. - - - - - Allows to record macros. - - - - - Allows AutoIndent. Inserts spaces before new line. - - - - - Does autoindenting in existing lines. It works only if AutoIndent is True. - - - - - Minimal delay(ms) for delayed events (except TextChangedDelayed). - - - - - Minimal delay(ms) for TextChangedDelayed event. - - - - - Language for highlighting by built-in highlighter. - - - - - Syntax Highlighter - - - - - XML file with description of syntax highlighting. - This property works only with Language == Language.Custom. - - - - - Position of left highlighted bracket. - - - - - Position of right highlighted bracket. - - - - - Position of left highlighted alternative bracket. - - - - - Position of right highlighted alternative bracket. - - - - - Start line index of current highlighted folding area. Return -1 if start of area is not found. - - - - - End line index of current highlighted folding area. Return -1 if end of area is not found. - - - - - TextSource - - - - - The source of the text. - Allows to get text from other FastColoredTextBox. - - - - - Returns current visible range of text - - - - - Current selection range - - - - - Background color. - It is used if BackBrush is null. - - - - - Background brush. - If Null then BackColor is used. - - - - - Multiline - - - - - WordWrap. - - - - - WordWrap mode. - - - - - If true then line breaks included into the selection will be selected too. - Then line breaks will be shown as selected blank character. - - - - - Do not change this property - - - - - Count of lines - - - - - Gets or sets char and styleId for given place - This property does not fire OnTextChanged event - - - - - Gets Line - - - - - Text of control - - - - - Text lines - - - - - Gets colored text as HTML - - For more flexibility you can use ExportToHTML class also - - - - Gets colored text as RTF - - For more flexibility you can use ExportToRTF class also - - - - Text of current selection - - - - - Start position of selection - - - - - Length of selected text - - - - - Font - - Use only monospaced font - - - - Font - - Use only monospaced font - - - - Indicates that IME is allowed (for CJK language entering) - - - - - Is undo enabled? - - - - - Is redo enabled? - - - - - Range of all text - - - - - Color of selected area - - - - - Reserved space for line number characters. - If smaller than needed (e. g. line count >= 10 and this value set to 1) this value will have no impact. - If you want to reserve space, e. g. for line numbers >= 10 or >= 100 than you can set this value to 2 or 3 or higher. - - - - - Occurs when mouse is moving over text and tooltip is needed - - - - - Removes all hints - - - - - Add and shows the hint - - Linked range - Inner control - Scrolls textbox to the hint - Inlining. If True then hint will moves apart text - Docking. If True then hint will fill whole line - - - - Add and shows the hint - - Linked range - Inner control - - - - Add and shows simple text hint - - Linked range - Text of simple hint - Scrolls textbox to the hint - Inlining. If True then hint will moves apart text - Docking. If True then hint will fill whole line - - - - Add and shows simple text hint - - Linked range - Text of simple hint - - - - Occurs when user click on the hint - - - - - - Occurs when VisibleRange is changed - - - - - Invalidates the entire surface of the control and causes the control to be redrawn. - This method is thread safe and does not require Invoke. - - - - - HintClick event. - It occurs if user click on the hint. - - - - - TextChanged event. - It occurs after insert, delete, clear, undo and redo operations. - - - - - Fake event for correct data binding - - - - - Occurs when user paste text from clipboard - - - - - TextChanging event. - It occurs before insert, delete, clear, undo and redo operations. - - - - - SelectionChanged event. - It occurs after changing of selection. - - - - - VisibleRangeChanged event. - It occurs after changing of visible range. - - - - - TextChangedDelayed event. - It occurs after insert, delete, clear, undo and redo operations. - This event occurs with a delay relative to TextChanged, and fires only once. - - - - - SelectionChangedDelayed event. - It occurs after changing of selection. - This event occurs with a delay relative to SelectionChanged, and fires only once. - - - - - VisibleRangeChangedDelayed event. - It occurs after changing of visible range. - This event occurs with a delay relative to VisibleRangeChanged, and fires only once. - - - - - It occurs when user click on VisualMarker. - - - - - It occurs when visible char is enetering (alphabetic, digit, punctuation, DEL, BACKSPACE) - - Set Handle to True for cancel key - - - - It occurs when visible char is enetered (alphabetic, digit, punctuation, DEL, BACKSPACE) - - - - - It occurs when calculates AutoIndent for new line - - - - - It occurs when line background is painting - - - - - Occurs when line was inserted/added - - - - - Occurs when line was removed - - - - - Occurs when current highlighted folding area is changed. - Current folding area see in StartFoldingLine and EndFoldingLine. - - - - - - Occurs when undo/redo stack is changed - - - - - - Occurs when component was zoomed - - - - - Occurs when user pressed key, that specified as CustomAction - - - - - Occurs when scroolbars are updated - - - - - Occurs when custom wordwrap is needed - - - - - Returns list of styles of given place - - - - - Call this method if the recalc of the position of lines is needed. - - - - - Call this method if the recalc of the position of lines is needed. - - - - - Call this method if the recalc of the position of lines is needed. - - - - - Navigates forward (by Line.LastVisit property) - - - - - Navigates backward (by Line.LastVisit property) - - - - - Navigates to defined line, without Line.LastVisit reseting - - - - - Add new style - - Layer index of this style - - - - Checks if the styles buffer has enough space to add one - more element. If not, an exception is thrown. Otherwise, - the index of a free slot is returned. - - Index of free styles buffer slot - If maximum count of styles is exceeded - - - - Shows find dialog - - - - - Shows find dialog - - - - - Shows replace dialog - - - - - Shows replace dialog - - - - - Gets length of given line - - Line index - Length of line - - - - Get range of line - - Line index - - - - Copy selected text into Clipboard - - - - - Cut selected text into Clipboard - - - - - Paste text from clipboard into selected position - - - - - Select all chars of text - - - - - Move caret to end of text - - - - - Move caret to first position - - - - - Clear text, styles, history, caches - - - - - Clear buffer of styles - - - - - Clear style of all text - - - - - Clears undo and redo stacks - - - - - Insert text into current selected position - - - - - Insert text into current selected position - - - - - - Insert text into current selection position (with predefined style) - - - - - - Insert text into current selection position (with predefined style) - - - - - Insert text into replaceRange and restore previous selection - - - - - Append string to end of the Text - - - - - Append string to end of the Text - - - - - Returns index of the style in Styles - -1 otherwise - - - Index of the style in Styles - - - - Returns StyleIndex mask of given styles - - - StyleIndex mask of given styles - - - - Deletes selected chars - - - - - Deletes current line(s) - - - - - Calculates wordwrap cutoffs - - - - - Scroll control for display defined rectangle - - - - - - Updates scrollbar position after Value changed - - - - - Scroll control for display caret - - - - - Scroll control left - - - - - Scroll control for display selection area - - - - - Scroll control for display given range - - - - - Scroll control for display given range - - - - - Process control keys - - - - - Scrolls to nearest bookmark or to first bookmark - - Current bookmark line index - - - - Scrolls to nearest previous bookmark or to last bookmark - - Current bookmark line index - - - - Bookmarks line - - - - - Unbookmarks current line - - - - - Moves selected lines down - - - - - Moves selected lines up - - - - - Convert selected text to upper case - - - - - Convert selected text to lower case - - - - - Convert selected text to title case - - - - - Convert selected text to sentence case - - - - - Insert/remove comment prefix into selected lines - - - - - Insert/remove comment prefix into selected lines - - - - - Process "real" keys (no control) - - - - - Enables AutoIndentChars mode - - - - - Regex patterns for AutoIndentChars (one regex per line) - - - - - Do AutoIndentChars - - - - - Finds given char after current caret position, moves the caret to found pos. - - - - - - Inserts autoindent's spaces in the line - - - - - Returns needed start space count for the line - - - - - Undo last operation - - - - - Redo - - - - - Draws text to given Graphics - - - Start place of drawing text - Size of drawing - - - - Draw control - - - - - Gets the value for the system control panel mouse wheel scroll settings. - The value returns the number of lines that shall be scolled if the user turns the mouse wheet one step. - - - This methods gets the "WheelScrollLines" value our from the registry key "HKEY_CURRENT_USER\Control Panel\Desktop". - If the value of this option is 0, the screen will not scroll when the mouse wheel is turned. - If the value of this option is -1 or is greater than the number of lines visible in the window, - the screen will scroll up or down by one page. - - - Number of lines to scrol l when the mouse wheel is turned - - - - - Zooming (in percentages) - - - - - Gets nearest line and char position from coordinates - - Point - Line and char position - - - - Gets nearest absolute text position for given point - - Point - Position - - - - Fires TextChanging event - - - - - Fires TextChanged event - - - - - Fires TextChanged event - - - - - Fires TextChanged event - - - - - Call this method before multiple text changing - - - - - Call this method after multiple text changing - - - - - Fires TextChanged event - - - - - Clears folding state for range of text - - - - - Fires SelectionChanged event - - - - - Gets absolute text position from line and char position - - Line and char position - Point of char - - - - Gets line and char position from absolute text position - - - - - Gets absolute char position from char position - - - - - Gets point for given line and char position - - Line and char position - Coordiantes - - - - Get range of text - - Absolute start position - Absolute finish position - Range - - - - Get range of text - - Line and char position - Line and char position - Range - - - - Finds ranges for given regex pattern - - Regex pattern - Enumeration of ranges - - - - Finds ranges for given regex pattern - - Regex pattern - Enumeration of ranges - - - - Get text of given line - - Line index - Text - - - - Exapnds folded block - - Start line - - - - Collapse folding blocks using FoldedBlocks dictionary. - - - - - Expand collapsed block - - - - - Expand collapsed block - - Any line inside collapsed block - - - - Collapses all folding blocks - - - - - Exapnds all folded blocks - - - - - - Collapses folding block - - Start folding line - - - - Start foilding marker for the line - - - - - End foilding marker for the line - - - - - Collapse text block - - - - - Insert TAB into front of seletcted lines. - - - - - Remove TAB from front of seletcted lines. - - - - - Remove TAB in front of the caret ot the selected line. - - - - - Insert autoindents into selected lines - - - - - Insert prefix into front of seletcted lines - - - - - Remove prefix from front of selected lines - This method ignores forward spaces of the line - - - - - Begins AutoUndo block. - All changes of text between BeginAutoUndo() and EndAutoUndo() will be canceled in one operation Undo. - - - - - Ends AutoUndo block. - All changes of text between BeginAutoUndo() and EndAutoUndo() will be canceled in one operation Undo. - - - - - Highlights brackets around caret - - - - - Returns range between brackets (or null if not found) - - - - - Selectes next fragment for given regex. - - - - - Prints range of text - - - - - Prints all text - - - - - Prints all text, without any dialog windows - - - - - Open text file - - - - - Open text file (with automatic encoding detector) - - - - - Open file binding mode - - - - - - - Close file binding mode - - - - - Save text to the file - - - - - - - Set VisibleState of line - - - - - Returns VisibleState of the line - - - - - Shows Goto dialog form - - - - - Occurs when undo/redo stack is changed - - - - - Search lines by regex pattern - - - - - Removes given lines - - - - - Activates the scrolling mode (middle click button). - - MouseEventArgs - - - - Deactivates the scrolling mode (middle click button). - - - - - Restore scrolls - - - - - Inserted line index - - - - - Count of inserted lines - - - - - Removed line index - - - - - Count of removed lines - - - - - UniqueIds of removed lines - - - - - TextChanged event argument - - - - - Constructor - - - - - This range contains changed area of text - - - - - Set to true if you want to cancel text inserting - - - - - Word wrapping by control width - - - - - Word wrapping by preferred line width (PreferredLineWidth) - - - - - Char wrapping by control width - - - - - Char wrapping by preferred line width (PreferredLineWidth) - - - - - Custom wrap (by event WordWrapNeeded) - - - - - Title of page. If you want to print Title on the page, insert code &w in Footer or Header. - - - - - Footer of page. - Here you can use special codes: &w (Window title), &D, &d (Date), &t(), &4 (Time), &p (Current page number), &P (Total number of pages), && (A single ampersand), &b (Right justify text, Center text. If &b occurs once, then anything after the &b is right justified. If &b occurs twice, then anything between the two &b is centered, and anything after the second &b is right justified). - More detailed see here - - - - - Header of page - Here you can use special codes: &w (Window title), &D, &d (Date), &t(), &4 (Time), &p (Current page number), &P (Total number of pages), && (A single ampersand), &b (Right justify text, Center text. If &b occurs once, then anything after the &b is right justified. If &b occurs twice, then anything between the two &b is centered, and anything after the second &b is right justified). - More detailed see here - - - - - Prints line numbers - - - - - Additional spaces count for this line, relative to previous line - - - - - Additional spaces count for next line, relative to previous line - - - - - Absolute indentation of current line. You can change this property if you want to set absolute indentation. - - - - - Type of highlighting - - - - - Highlight only changed range of text. Highest performance. - - - - - Highlight visible range of text. Middle performance. - - - - - Highlight all (visible and invisible) text. Lowest performance. - - - - - Strategy of search of end of folding block - - - - - Strategy of search of brackets to highlighting - - - - - ToolTipNeeded event args - - - - - HintClick event args - - - - - CustomAction event args - - - - - Style index mask (16 styles) - - - - - Insert single char - - This operation includes also insertion of new line and removing char by backspace - - - - Constructor - - Underlaying textbox - Inserting char - - - - Undo operation - - - - - Execute operation - - - - - Merge lines i and i+1 - - - - - Insert text - - - - - Constructor - - Underlaying textbox - Text for inserting - - - - Undo operation - - - - - Execute operation - - - - - Insert text into given ranges - - - - - Constructor - - Underlaying textbox - List of ranges for replace - Text for inserting - - - - Undo operation - - - - - Execute operation - - - - - Clear selected text - - - - - Construstor - - Underlaying textbox - - - - Undo operation - - - - - Execute operation - - - - - Replaces text - - - - - Constructor - - Underlaying textsource - List of ranges for replace - - - - Undo operation - - - - - Execute operation - - - - - Removes lines - - - - - Constructor - - Underlaying textbox - List of ranges for replace - Text for inserting - - - - Undo operation - - - - - Execute operation - - - - - Wrapper for multirange commands - - - - - Remembers current selection and restore it after Undo - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Limited stack - - - - - Max stack length - - - - - Current length of stack - - - - - Constructor - - Maximum length of stack - - - - Pop item - - - - - Peek item - - - - - Push item - - - - - Clear stack - - - - - Line of text - - - - - Text of line was changed - - - - - Time of last visit of caret in this line - - This property can be used for forward/backward navigating - - - - Background brush. - - - - - Unique ID - - - - - Count of needed start spaces for AutoIndent - - - - - Clears style of chars, delete folding markers - - - - - Text of the line - - - - - Clears folding markers - - - - - Count of start spaces - - - - - Chars count - - - - - Visible state - - - - - Positions for wordwrap cutoffs - - - - - Count of wordwrap string count for this line - - - - - Gets index of wordwrap string for given char position - - - - - Line index and char index - - - - - Diapason of text chars - - - - - Constructor - - - - - Return true if no selected text - - - - - Column selection mode - - - - - Constructor - - - - - Constructor - - - - - Constructor. Creates range of the line - - - - - Returns intersection with other range, - empty range returned otherwise - - - - - - - Returns union with other range. - - - - - - - Select all chars of control - - - - - Start line and char position - - - - - Finish line and char position - - - - - Text of range - - This property has not 'set' accessor because undo/redo stack works only with - FastColoredTextBox.Selection range. So, if you want to set text, you need to use FastColoredTextBox.Selection - and FastColoredTextBox.InsertText() mehtod. - - - - - Returns first char after Start place - - - - - Returns first char before Start place - - - - - Returns required char's number before start of the Range - - - - - Returns required char's number after start of the Range - - - - - Clone range - - - - - - Return minimum of end.X and start.X - - - - - Return maximum of end.X and start.X - - - - - Move range right - - This method jump over folded blocks - - - - Move range left - - This method can to go inside folded blocks - - - - Move range left - - This method jump over folded blocks - - - - Move range left - - This method can to go inside folded blocks - - - - Set style for range - - - - - Set style for given regex pattern - - - - - Set style for given regex - - - - - Set style for given regex pattern - - - - - Set style for given regex pattern - - - - - Set style for given regex pattern - - - - - Appends style to chars of range - - - - - Sets folding markers - - Pattern for start folding line - Pattern for finish folding line - - - - Sets folding markers - - Pattern for start folding line - Pattern for finish folding line - - - - Sets folding markers - - Pattern for start and end folding line - - - - Finds ranges for given regex pattern - - Regex pattern - Enumeration of ranges - - - - Finds ranges for given regex pattern - - Regex pattern - Enumeration of ranges - - - - Finds ranges for given regex pattern. - Search is separately in each line. - This method requires less memory than GetRanges(). - - Regex pattern - Enumeration of ranges - - - - Finds ranges for given regex. - Search is separately in each line. - This method requires less memory than GetRanges(). - - Regex - Enumeration of ranges - - - - Finds ranges for given regex pattern. - Search is separately in each line (order of lines is reversed). - This method requires less memory than GetRanges(). - - Regex pattern - Enumeration of ranges - - - - Finds ranges for given regex - - Enumeration of ranges - - - - Clear styles of range - - - - - Clear styles of range - - - - - Clear folding markers of all lines of range - - - - - Starts selection position updating - - - - - Ends selection position updating - - - - - Exchanges Start and End if End appears before Start - - - - - Exchanges Start and End - - - - - Expands range from first char of Start line to last char of End line - - - - - Chars of range (exclude \n) - - - - - Get fragment of text around Start place. Returns maximal matched to pattern fragment. - - Allowed chars pattern for fragment - Range of found fragment - - - - Get fragment of text around Start place. Returns maximal matched to given Style. - - Allowed style for fragment - Range of found fragment - - - - Get fragment of text around Start place. Returns maximal mathed to pattern fragment. - - Allowed chars pattern for fragment - Range of found fragment - - - - Range is readonly? - This property return True if any char of the range contains ReadOnlyStyle. - Set this property to True/False to mark chars of the range as Readonly/Writable. - - - - - Is char before range readonly - - - - - - Is char after range readonly - - - - - - Style of chars - - This is base class for all text and design renderers - - - - This style is exported to outer formats (HTML for example) - - - - - Occurs when user click on StyleVisualMarker joined to this style - - - - - Constructor - - - - - Renders given range of text - - Graphics object - Position of the range in absolute control coordinates - Rendering range of text - - - - Occurs when user click on StyleVisualMarker joined to this style - - - - - Shows VisualMarker - Call this method in Draw method, when you need to show VisualMarker for your style - - - - - Returns CSS for export to HTML - - - - - - Returns RTF descriptor for export to RTF - - - - - - Style for chars rendering - This renderer can draws chars, with defined fore and back colors - - - - - Renderer for folded block - - - - - Renderer for selected area - - - - - Marker style - Draws background color for text - - - - - Draws small rectangle for popup menu - - - - - This style draws a wavy line below a given text range. - - Thanks for Yallie - - - - This style is used to mark range of text as ReadOnly block - - You can inherite this style to add visual effects of readonly text - - - - This class contains the source text (chars and styles). - It stores a text lines, the manager of commands, undo/redo stack, styles. - - - - - Styles - - - - - Occurs when line was inserted/added - - - - - Occurs when line was removed - - - - - Occurs when text was changed - - - - - Occurs when recalc is needed - - - - - Occurs when recalc wordwrap is needed - - - - - Occurs before text changing - - - - - Occurs after CurrentTB was changed - - - - - Current focused FastColoredTextBox - - - - - Default text style - This style is using when no one other TextStyle is not defined in Char.style - - - - - Text lines - - - - - Lines count - - - - - These classes are required for correct data binding to Text property of FastColoredTextbox - - - - - This class contains the source text (chars and styles). - It stores a text lines, the manager of commands, undo/redo stack, styles. - - - - - Occurs when need to display line in the textbox - - - - - Occurs when need to save line in the file - - - - - End Of Line characters used for saving - - - - - This text will be displayed in textbox - - - - - This property contains only changed text. - If text of line is not changed, this property contains null. - - - - - This text will be saved in the file - - - - diff --git a/packages/Fody.6.0.0/.signature.p7s b/packages/Fody.6.0.0/.signature.p7s deleted file mode 100644 index 4d9aadd..0000000 Binary files a/packages/Fody.6.0.0/.signature.p7s and /dev/null differ diff --git a/packages/Fody.6.0.0/Fody.6.0.0.nupkg b/packages/Fody.6.0.0/Fody.6.0.0.nupkg deleted file mode 100644 index b355281..0000000 Binary files a/packages/Fody.6.0.0/Fody.6.0.0.nupkg and /dev/null differ diff --git a/packages/Fody.6.0.0/build/Fody.targets b/packages/Fody.6.0.0/build/Fody.targets deleted file mode 100644 index 167a11a..0000000 --- a/packages/Fody.6.0.0/build/Fody.targets +++ /dev/null @@ -1,110 +0,0 @@ - - - - $(ProjectDir)FodyWeavers.xml - $(MSBuildThisFileDirectory)..\ - $(FodyPath)netstandardtask - $(FodyPath)netclassictask - $(FodyAssemblyDirectory)\Fody.dll - $(DefaultItemExcludes);FodyWeavers.xsd - true - 15 - $([System.Version]::Parse($(MSBuildVersion)).Major) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/packages/Fody.6.0.0/netclassictask/Fody.dll b/packages/Fody.6.0.0/netclassictask/Fody.dll deleted file mode 100644 index 2ca8d38..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Fody.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/FodyCommon.dll b/packages/Fody.6.0.0/netclassictask/FodyCommon.dll deleted file mode 100644 index 8cd5941..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/FodyCommon.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/FodyHelpers.dll b/packages/Fody.6.0.0/netclassictask/FodyHelpers.dll deleted file mode 100644 index d04ebd9..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/FodyHelpers.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/FodyIsolated.dll b/packages/Fody.6.0.0/netclassictask/FodyIsolated.dll deleted file mode 100644 index fbf1279..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/FodyIsolated.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.dll b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.dll deleted file mode 100644 index 980d4da..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.pdb b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.pdb deleted file mode 100644 index c3a88f3..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Pdb.pdb and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.dll b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.dll deleted file mode 100644 index 1355bb7..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.pdb b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.pdb deleted file mode 100644 index 864cdbd..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.Rocks.pdb and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.dll b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.dll deleted file mode 100644 index 099fba4..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.pdb b/packages/Fody.6.0.0/netclassictask/Mono.Cecil.pdb deleted file mode 100644 index ad888f4..0000000 Binary files a/packages/Fody.6.0.0/netclassictask/Mono.Cecil.pdb and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Fody.dll b/packages/Fody.6.0.0/netstandardtask/Fody.dll deleted file mode 100644 index cbc88c1..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Fody.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/FodyCommon.dll b/packages/Fody.6.0.0/netstandardtask/FodyCommon.dll deleted file mode 100644 index 909c960..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/FodyCommon.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/FodyHelpers.dll b/packages/Fody.6.0.0/netstandardtask/FodyHelpers.dll deleted file mode 100644 index d04ebd9..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/FodyHelpers.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/FodyIsolated.dll b/packages/Fody.6.0.0/netstandardtask/FodyIsolated.dll deleted file mode 100644 index c938719..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/FodyIsolated.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.dll b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.dll deleted file mode 100644 index e81b2f8..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.pdb b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.pdb deleted file mode 100644 index 8347861..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Pdb.pdb and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.dll b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.dll deleted file mode 100644 index 2b2652b..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.pdb b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.pdb deleted file mode 100644 index 61af54c..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.Rocks.pdb and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.dll b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.dll deleted file mode 100644 index f1a5119..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.dll and /dev/null differ diff --git a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.pdb b/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.pdb deleted file mode 100644 index b506a34..0000000 Binary files a/packages/Fody.6.0.0/netstandardtask/Mono.Cecil.pdb and /dev/null differ diff --git a/packages/ILMerge.3.0.29/.signature.p7s b/packages/ILMerge.3.0.29/.signature.p7s deleted file mode 100644 index 3977944..0000000 Binary files a/packages/ILMerge.3.0.29/.signature.p7s and /dev/null differ diff --git a/packages/ILMerge.3.0.29/ILMerge.3.0.29.nupkg b/packages/ILMerge.3.0.29/ILMerge.3.0.29.nupkg deleted file mode 100644 index bce8e22..0000000 Binary files a/packages/ILMerge.3.0.29/ILMerge.3.0.29.nupkg and /dev/null differ diff --git a/packages/ILMerge.3.0.29/build/ILMerge.props b/packages/ILMerge.3.0.29/build/ILMerge.props deleted file mode 100644 index 6f16298..0000000 --- a/packages/ILMerge.3.0.29/build/ILMerge.props +++ /dev/null @@ -1,7 +0,0 @@ - - - - $(MSBuildThisFileDirectory)..\tools\net452\ILMerge.exe - - - diff --git a/packages/ILMerge.3.0.29/docs/ilmerge-manual.md b/packages/ILMerge.3.0.29/docs/ilmerge-manual.md deleted file mode 100644 index d54ddf0..0000000 --- a/packages/ILMerge.3.0.29/docs/ilmerge-manual.md +++ /dev/null @@ -1,374 +0,0 @@ -# ILMerge - -Michael Barnett
-Research in Software Engineering (RiSE)
-Microsoft Research
-Copyright © Microsoft Corporation. All rights reserved. - -# 1. Introduction - -This document describes the ILMerge utility which merges multiple .NET assemblies into a single assembly. However, some .NET assemblies may not be able to be merged because they may contain features such as unmanaged code. I would highly recommend using peverify (the .NET Framework SDK tool) on the output of ILMerge to guarantee that the output is verifiable and will load in the .NET runtime. - -ILMerge is packaged as a console application. But all of its functionality is also accessible programmatically. Note that Visual Studio **does** allow one to add an executable as a reference, so you can write a client that uses ILMerge as a library. - -ILMerge takes a set of _input assemblies_ and merges them into one _target assembly_. The first assembly in the list of input assemblies is the _primary assembly_. When the primary assembly is an executable, then the target assembly is created as an executable with the same entry point as the primary assembly. Also, if the primary assembly has a strong name, and a .snk file is provided, then the target assembly is re-signed with the specified key so that it also has a strong name. - -Note that anything that depended upon any of the names of the input assemblies, e.g., configuration files, must be updated to refer instead to the name of the target assembly. - -Any Win32 Resources in the primary assembly are copied over into the target assembly. - -There are many options that control the behavior of ILMerge. These are described in the next section. - -# 2. Public Interface - -The public interface for ILMerge is defined in the ILMerging namespace as the class ILMerge. - -```csharp -namespace ILMerging -{ - public class ILMerge { } -} -``` - -To use this class programmatically, just create an instance using the default (nullary) constructor. There are several properties and methods which are used to affect the behavior of the merging. The method `Merge()` is called to actually perform the merging. - -## 2.1 AllowDuplicateType - -```csharp -public void AllowDuplicateType(string typeName); -``` - -The normal behavior of ILMerge is to not allow there to be more than one public type with the same name. If such a duplicate is found, then an exception is thrown. However, ILMerge can just rename the type so that it no longer causes a conflict. For private types, this is not a problem since no outside client can see it anyway, so ILMerge just does the renaming by default. For public types, it is not often a useful feature to have it renamed. However, there are situations where it is needed. In particular, for obfuscated assemblies, it seems that the obfuscator defines an attribute and creates an assembly-level attribute for the obfuscated assembly using that attribute. This would mean that obfuscated assemblies cannot be merged. - -So this option allows the user to either allow all public types to be renamed when they are duplicates, or to specify it for arbitrary type names. On the command line, there can be as many options as desired, if followed by a colon and a type name, otherwise just specify it alone with no colon (and type name) to allow all duplicates. - -When used through the API, an argument of "null" means to allow all public types to be renamed. - -**Default:** no duplicates of public types allowed - -**Command line option:** `[/allowDup[:typeName]]*` - -## 2.2 AllowMultipleAssemblyLevelAttributes - -```csharp -public bool AllowMultipleAssemblyLevelAttributes { get; set; } -``` - -When this is set before calling Merge, then if the CopyAttributes property (Section 2.7) is also set, any assembly-level attributes names that have the same type are copied over into the target directory as long as the definition of the attribute type specifies that "AllowMultiple" is true. - -**Default:** `false` - -**Command line option:** `/allowMultiple` - -## 2.3 AllowWildCards - -```csharp -public bool AllowWildCards { get; set; } -``` - -When this is set before calling Merge, any wild cards in file names are expanded and all matching files will be used as input. Note that because the wild card matching is done by a call to Directory.GetFiles, it does not allow the characters ".." to appear in a file name. So if you want to specify a relative path containing ".." to move up a directory, you will have to use it with the "/lib" option (Section 2.20). That option does allow the use of ".." to move up directories. - -**Default:** `false` - -**Command line option:** `/wildcards` - -## 2.4 AllowZeroPeKind - -```csharp -public bool AllowZeroPeKind { get; set; } -``` - -When this is set before calling Merge, then if an assembly's PeKind flag (this is the value of the field listed as .corflags in the Manifest) is zero it will be treated as if it was ILonly. This can be used to allow C++ assemblies to be merged; it does not appear that the C++ compiler writes the value as ILonly. However, if such an assembly has any non-IL features, then they will probably not be copied over into the target assembly correctly. So please use this option with caution. - -**Default:** `false` - -**Command line option:** `/zeroPeKind` - -## 2.5 AttributeFile - -```csharp -public string AttributeFile { get; set; } -``` - -If this is set before calling Merge, then it specifies the path and filename to an _atttribute assembly_, an assembly that will be used to get all of the assembly-level attributes such as Culture, Version, etc. It will also be used to get the Win32 Resources from. It is mutually exclusive with the CopyAttributes property (Section 2.7). When it is not specified, then the Win32 Resources from the primary assembly are copied over into the target assembly. If it is not a full path, then the current directory is used. - -**Default:** `null` - -**Command line option:** `/attr:filename` - -## 2.6 Closed - -```csharp -public bool Closed { get; set; } -``` - -When this is set before calling Merge, then the "transitive closure" of the input assemblies is computed and added to the list of input assemblies. An assembly is considered part of the transitive closure if it is referenced, either directly or indirectly, from one of the originally specified input assemblies and it has an external reference to one of the input assemblies, or one of the assemblies that has such a reference. Complicated, but that is life... - -**Default:** `false` - -**Command line option:** `/closed` - -## 2.7 CopyAttributes - -```csharp -public bool CopyAttributes { get; set; } -``` - -When this is set before calling Merge, then the assembly level attributes of each input assembly are copied over into the target assembly. Any duplicate attribute overwrites a previously copied attribute. If you want to allow duplicates (for those attributes whose type specifies "AllowMultiple" in their definition), then you can also set the AllowMultipleAssemblyLevelAttributes (Section 2.2). The input assemblies are processed in the order they are specified. This option is mutually exclusive with specifying an attribute assembly, i.e., the property AttributeFile (Section 2.5). When an attribute assembly is specified, then no assembly-level attributes are copied over from the input assemblies. - -**Default:** `false` - -**Command line option:** `/copyattrs` - -## 2.8 DebugInfo - -```csharp -public bool DebugInfo { get; set; } -``` - -When this is set to true, ILMerge creates a .pdb file for the output assembly and merges into it any .pdb files found for input assemblies. If you do not want a .pdb file created for the output assembly, either set this property to false or else specify the /ndebug option at the command line. - -**Default:** `true` - -**Command line option:** `/ndebug` - -## 2.9 DelaySign - -```csharp -public bool DelaySign { get; set; } -``` - -When this is set before calling Merge, then the target assembly will be delay signed. This can be set only in conjunction with the `/keyfile` option (Section 2.13). - -**Default:** `false` - -## 2.10 ExcludeFile - -```csharp -public string ExcludeFile { get; set; } -``` - -This property is used only in conjunction with the Internalize property (Section 2.12). When this is set before calling Merge, it indicates the path and filename that will be used to identify types that are not to have their visibility modified. If Internalize is true, but ExcludeFile is "", then all types in any assembly other than the primary assembly are made non-public. Setting this property implicitly sets Internalize to true. - -The contents of the file should be one regular expression per line. The syntax is that defined in the .NET namespace System.Text.RegularExpressions for regular expressions. The regular expressions are matched against each type's full name, e.g., "System.Collections.IList". If the match fails, it is tried again with the assembly name (surrounded by square brackets) prepended to the type name. Thus, the pattern "\\[A\\].\\\*" excludes all types in assembly A from being made non-public. (The backslashes are required because the string is treated as a regular expression.) The pattern "N.T" will match all types named T in the namespace named N no matter what assembly they are defined in. - -It is important to note that the regular expressions are _not_ anchored to the beginning of the string; if this is desired, use the appropriate regular expression operator characters to do so. - -**Default:** "" - -**Command line option:** `/internalize[:excludeFile]` - -## 2.11 FileAlignment - -```csharp -public int FileAlignment { get; set; } -``` - -This controls the file alignment used for the target assembly. The setter sets the value to the largest power of two that is no larger than the supplied argument, and is at least 512. - -**Default:** `512` - -**Command line option:** `/align:n` - -## 2.12 Internalize - -```csharp -public bool Internalize { get; set; } -``` - -This controls whether types in assemblies _other than_ the primary assembly have their visibility modified. When it is true, then all non-exempt types that are visible outside of their assembly have their visibility modified so that they are not visible from outside of the merged assembly. A type is exempt if its _full name_ matches a line from the ExcludeFile (Section 2.10) using the .NET regular expression engine. - -**Default:** `false` - -**Command line option:** `/internalize[:excludeFile]` - -## 2.13 KeyFile - -```csharp -public string KeyFile { get; set; } -``` - -When this is set before calling Merge, it specifies the path and filename to a .snk file. The target assembly will be signed with its contents and will then have a strong name. It can be used with the DelaySign property (Section 2.9) to have the target assembly delay signed. This can be done even if the primary assembly was fully signed. - -**Default:** `null` - -**Command line option:** `/keyfile:filename` - -## 2.14 Log - -```csharp -public bool Log { get; set; } -``` - -When this is set before calling Merge, then log messages are written. It is used in conjunction with the LogFile property. If Log is true, but LogFile is null, then log messages are written to Console.Out. To specify this behavior on the command line, the option "/log" can be given without a log file. - -**Default:** `false` - -**Command line option:** `/log[:logfile]` - -## 2.15 LogFile - -```csharp -public string LogFile { get; set; } -``` - -When this is set before calling Merge, it indicates the path and filename that log messages are written to. If Log is true, but LogFile is null, then log messages are written to Console.Out. - -**Default:** `null` - -**Command line option:** `/log[:logfile]` - -## 2.16 Merge - -```csharp -public void Merge(); -``` - -Once all desired options are set, this method performs the actual merging. - -## 2.17 OutputFile - -```csharp -public string OutputFile { get; set; } -``` - -This must be set before calling Merge. It specifies the path and filename that the target assembly will be written to. - -**Default:** `null` - -**Command line option:** `/out:filename` - -## 2.18 PublicKeyTokens - -```csharp -public bool PublicKeyTokens { get; set; } -``` - -This must be set before calling Merge. It indicates whether external assembly references in the manifest of the target assembly will use full public keys (false) or public key tokens (true). - -**Default:** `true` - -**Command line option:** `/useFullPublicKeyForReferences` - -## 2.19 SetInputAssemblies - -```csharp -public void SetInputAssemblies(string[] assems); -``` - -When used programmatically, each element of the array should contain the path and filename of an input assembly. The first element of the array is considered to be the primary assembly. - -## 2.20 SetSearchDirectories - -```csharp -public void SetSearchDirectories(string[] dirs); -``` - -If specified, this sets the directories to be used to search for input assemblies. When used programmatically, each element of the array should contain a directory name. When specified on the command line, use a separate "/lib" option for each directory. - -**Command line option:** `/lib:directory` - -## 2.21 SetTargetPlatform - -```csharp -public void SetTargetPlatform(string platform, string dir); -``` - -This method sets the .NET Framework for the target assembly to be the one specified by platform. Valid strings for the first argument are `v1`, `v1.1`, `v2`, and `v4`;. The `v` is case insensitive and is also optional. This way ILMerge can be used to "cross-compile", i.e., it can run in one version of the framework and generate the target assembly so it will run under a different assembly. The second argument is the directory in which `mscorlib.dll` is to be found. - -**Command line option:** `/targetplatform:version,platformdirectory` - -## 2.22 StrongNameLost - -```csharp -public bool StrongNameLost { get; } -``` - -Once merging is complete, this property is true if and only if the primary assembly had a strong name, but the target assembly does not. This can occur when an .snk file is not specified, or if something goes wrong trying to read its contents. - -## 2.23 TargetKind - -```csharp -public ILMerge.Kind { get; set; } -``` - -This controls whether the target assembly is created as a library, a console application or as a Windows application. When it is not specified, then the target assembly will be the same kind as that of the primary assembly. (In that case, the file extensions found on the specified target assembly and the primary assembly must match.) When it is specified, then the file extension of the target assembly must match the specification. - -The possible values are `ILMerge.Kind.{Dll, Exe, WinExe}` - -**Default:** `ILMerge.Kind.SameAsPrimaryAssembly` - -**Command line option:** `/target:(library|exe|winexe)` - -## 2.24 UnionMerge - -```csharp -public bool { get; set; } -``` - -When this is true, then types with the same name are all merged into a single type in the target assembly. The single type is the union of all of the individual types in the input assemblies: it contains all of the members from each of the corresponding types in the input assemblies. It cannot be specified at the same time as `/allowDup`. - -**Default:** `false` - -**Command line option:** `/union` - -## 2.25 Version - -```csharp -public System.Version Version { get; set; } -``` - -When this has a non-null value, then the target assembly will be given its value as the version number of the assembly. When specified on the command line, the version is read in as a string and should look like "6.2.1.3" (but without the quote marks). The version must be a valid assembly version as defined by the attribute AssemblyVersion in the System.Reflection namespace. - -**Default:** `null` - -**Command line option:** `/ver:version` - -## 2.26 XmlDocumentation - -```csharp -public bool XmlDocumentation { get; set; } -``` - -This property controls whether XML documentation files are merged to produce an XML documentation file for the target assembly. - -**Default:** `false` - -**Command line option:** `/xmldocs` - -# 3 Command Line Usage - -The full command line for ILMerge is: - -``` -ilmerge [/lib:directory]* [/log[:filename]] [/keyfile:filename [/delaysign]] [/internalize[:filename]] -[/t[arget]:(library|exe|winexe)] [/closed] [/ndebug] [/ver:version] [/copyattrs [/allowMultiple]] -[/xmldocs] [/attr:filename] ([/targetplatform:[,]]|v1|v1.1|v2|v4) -[/useFullPublicKeyForReferences] [/zeroPeKind] [/wildcards] [/allowDup[:typename]]* -[/allowDuplicateResources] [/union] [/align:n] -/out:filename [...] -``` - - All options that take arguments can use either `:` or `=` as a separator. Options can be in any order, but all of the options must precede the list of input assemblies. - -# 4 Troubleshooting - -## 4.1 Input assembly not merged in correctly - -A common problem is that after merging some assemblies, you get an error message stating that an input assembly was not merged in correctly because it is still listed as an external reference in the merged assembly. The most common cause of this problem is that one of the input assemblies, B, has an external reference to the incorrectly merged assembly, A, and also an external reference to another assembly, C, that itself has an external reference to A. Suppose the reference to C is to a method that takes an argument whose type is defined in A. Then the type signature of the method call to the method in C still refers to the type from A even in the merged assembly. After all, ILMerge cannot go and modify the assembly C so that it now depends on the type as it is defined in the output assembly after it has been merged! - -The solution is to use the closed option (Section 2.6) to have ILMerge compute the transitive closure of the input assemblies to prevent this kind of "dangling reference". In the example, that would result in all three assemblies A, B, and C, being merged. There is no way to merge just A and B without there still being an external reference to A. - -## 4.2 Merged assembly causes a runtime error (not present in the unmerged assemblies) - -The most frequent cause of problems when executing the target assembly is that ILMerge has no way to merge resources. Therefore resources are just copied over from the input assemblies into the target assembly. If these resources encode references to types defined in the input assemblies, then at runtime your program may fail because the type returned from the resource does not match the type as it is defined in the target assembly. You may even see a message that "type 'T' cannot be converted to type 'T'". This looks confusing because the messages do not show the assembly that each type is defined in. The actual error is that one type is defined in the input assembly while the other is defined in the target assembly. - -I do not know of any way to have ILMerge do the right thing in such cases. There is no general way to decode resources and change any type references they contain. - -# 5 Dependencies - -ILMerge is a stand-alone assembly dependent only on the v4.0 .NET Framework. (It actually uses two other assemblies: the assembly that makes up CCI itself, `System.Compiler.dll`, and `AssemblyResolver.dll`, which provides a small component for finding and loading assemblies when requested by the CCI Reader. But those assemblies have been merged into ILMerge using ILMerge before it is distributed.) - -# 6 Acknowledgements - -Without [Herman Venter](https://github.com/hermanventer), this tool could not have been written. Not only because it completely depends on CCI to provide the underlying functionality for reading, transforming, and writing IL, but because of all of his help and support. diff --git a/packages/ILMerge.3.0.29/tools/net452/ILMerge.exe b/packages/ILMerge.3.0.29/tools/net452/ILMerge.exe deleted file mode 100644 index b760897..0000000 Binary files a/packages/ILMerge.3.0.29/tools/net452/ILMerge.exe and /dev/null differ diff --git a/packages/ILMerge.3.0.29/tools/net452/System.Compiler.dll b/packages/ILMerge.3.0.29/tools/net452/System.Compiler.dll deleted file mode 100644 index 220f47d..0000000 Binary files a/packages/ILMerge.3.0.29/tools/net452/System.Compiler.dll and /dev/null differ diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/.signature.p7s b/packages/MSBuild.ILMerge.Task.1.1.3/.signature.p7s deleted file mode 100644 index 29e919c..0000000 Binary files a/packages/MSBuild.ILMerge.Task.1.1.3/.signature.p7s and /dev/null differ diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/Icon.png b/packages/MSBuild.ILMerge.Task.1.1.3/Icon.png deleted file mode 100644 index d8d0c45..0000000 Binary files a/packages/MSBuild.ILMerge.Task.1.1.3/Icon.png and /dev/null differ diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/License.txt b/packages/MSBuild.ILMerge.Task.1.1.3/License.txt deleted file mode 100644 index 3897542..0000000 --- a/packages/MSBuild.ILMerge.Task.1.1.3/License.txt +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2013-2016 Alexander Nosenko - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/MSBuild.ILMerge.Task.1.1.3.nupkg b/packages/MSBuild.ILMerge.Task.1.1.3/MSBuild.ILMerge.Task.1.1.3.nupkg deleted file mode 100644 index 401d73c..0000000 Binary files a/packages/MSBuild.ILMerge.Task.1.1.3/MSBuild.ILMerge.Task.1.1.3.nupkg and /dev/null differ diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.props b/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.props deleted file mode 100644 index e3ec78b..0000000 --- a/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.props +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - $(MSBuildProjectDirectory)\$(MSBuildProjectName).ILMerge.props - $(MSBuildProjectDirectory)\ILMerge.props - - - - \ No newline at end of file diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.targets b/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.targets deleted file mode 100644 index 29e52dc..0000000 --- a/packages/MSBuild.ILMerge.Task.1.1.3/build/MSBuild.ILMerge.Task.targets +++ /dev/null @@ -1,116 +0,0 @@ - - - - - $(SolutionDir)packages - $(MSBuildProjectDirectory)\ILMergeOrder.txt - $(AssemblyOriginatorKeyFile) - - - - false - false - false - true - false - 512 - false - - false - true - true - - false - 40 - - - $(MSBuildThisFileDirectory)..\tools\ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - @(IntermediateAssembly->'%(FullPath)');@(MergedAssemblies->'%(FullPath)');@(MergedDependencies->'%(FullPath)') - - - @(IntermediateAssembly->'%(FullPath)');@(MergedAssemblies->'%(FullPath)') - - - - - - @(UnmergedAssemblies->'%(FullPath)') - $(TargetPath) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMerge.props b/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMerge.props deleted file mode 100644 index aaadb12..0000000 --- a/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMerge.props +++ /dev/null @@ -1,67 +0,0 @@ - - - - - - - - - - - true - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMergeOrder.txt b/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMergeOrder.txt deleted file mode 100644 index 3fda7f5..0000000 --- a/packages/MSBuild.ILMerge.Task.1.1.3/content/ILMergeOrder.txt +++ /dev/null @@ -1,4 +0,0 @@ -# this file contains the partial list of the merged assemblies in the merge order -# you can fill it from the obj\CONFIG\PROJECT.ilmerge generated on every build -# and finetune merge order to your satisfaction - diff --git a/packages/MSBuild.ILMerge.Task.1.1.3/tools/MSBuild.ILMerge.Task.dll b/packages/MSBuild.ILMerge.Task.1.1.3/tools/MSBuild.ILMerge.Task.dll deleted file mode 100644 index ca28b04..0000000 Binary files a/packages/MSBuild.ILMerge.Task.1.1.3/tools/MSBuild.ILMerge.Task.dll and /dev/null differ diff --git a/packages/NAudio.1.10.0/.signature.p7s b/packages/NAudio.1.10.0/.signature.p7s deleted file mode 100644 index e3bad49..0000000 Binary files a/packages/NAudio.1.10.0/.signature.p7s and /dev/null differ diff --git a/packages/NAudio.1.10.0/NAudio.1.10.0.nupkg b/packages/NAudio.1.10.0/NAudio.1.10.0.nupkg deleted file mode 100644 index 2e57cb4..0000000 Binary files a/packages/NAudio.1.10.0/NAudio.1.10.0.nupkg and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/net35/NAudio.dll b/packages/NAudio.1.10.0/lib/net35/NAudio.dll deleted file mode 100644 index 84643f1..0000000 Binary files a/packages/NAudio.1.10.0/lib/net35/NAudio.dll and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/net35/NAudio.xml b/packages/NAudio.1.10.0/lib/net35/NAudio.xml deleted file mode 100644 index f521934..0000000 --- a/packages/NAudio.1.10.0/lib/net35/NAudio.xml +++ /dev/null @@ -1,24720 +0,0 @@ - - - - NAudio - - - - - a-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts an a-law encoded byte to a 16 bit linear sample - - a-law encoded byte - Linear sample - - - - A-law encoder - - - - - Encodes a single 16 bit sample to a-law - - 16 bit PCM sample - a-law encoded byte - - - - SpanDSP - a series of DSP components for telephony - - g722_decode.c - The ITU G.722 codec, decode part. - - Written by Steve Underwood <steveu@coppice.org> - - Copyright (C) 2005 Steve Underwood - Ported to C# by Mark Heath 2011 - - Despite my general liking of the GPL, I place my own contributions - to this code in the public domain for the benefit of all mankind - - even the slimy ones who might try to proprietize my work and use it - to my detriment. - - Based in part on a single channel G.722 codec which is: - Copyright (c) CMU 1993 - Computer Science, Speech Group - Chengxiang Lu and Alex Hauptmann - - - - - hard limits to 16 bit samples - - - - - Decodes a buffer of G722 - - Codec state - Output buffer (to contain decompressed PCM samples) - - Number of bytes in input G722 data to decode - Number of samples written into output buffer - - - - Encodes a buffer of G722 - - Codec state - Output buffer (to contain encoded G722) - PCM 16 bit samples to encode - Number of samples in the input buffer to encode - Number of encoded bytes written into output buffer - - - - Stores state to be used between calls to Encode or Decode - - - - - ITU Test Mode - TRUE if the operating in the special ITU test mode, with the band split filters disabled. - - - - - TRUE if the G.722 data is packed - - - - - 8kHz Sampling - TRUE if encode from 8k samples/second - - - - - Bits Per Sample - 6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps. - - - - - Signal history for the QMF (x) - - - - - Band - - - - - In bit buffer - - - - - Number of bits in InBuffer - - - - - Out bit buffer - - - - - Number of bits in OutBuffer - - - - - Creates a new instance of G722 Codec State for a - new encode or decode session - - Bitrate (typically 64000) - Special options - - - - Band data for G722 Codec - - - - s - - - sp - - - sz - - - r - - - a - - - ap - - - p - - - d - - - b - - - bp - - - sg - - - nb - - - det - - - - G722 Flags - - - - - None - - - - - Using a G722 sample rate of 8000 - - - - - Packed - - - - - mu-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts a mu-law encoded byte to a 16 bit linear sample - - mu-law encoded byte - Linear sample - - - - mu-law encoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - Encodes a single 16 bit sample to mu-law - - 16 bit PCM sample - mu-law encoded byte - - - - Audio Capture Client - - - - - Gets a pointer to the buffer - - Pointer to the buffer - - - - Gets a pointer to the buffer - - Number of frames to read - Buffer flags - Pointer to the buffer - - - - Gets the size of the next packet - - - - - Release buffer - - Number of frames written - - - - Release the COM object - - - - - Windows CoreAudio AudioClient - - - - - Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams. - Can be called before initialize - - - - - Initializes the Audio Client - - Share Mode - Stream Flags - Buffer Duration - Periodicity - Wave Format - Audio Session GUID (can be null) - - - - Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first) - - - - - Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized. - - - - - Retrieves the number of frames of padding in the endpoint buffer (must initialize first) - - - - - Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer. - (can be called before initialize) - - - - - Gets the minimum device period - (can be called before initialize) - - - - - Returns the AudioStreamVolume service for this AudioClient. - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Gets the AudioClockClient service - - - - - Gets the AudioRenderClient service - - - - - Gets the AudioCaptureClient service - - - - - Determines whether if the specified output format is supported - - The share mode. - The desired format. - True if the format is supported - - - - Determines if the specified output format is supported in shared mode - - Share Mode - Desired Format - Output The closest match format. - True if the format is supported - - - - Starts the audio stream - - - - - Stops the audio stream. - - - - - Set the Event Handle for buffer synchro. - - The Wait Handle to setup - - - - Resets the audio stream - Reset is a control method that the client calls to reset a stopped audio stream. - Resetting the stream flushes all pending data and resets the audio clock stream - position to 0. This method fails if it is called on a stream that is not stopped - - - - - Dispose - - - - - Audio Client Buffer Flags - - - - - None - - - - - AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY - - - - - AUDCLNT_BUFFERFLAGS_SILENT - - - - - AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR - - - - - The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream. - - http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx - - - - The size of the buffer for the audio stream. - - - - - Boolean value to indicate whether or not the audio stream is hardware-offloaded - - - - - An enumeration that is used to specify the category of the audio stream. - - - - - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - - AUDCLNT_SHAREMODE - - - - - AUDCLNT_SHAREMODE_SHARED, - - - - - AUDCLNT_SHAREMODE_EXCLUSIVE - - - - - AUDCLNT_STREAMFLAGS - - - - - None - - - - - AUDCLNT_STREAMFLAGS_CROSSPROCESS - - - - - AUDCLNT_STREAMFLAGS_LOOPBACK - - - - - AUDCLNT_STREAMFLAGS_EVENTCALLBACK - - - - - AUDCLNT_STREAMFLAGS_NOPERSIST - - - - - Defines values that describe the characteristics of an audio stream. - - - - - No stream options. - - - - - The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware. - - - - - Audio Clock Client - - - - - Characteristics - - - - - Frequency - - - - - Get Position - - - - - Adjusted Position - - - - - Can Adjust Position - - - - - Dispose - - - - - Audio Endpoint Volume - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - On Volume Notification - - - - - Volume Range - - - - - Hardware Support - - - - - Step Information - - - - - Channels - - - - - Master Volume Level - - - - - Master Volume Level Scalar - - - - - Mute - - - - - Volume Step Up - - - - - Volume Step Down - - - - - Creates a new Audio endpoint volume - - IAudioEndpointVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Audio Endpoint Volume Channel - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - Volume Level - - - - - Volume Level Scalar - - - - - Audio Endpoint Volume Channels - - - - - Channel Count - - - - - Indexer - get a specific channel - - - - - Audio Endpoint Volume Notifiaction Delegate - - Audio Volume Notification Data - - - - Audio Endpoint Volume Step Information - - - - - Step - - - - - StepCount - - - - - Audio Endpoint Volume Volume Range - - - - - Minimum Decibels - - - - - Maximum Decibels - - - - - Increment Decibels - - - - - Audio Meter Information - - - - - Peak Values - - - - - Hardware Support - - - - - Master Peak Value - - - - - Audio Meter Information Channels - - - - - Metering Channel Count - - - - - Get Peak value - - Channel index - Peak value - - - - Audio Render Client - - - - - Gets a pointer to the buffer - - Number of frames requested - Pointer to the buffer - - - - Release buffer - - Number of frames written - Buffer flags - - - - Release the COM object - - - - - AudioSessionControl object for information - regarding an audio session - - - - - Constructor. - - - - - - Dispose - - - - - Finalizer - - - - - Audio meter information of the audio session. - - - - - Simple audio volume of the audio session (for volume and mute status). - - - - - The current state of the audio session. - - - - - The name of the audio session. - - - - - the path to the icon shown in the mixer. - - - - - The session identifier of the audio session. - - - - - The session instance identifier of the audio session. - - - - - The process identifier of the audio session. - - - - - Is the session a system sounds session. - - - - - the grouping param for an audio session grouping - - - - - - For chanigng the grouping param and supplying the context of said change - - - - - - - Registers an even client for callbacks - - - - - - Unregisters an event client from receiving callbacks - - - - - - AudioSessionEvents callback implementation - - - - - Constructor. - - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - AudioSessionManager - - Designed to manage audio sessions and in particuar the - SimpleAudioVolume interface to adjust a session volume - - - - - Session created delegate - - - - - Occurs when audio session has been added (for example run another program that use audio playback). - - - - - SimpleAudioVolume object - for adjusting the volume for the user session - - - - - AudioSessionControl object - for registring for callbacks and other session information - - - - - Refresh session of current device. - - - - - Returns list of sessions of current device. - - - - - Dispose. - - - - - Finalizer. - - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Manages the AudioStreamVolume for the . - - - - - Verify that the channel index is valid. - - - - - - - Return the current stream volumes for all channels - - An array of volume levels between 0.0 and 1.0 for each channel in the audio stream. - - - - Returns the current number of channels in this audio stream. - - - - - Return the current volume for the requested channel. - - The 0 based index into the channels. - The volume level for the channel between 0.0 and 1.0. - - - - Set the volume level for each channel of the audio stream. - - An array of volume levels (between 0.0 and 1.0) one for each channel. - - A volume level MUST be supplied for reach channel in the audio stream. - - - Thrown when does not contain elements. - - - - - Sets the volume level for one channel in the audio stream. - - The 0-based index into the channels to adjust the volume of. - The volume level between 0.0 and 1.0 for this channel of the audio stream. - - - - Dispose - - - - - Release/cleanup objects during Dispose/finalization. - - True if disposing and false if being finalized. - - - - Audio Volume Notification Data - - - - - Event Context - - - - - Muted - - - - - Guid that raised the event - - - - - Master Volume - - - - - Channels - - - - - Channel Volume - - - - - Audio Volume Notification Data - - - - - - - - - - Connector - - - - - Connects this connector to a connector in another device-topology object - - - - - Retreives the type of this connector - - - - - Retreives the data flow of this connector - - - - - Disconnects this connector from it's connected connector (if connected) - - - - - Indicates whether this connector is connected to another connector - - - - - Retreives the connector this connector is connected to (if connected) - - - - - Retreives the global ID of the connector this connector is connected to (if connected) - - - - - Retreives the device ID of the audio device this connector is connected to (if connected) - - - - - Connector Type - - - - - The connector is part of a connection of unknown type. - - - - - The connector is part of a physical connection to an auxiliary device that is installed inside the system chassis - - - - - The connector is part of a physical connection to an external device. - - - - - The connector is part of a software-configured I/O connection (typically a DMA channel) between system memory and an audio hardware device on an audio adapter. - - - - - The connector is part of a permanent connection that is fixed and cannot be configured under software control. - - - - - The connector is part of a connection to a network. - - - - - The EDataFlow enumeration defines constants that indicate the direction - in which audio data flows between an audio endpoint device and an application - - - - - Audio rendering stream. - Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, - to the application - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio - endpoint device, or from the audio endpoint device to the application. - - - - - Device State - - - - - DEVICE_STATE_ACTIVE - - - - - DEVICE_STATE_DISABLED - - - - - DEVICE_STATE_NOTPRESENT - - - - - DEVICE_STATE_UNPLUGGED - - - - - DEVICE_STATEMASK_ALL - - - - - Windows CoreAudio DeviceTopology - - - - - Retrieves the number of connections associated with this device-topology object - - - - - Retrieves the connector at the supplied index - - - - - Retrieves the device id of the device represented by this device-topology object - - - - - Endpoint Hardware Support - - - - - Volume - - - - - Mute - - - - - Meter - - - - - Representation of binary large object container. - - - - - Length of binary object. - - - - - Pointer to buffer storing data. - - - - - is defined in WTypes.h - - - - - Audio Client WASAPI Error Codes (HResult) - - - - - AUDCLNT_E_NOT_INITIALIZED - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_IN_USE - - - - - AUDCLNT_E_RESOURCES_INVALIDATED - - - - - Windows CoreAudio IAudioClient interface - Defined in AudioClient.h - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - Defined in AudioClient.h - - - - - Defined in AudioClient.h - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier for the audio session. - - Receives the session identifier. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier of the audio session instance. - - Receives the identifier of a particular instance. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the process identifier of the audio session. - - Receives the process identifier of the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Indicates whether the session is a system sounds session. - - An HRESULT code indicating whether the operation succeeded of failed. - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Defines constants that indicate the current state of an audio session. - - - MSDN Reference: http://msdn.microsoft.com/en-us/library/dd370792.aspx - - - - - The audio session is inactive. - - - - - The audio session is active. - - - - - The audio session has expired. - - - - - Defines constants that indicate a reason for an audio session being disconnected. - - - MSDN Reference: Unknown - - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the WTS session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - interface to receive session related events - - - - - notification of volume changes including muting of audio session - - the current volume - the current mute state, true muted, false otherwise - - - - notification of display name changed - - the current display name - - - - notification of icon path changed - - the current icon path - - - - notification of the client that the volume level of an audio channel in the session submix has changed - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - - - - notification of the client that the grouping parameter for the session has changed - - >The new grouping parameter for the session. - - - - notification of the client that the stream-activity state of the session has changed - - The new session state. - - - - notification of the client that the session has been disconnected - - The reason that the audio session was disconnected. - - - - Windows CoreAudio IAudioSessionManager interface - Defined in AudioPolicy.h - - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionNotification interface - Defined in AudioPolicy.h - - - - - - - session being added - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IConnector interface - Defined in devicetopology.h - - - - - Windows CoreAudio IDeviceTopology interface - Defined in devicetopology.h - - - - - defined in MMDeviceAPI.h - - - - - IMMNotificationClient - - - - - Device State Changed - - - - - Device Added - - - - - Device Removed - - - - - Default Device Changed - - - - - Property Value Changed - - - - - - - Windows CoreAudio IPart interface - Defined in devicetopology.h - - - - - Windows CoreAudio IPartsList interface - Defined in devicetopology.h - - - - - is defined in propsys.h - - - - - Windows CoreAudio ISimpleAudioVolume interface - Defined in AudioClient.h - - - - - Sets the master volume level for the audio session. - - The new volume level expressed as a normalized value between 0.0 and 1.0. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the client volume level for the audio session. - - Receives the volume level expressed as a normalized value between 0.0 and 1.0. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Sets the muting state for the audio session. - - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the current muting state for the audio session. - - Receives the muting state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - implements IMMDeviceEnumerator - - - - - MMDevice STGM enumeration - - - - - Read-only access mode. - - - - - Write-only access mode. - - - - - Read-write access mode. - - - - - from Propidl.h. - http://msdn.microsoft.com/en-us/library/aa380072(VS.85).aspx - contains a union so we have to do an explicit layout - - - - - Value type tag. - - - - - Reserved1. - - - - - Reserved2. - - - - - Reserved3. - - - - - cVal. - - - - - bVal. - - - - - iVal. - - - - - uiVal. - - - - - lVal. - - - - - ulVal. - - - - - intVal. - - - - - uintVal. - - - - - hVal. - - - - - uhVal. - - - - - fltVal. - - - - - dblVal. - - - - - boolVal. - - - - - scode. - - - - - Date time. - - - - - Binary large object. - - - - - Pointer value. - - - - - Creates a new PropVariant containing a long value - - - - - Helper method to gets blob data - - - - - Interprets a blob as an array of structs - - - - - Gets the type of data in this PropVariant - - - - - Property value - - - - - allows freeing up memory, might turn this into a Dispose method? - - - - - Clears with a known pointer - - - - - MM Device - - - - - Initializes the device's property store. - - The storage-access mode to open store for. - Administrative client is required for Write and ReadWrite modes. - - - - Audio Client - Makes a new one each call to allow caller to manage when to dispose - n.b. should probably not be a property anymore - - - - - Audio Meter Information - - - - - Audio Endpoint Volume - - - - - AudioSessionManager instance - - - - - DeviceTopology instance - - - - - Properties - - - - - Friendly name for the endpoint - - - - - Friendly name of device - - - - - Icon path of device - - - - - Device Instance Id of Device - - - - - Device ID - - - - - Data Flow - - - - - Device State - - - - - To string - - - - - Dispose - - - - - Finalizer - - - - - Multimedia Device Collection - - - - - Device count - - - - - Get device by index - - Device index - Device at the specified index - - - - Get Enumerator - - Device enumerator - - - - MM Device Enumerator - - - - - Creates a new MM Device Enumerator - - - - - Enumerate Audio Endpoints - - Desired DataFlow - State Mask - Device Collection - - - - Get Default Endpoint - - Data Flow - Role - Device - - - - Check to see if a default audio end point exists without needing an exception. - - Data Flow - Role - True if one exists, and false if one does not exist. - - - - Get device by ID - - Device ID - Device - - - - Registers a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - Unregisters a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - - - - Called to dispose/finalize contained objects. - - True if disposing, false if called from a finalizer. - - - - PROPERTYKEY is defined in wtypes.h - - - - - Format ID - - - - - Property ID - - - - - - - - - - - Property Keys - - - - - PKEY_DeviceInterface_FriendlyName - - - - - PKEY_AudioEndpoint_FormFactor - - - - - PKEY_AudioEndpoint_ControlPanelPageProvider - - - - - PKEY_AudioEndpoint_Association - - - - - PKEY_AudioEndpoint_PhysicalSpeakers - - - - - PKEY_AudioEndpoint_GUID - - - - - PKEY_AudioEndpoint_Disable_SysFx - - - - - PKEY_AudioEndpoint_FullRangeSpeakers - - - - - PKEY_AudioEndpoint_Supports_EventDriven_Mode - - - - - PKEY_AudioEndpoint_JackSubType - - - - - PKEY_AudioEngine_DeviceFormat - - - - - PKEY_AudioEngine_OEMFormat - - - - - PKEY _Devie_FriendlyName - - - - - PKEY _Device_IconPath - - - - - Device description property. - - - - - Id of controller device for endpoint device property. - - - - - Device interface key property. - - - - - System-supplied device instance identification string, assigned by PnP manager, persistent across system restarts. - - - - - Property Store class, only supports reading properties at the moment. - - - - - Property Count - - - - - Gets property by index - - Property index - The property - - - - Contains property guid - - Looks for a specific key - True if found - - - - Indexer by guid - - Property Key - Property or null if not found - - - - Gets property key at sepecified index - - Index - Property key - - - - Gets property value at specified index - - Index - Property value - - - - Sets property value at specified key. - - Key of property to set. - Value to write. - - - - Saves a property change. - - - - - Creates a new property store - - IPropertyStore COM interface - - - - Property Store Property - - - - - Property Key - - - - - Property Value - - - - - The ERole enumeration defines constants that indicate the role - that the system has assigned to an audio endpoint device - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording - - - - - Voice communications (talking to another person). - - - - - Collection of sessions. - - - - - Returns session at index. - - - - - - - Number of current sessions. - - - - - Windows CoreAudio SimpleAudioVolume - - - - - Creates a new Audio endpoint volume - - ISimpleAudioVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Allows the user to adjust the volume from - 0.0 to 1.0 - - - - - Mute - - - - - Represents state of a capture device - - - - - Not recording - - - - - Beginning to record - - - - - Recording in progress - - - - - Requesting stop - - - - - Audio Capture using Wasapi - See http://msdn.microsoft.com/en-us/library/dd370800%28VS.85%29.aspx - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - Length of the audio buffer in milliseconds. A lower value means lower latency but increased CPU usage. - - - - Share Mode - set before calling StartRecording - - - - - Current Capturing State - - - - - Capturing wave format - - - - - Gets the default audio capture device - - The default audio capture device - - - - To allow overrides to specify different flags (e.g. loopback) - - - - - Start Capturing - - - - - Stop Capturing (requests a stop, wait for RecordingStopped event to know it has finished) - - - - - Dispose - - - - - Contains the name and CLSID of a DirectX Media Object - - - - - Name - - - - - CLSID - - - - - Initializes a new instance of DmoDescriptor - - - - - DirectX Media Object Enumerator - - - - - Get audio effect names - - Audio effect names - - - - Get audio encoder names - - Audio encoder names - - - - Get audio decoder names - - Audio decoder names - - - - DMO Guids for use with DMOEnum - dmoreg.h - - - - - MediaErr.h - - - - - DMO Inplace Process Flags - - - - - DMO_INPLACE_NORMAL - - - - - DMO_INPLACE_ZERO - - - - - Return value when Process is executed with IMediaObjectInPlace - - - - - Success. There is no remaining data to process. - - - - - Success. There is still data to process. - - - - - DMO Input Data Buffer Flags - - - - - None - - - - - DMO_INPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_INPUT_DATA_BUFFERF_TIME - - - - - DMO_INPUT_DATA_BUFFERF_TIMELENGTH - - - - - http://msdn.microsoft.com/en-us/library/aa929922.aspx - DMO_MEDIA_TYPE - - - - - Major type - - - - - Major type name - - - - - Subtype - - - - - Subtype name - - - - - Fixed size samples - - - - - Sample size - - - - - Format type - - - - - Format type name - - - - - Gets the structure as a Wave format (if it is one) - - - - - Sets this object up to point to a wave format - - Wave format structure - - - - DMO Output Data Buffer - - - - - Creates a new DMO Output Data Buffer structure - - Maximum buffer size - - - - Dispose - - - - - Media Buffer - - - - - Length of data in buffer - - - - - Status Flags - - - - - Timestamp - - - - - Duration - - - - - Retrives the data in this buffer - - Buffer to receive data - Offset into buffer - - - - Is more data available - If true, ProcessOuput should be called again - - - - - DMO Output Data Buffer Flags - - - - - None - - - - - DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_OUTPUT_DATA_BUFFERF_TIME - - - - - DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH - - - - - DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE - - - - - DMO_PARTIAL_MEDIATYPE - - - - - DMO Process Output Flags - - - - - None - - - - - DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER - - - - - Chorus Phase - - - - - DSFXCHORUS_PHASE_NEG_180 - - - - - DSFXCHORUS_PHASE_NEG_90 - - - - - DSFXCHORUS_PHASE_ZERO - - - - - DSFXCHORUS_PHASE_90 - - - - - DSFXCHORUS_PHASE_180 - - - - - Chorus Wave Form - - - - - DSFXCHORUS_WAVE_TRIANGLE - - - - - DSFXCHORUS_WAVE_SIN - - - - - DMO Chorus Effect - - - - - DMO Chorus Params - - - - - DSFXCHORUS_WETDRYMIX_MIN - - - - - DSFXCHORUS_WETDRYMIX_MAX - - - - - DSFXCHORUS_WETDRYMIX_DEFAULT - - - - - DSFXCHORUS_DEPTH_MIN - - - - - DSFXCHORUS_DEPTH_MAX - - - - - DSFXCHORUS_DEPTH_DEFAULT - - - - - DSFXCHORUS_FEEDBACK_MIN - - - - - DSFXCHORUS_FEEDBACK_MAX - - - - - DSFXCHORUS_FEEDBACK_DEFAULT - - - - - DSFXCHORUS_FREQUENCY_MIN - - - - - DSFXCHORUS_FREQUENCY_MAX - - - - - DSFXCHORUS_FREQUENCY_DEFAULT - - - - - DSFXCHORUS_WAVE_DEFAULT - - - - - DSFXCHORUS_DELAY_MIN - - - - - DSFXCHORUS_DELAY_MAX - - - - - DSFXCHORUS_DELAY_DEFAULT - - - - - DSFXCHORUS_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Chorus - - - - - Dispose code - - - - - DMO Compressor Effect - - - - - DMO Compressor Params - - - - - DSFXCOMPRESSOR_GAIN_MIN - - - - - DSFXCOMPRESSOR_GAIN_MAX - - - - - DSFXCOMPRESSOR_GAIN_DEFAULT - - - - - DSFXCOMPRESSOR_ATTACK_MIN - - - - - DSFXCOMPRESSOR_ATTACK_MAX - - - - - DSFXCOMPRESSOR_ATTACK_DEFAULT - - - - - DSFXCOMPRESSOR_RELEASE_MIN - - - - - DSFXCOMPRESSOR_RELEASE_MAX - - - - - DSFXCOMPRESSOR_RELEASE_DEFAULT - - - - - DSFXCOMPRESSOR_THRESHOLD_MIN - - - - - DSFXCOMPRESSOR_THRESHOLD_MAX - - - - - DSFXCOMPRESSOR_THRESHOLD_DEFAULT - - - - - DSFXCOMPRESSOR_RATIO_MIN - - - - - DSFXCOMPRESSOR_RATIO_MAX - - - - - DSFXCOMPRESSOR_RATIO_DEFAULT - - - - - DSFXCOMPRESSOR_PREDELAY_MIN - - - - - DSFXCOMPRESSOR_PREDELAY_MAX - - - - - DSFXCOMPRESSOR_PREDELAY_DEFAULT - - - - - Output gain of signal after compression. - - - - - Time before compression reaches its full value. - - - - - Speed at which compression is stopped after input drops below Threshold. - - - - - Point at which compression begins, in decibels. - - - - - Compression ratio - - - - - Time after Threshold is reached before attack phase is started, in milliseconds. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Compressor - - - - - Dispose code - - - - - DMO Distortion Effect - - - - - DMO Distortion Params - - - - - DSFXDISTORTION_GAIN_MIN - - - - - DSFXDISTORTION_GAIN_MAX - - - - - DSFXDISTORTION_GAIN_DEFAULT - - - - - DSFXDISTORTION_EDGE_MIN - - - - - DSFXDISTORTION_EDGE_MAX - - - - - DSFXDISTORTION_EDGE_DEFAULT - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MIN - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MAX - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_DEFAULT - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MIN - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MAX - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_DEFAULT - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MIN - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MAX - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_DEFAULT - - - - - Amount of signal change after distortion. - - - - - Percentage of distortion intensity. - - - - - Center frequency of harmonic content addition. - - - - - Width of frequency band that determines range of harmonic content addition. - - - - - Filter cutoff for high-frequency harmonics attenuation. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Distortion - - - - - Dispose code - - - - - Dmo Echo Effect - - - - - DMO Echo Params - - - - - DSFXECHO_WETDRYMIX_MIN - - - - - DSFXECHO_WETDRYMIX_MAX - - - - - DSFXECHO_WETDRYMIX_DEFAULT - - - - - DSFXECHO_FEEDBACK_MIN - - - - - DSFXECHO_FEEDBACK_MAX - - - - - DSFXECHO_FEEDBACK_DEFAULT - - - - - DSFXECHO_LEFTDELAY_MIN - - - - - DSFXECHO_LEFTDELAY_MAX - - - - - DSFXECHO_LEFTDELAY_DEFAULT - - - - - DSFXECHO_RIGHTDELAY_MIN - - - - - DSFXECHO_RIGHTDELAY_MAX - - - - - DSFXECHO_RIGHTDELAY_DEFAULT - - - - - DSFXECHO_PANDELAY_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage of output fed back into input. - - - - - Delay for left channel, in milliseconds. - - - - - Delay for right channel, in milliseconds. - - - - - Value that specifies whether to swap left and right delays with each successive echo. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Echo - - - - - Dispose code - - - - - DMO Flanger Effect - - - - - DMO Flanger Params - - - - - DSFXFLANGER_WETDRYMIX_MIN - - - - - DSFXFLANGER_WETDRYMIX_MAX - - - - - DSFXFLANGER_WETDRYMIX_DEFAULT - - - - - DSFXFLANGER_DEPTH_MIN - - - - - DSFXFLANGER_DEPTH_MAX - - - - - DSFXFLANGER_DEPTH_DEFAULT - - - - - DSFXFLANGER_FEEDBACK_MIN - - - - - DSFXFLANGER_FEEDBACK_MAX - - - - - DSFXFLANGER_FEEDBACK_DEFAULT - - - - - DSFXFLANGER_FREQUENCY_MIN - - - - - DSFXFLANGER_FREQUENCY_MAX - - - - - DSFXFLANGER_FREQUENCY_DEFAULT - - - - - DSFXFLANGER_WAVE_DEFAULT - - - - - DSFXFLANGER_DELAY_MIN - - - - - DSFXFLANGER_DELAY_MAX - - - - - DSFXFLANGER_DELAY_DEFAULT - - - - - DSFXFLANGER_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Flanger - - - - - Dispose code - - - - - DMO Gargle Effect - - - - - DMO Gargle Params - - - - - DSFXGARGLE_RATEHZ_MIN - - - - - DSFXGARGLE_RATEHZ_MAX - - - - - DSFXGARGLE_RATEHZ_DEFAULT - - - - - DSFXGARGLE_WAVE_DEFAULT - - - - - Rate of modulation in hz - - - - - Gargle Wave Shape - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Gargle - - - - - Dispose code - - - - - DMO I3DL2Reverb Effect - - - - - DMO I3DL2Reverb Params - - - - - DSFX_I3DL2REVERB_ROOM_MIN - - - - - DSFX_I3DL2REVERB_ROOM_MAX - - - - - DSFX_I3DL2REVERB_ROOM_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMHF_MIN - - - - - DSFX_I3DL2REVERB_ROOMHF_MAX - - - - - DSFX_I3DL2REVERB_ROOMHF_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MIN - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MAX - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYTIME_MIN - - - - - DSFX_I3DL2REVERB_DECAYTIME_MAX - - - - - DSFX_I3DL2REVERB_DECAYTIME_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MIN - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MAX - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONS_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERB_MIN - - - - - DSFX_I3DL2REVERB_REVERB_MAX - - - - - DSFX_I3DL2REVERB_REVERB_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MIN - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MAX - - - - - DSFX_I3DL2REVERB_REVERBDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_DIFFUSION_MIN - - - - - DSFX_I3DL2REVERB_DIFFUSION_MAX - - - - - DSFX_I3DL2REVERB_DIFFUSION_DEFAULT - - - - - DSFX_I3DL2REVERB_DENSITY_MIN - - - - - DSFX_I3DL2REVERB_DENSITY_MAX - - - - - DSFX_I3DL2REVERB_DENSITY_DEFAULT - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MIN - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MAX - - - - - DSFX_I3DL2REVERB_HFREFERENCE_DEFAULT - - - - - DSFX_I3DL2REVERB_QUALITY_MIN - - - - - DSFX_I3DL2REVERB_QUALITY_MAX - - - - - DSFX_I3DL2REVERB_QUALITY_DEFAULT - - - - - Attenuation of the room effect, in millibels (mB) - - - - - Attenuation of the room high-frequency effect, in mB. - - - - - Rolloff factor for the reflected signals. - - - - - Decay time, in seconds. - - - - - Ratio of the decay time at high frequencies to the decay time at low frequencies. - - - - - Attenuation of early reflections relative to lRoom, in mB. - - - - - Delay time of the first reflection relative to the direct path, in seconds. - - - - - Attenuation of late reverberation relative to lRoom, in mB. - - - - - Time limit between the early reflections and the late reverberation relative to the time of the first reflection. - - - - - Echo density in the late reverberation decay, in percent. - - - - - Modal density in the late reverberation decay, in percent. - - - - - Reference high frequency, in hertz. - - - - - the quality of the environmental reverberation effect. Higher values produce better quality at the expense of processing time. - - - - - Sets standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - retrieves an identifier for standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO I3DL2Reverb - - - - - Dispose code - - - - - DMO Parametric Equalizer Effect - - - - - DMO ParamEq Params - - - - - DSFXPARAMEQ_CENTER_MIN - - - - - DSFXPARAMEQ_CENTER_MAX - - - - - DSFXPARAMEQ_CENTER_DEFAULT - - - - - DSFXPARAMEQ_BANDWIDTH_MIN - - - - - DSFXPARAMEQ_BANDWIDTH_MAX - - - - - DSFXPARAMEQ_BANDWIDTH_DEFAULT - - - - - DSFXPARAMEQ_GAIN_MIN - - - - - DSFXPARAMEQ_GAIN_MAX - - - - - DSFXPARAMEQ_GAIN_DEFAULT - - - - - Center frequency, in hertz - - - - - Bandwidth, in semitones. - - - - - Gain - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO ParamEq - - - - - Dispose code - - - - - DMO Reverb Effect - - - - - DMO Reverb Params - - - - - DSFX_WAVESREVERB_INGAIN_MIN - - - - - DSFX_WAVESREVERB_INGAIN_MAX - - - - - DSFX_WAVESREVERB_INGAIN_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBMIX_MIN - - - - - DSFX_WAVESREVERB_REVERBMIX_MAX - - - - - DSFX_WAVESREVERB_REVERBMIX_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBTIME_MIN - - - - - DSFX_WAVESREVERB_REVERBTIME_MAX - - - - - DSFX_WAVESREVERB_REVERBTIME_DEFAULT - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MIN - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MAX - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_DEFAULT - - - - - Input gain of signal, in decibels (dB). - - - - - Reverb mix, in dB. - - - - - Reverb time, in milliseconds. - - - - - High-frequency reverb time ratio. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO WavesReverb - - - - - Dispose code - - - - - DSFXECHO_PANDELAY - - - - - DSFXECHO_PANDELAY_MIN - - - - - DSFXECHO_PANDELAY_MAX - - - - - Flanger Phase - - - - - DSFXFLANGER_PHASE_NEG_180 - - - - - DSFXFLANGER_PHASE_NEG_90 - - - - - DSFXFLANGER_PHASE_ZERO - - - - - DSFXFLANGER_PHASE_90 - - - - - DSFXFLANGER_PHASE_180 - - - - - Flanger Wave Form - - - - - DSFXFLANGER_WAVE_TRIANGLE - - - - - DSFXFLANGER_WAVE_SIN - - - - - Gargle Wave Shape - - - - - DSFXGARGLE_WAVE_TRIANGLE - - - - - DSFXGARGLE_WAVE_SQUARE - - - - - I3DL2 Reverberation Presets - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CITY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE - - - - - Interface of DMO Effectors - - Parameters of the effect to be used - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - IMediaBuffer Interface - - - - - Set Length - - Length - HRESULT - - - - Get Max Length - - Max Length - HRESULT - - - - Get Buffer and Length - - Pointer to variable into which to write the Buffer Pointer - Pointer to variable into which to write the Valid Data Length - HRESULT - - - - defined in mediaobj.h - - - - - defined in mediaobj.h - - - - - defined in Medparam.h - - - - - Windows Media Resampler Props - wmcodecdsp.h - - - - - Range is 1 to 60 - - - - - Specifies the channel matrix. - - - - - Attempting to implement the COM IMediaBuffer interface as a .NET object - Not sure what will happen when I pass this to an unmanaged object - - - - - Creates a new Media Buffer - - Maximum length in bytes - - - - Dispose and free memory for buffer - - - - - Finalizer - - - - - Set length of valid data in the buffer - - length - HRESULT - - - - Gets the maximum length of the buffer - - Max length (output parameter) - HRESULT - - - - Gets buffer and / or length - - Pointer to variable into which buffer pointer should be written - Pointer to variable into which valid data length should be written - HRESULT - - - - Length of data in the media buffer - - - - - Loads data into this buffer - - Data to load - Number of bytes to load - - - - Retrieves the data in the output buffer - - buffer to retrieve into - offset within that buffer - - - - Media Object - - - - - Creates a new Media Object - - Media Object COM interface - - - - Number of input streams - - - - - Number of output streams - - - - - Gets the input media type for the specified input stream - - Input stream index - Input type index - DMO Media Type or null if there are no more input types - - - - Gets the DMO Media Output type - - The output stream - Output type index - DMO Media Type or null if no more available - - - - retrieves the media type that was set for an output stream, if any - - Output stream index - DMO Media Type or null if no more available - - - - Enumerates the supported input types - - Input stream index - Enumeration of input types - - - - Enumerates the output types - - Output stream index - Enumeration of supported output types - - - - Querys whether a specified input type is supported - - Input stream index - Media type to check - true if supports - - - - Sets the input type helper method - - Input stream index - Media type - Flags (can be used to test rather than set) - - - - Sets the input type - - Input stream index - Media Type - - - - Sets the input type to the specified Wave format - - Input stream index - Wave format - - - - Requests whether the specified Wave format is supported as an input - - Input stream index - Wave format - true if supported - - - - Helper function to make a DMO Media Type to represent a particular WaveFormat - - - - - Checks if a specified output type is supported - n.b. you may need to set the input type first - - Output stream index - Media type - True if supported - - - - Tests if the specified Wave Format is supported for output - n.b. may need to set the input type first - - Output stream index - Wave format - True if supported - - - - Helper method to call SetOutputType - - - - - Sets the output type - n.b. may need to set the input type first - - Output stream index - Media type to set - - - - Set output type to the specified wave format - n.b. may need to set input type first - - Output stream index - Wave format - - - - Get Input Size Info - - Input Stream Index - Input Size Info - - - - Get Output Size Info - - Output Stream Index - Output Size Info - - - - Process Input - - Input Stream index - Media Buffer - Flags - Timestamp - Duration - - - - Process Output - - Flags - Output buffer count - Output buffers - - - - Gives the DMO a chance to allocate any resources needed for streaming - - - - - Tells the DMO to free any resources needed for streaming - - - - - Gets maximum input latency - - input stream index - Maximum input latency as a ref-time - - - - Flushes all buffered data - - - - - Report a discontinuity on the specified input stream - - Input Stream index - - - - Is this input stream accepting data? - - Input Stream index - true if accepting data - - - - Experimental code, not currently being called - Not sure if it is necessary anyway - - - - - Media Object InPlace - - - - - Creates a new Media Object InPlace - - Media Object InPlace COM Interface - - - - Processes a block of data. - The application supplies a pointer to a block of input data. The DMO processes the data in place. - - Size of the data, in bytes. - offset into buffer - In/Out Data Buffer - Start time of the data. - DmoInplaceProcessFlags - Return value when Process is executed with IMediaObjectInPlace - - - - Creates a copy of the DMO in its current state. - - Copyed MediaObjectInPlace - - - - Retrieves the latency introduced by this DMO. - - The latency, in 100-nanosecond units - - - - Get Media Object - - Media Object - - - - Dispose code - - - - - Media Object Size Info - - - - - Minimum Buffer Size, in bytes - - - - - Max Lookahead - - - - - Alignment - - - - - Media Object Size Info - - - - - ToString - - - - - MP_PARAMINFO - - - - - MP_TYPE - - - - - MPT_INT - - - - - MPT_FLOAT - - - - - MPT_BOOL - - - - - MPT_ENUM - - - - - MPT_MAX - - - - - MP_CURVE_TYPE - - - - - uuids.h, ksuuids.h - - - - - From wmcodecsdp.h - Implements: - - IMediaObject - - IMFTransform (Media foundation - we will leave this for now as there is loads of MF stuff) - - IPropertyStore - - IWMResamplerProps - Can resample PCM or IEEE - - - - - DMO Resampler - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - implements IMediaObject (DirectX Media Object) - implements IMFTransform (Media Foundation Transform) - On Windows XP, it is always an MM (if present at all) - - - - - Windows Media MP3 Decoder (as a DMO) - WORK IN PROGRESS - DO NOT USE! - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - BiQuad filter - - - - - Passes a single sample through the filter - - Input sample - Output sample - - - - Set this up as a low pass filter - - Sample Rate - Cut-off Frequency - Bandwidth - - - - Set this up as a peaking EQ - - Sample Rate - Centre Frequency - Bandwidth (Q) - Gain in decibels - - - - Set this as a high pass filter - - - - - Create a low pass filter - - - - - Create a High pass filter - - - - - Create a bandpass filter with constant skirt gain - - - - - Create a bandpass filter with constant peak gain - - - - - Creates a notch filter - - - - - Creaes an all pass filter - - - - - Create a Peaking EQ - - - - - H(s) = A * (s^2 + (sqrt(A)/Q)*s + A)/(A*s^2 + (sqrt(A)/Q)*s + 1) - - - - a "shelf slope" parameter (for shelving EQ only). - When S = 1, the shelf slope is as steep as it can be and remain monotonically - increasing or decreasing gain with frequency. The shelf slope, in dB/octave, - remains proportional to S for all other values for a fixed f0/Fs and dBgain. - Gain in decibels - - - - H(s) = A * (A*s^2 + (sqrt(A)/Q)*s + 1)/(s^2 + (sqrt(A)/Q)*s + A) - - - - - - - - - - Type to represent complex number - - - - - Real Part - - - - - Imaginary Part - - - - - Envelope generator (ADSR) - - - - - Envelope State - - - - - Idle - - - - - Attack - - - - - Decay - - - - - Sustain - - - - - Release - - - - - Creates and Initializes an Envelope Generator - - - - - Attack Rate (seconds * SamplesPerSecond) - - - - - Decay Rate (seconds * SamplesPerSecond) - - - - - Release Rate (seconds * SamplesPerSecond) - - - - - Sustain Level (1 = 100%) - - - - - Sets the attack curve - - - - - Sets the decay release curve - - - - - Read the next volume multiplier from the envelope generator - - A volume multiplier - - - - Trigger the gate - - If true, enter attack phase, if false enter release phase (unless already idle) - - - - Current envelope state - - - - - Reset to idle state - - - - - Get the current output level - - - - - Summary description for FastFourierTransform. - - - - - This computes an in-place complex-to-complex FFT - x and y are the real and imaginary arrays of 2^m points. - - - - - Applies a Hamming Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hamming window - - - - Applies a Hann Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hann window - - - - Applies a Blackman-Harris Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Blackmann-Harris window - - - - Summary description for ImpulseResponseConvolution. - - - - - A very simple mono convolution algorithm - - - This will be very slow - - - - - This is actually a downwards normalize for data that will clip - - - - - SMB Pitch Shifter - - - - - Pitch Shift - - - - - Pitch Shift - - - - - Short Time Fourier Transform - - - - - Fully managed resampler, based on Cockos WDL Resampler - - - - - Creates a new Resampler - - - - - sets the mode - if sinc set, it overrides interp or filtercnt - - - - - Sets the filter parameters - used for filtercnt>0 but not sinc - - - - - Set feed mode - - if true, that means the first parameter to ResamplePrepare will specify however much input you have, not how much you want - - - - Reset - - - - - Prepare - note that it is safe to call ResamplePrepare without calling ResampleOut (the next call of ResamplePrepare will function as normal) - nb inbuffer was WDL_ResampleSample **, returning a place to put the in buffer, so we return a buffer and offset - - req_samples is output samples desired if !wantInputDriven, or if wantInputDriven is input samples that we have - - - - returns number of samples desired (put these into *inbuffer) - - - - Channel Mode - - - - - Stereo - - - - - Joint Stereo - - - - - Dual Channel - - - - - Mono - - - - - An ID3v2 Tag - - - - - Reads an ID3v2 tag from a stream - - - - - Creates a new ID3v2 tag from a collection of key-value pairs. - - A collection of key-value pairs containing the tags to include in the ID3v2 tag. - A new ID3v2 tag - - - - Convert the frame size to a byte array. - - The frame body size. - - - - - Creates an ID3v2 frame for the given key-value pair. - - - - - - - - Gets the Id3v2 Header size. The size is encoded so that only 7 bits per byte are actually used. - - - - - - - Creates the Id3v2 tag header and returns is as a byte array. - - The Id3v2 frames that will be included in the file. This is used to calculate the ID3v2 tag size. - - - - - Creates the Id3v2 tag for the given key-value pairs and returns it in the a stream. - - - - - - - Raw data from this tag - - - - - Interface for MP3 frame by frame decoder - - - - - Decompress a single MP3 frame - - Frame to decompress - Output buffer - Offset within output buffer - Bytes written to output buffer - - - - Tell the decoder that we have repositioned - - - - - PCM format that we are converting into - - - - - Represents an MP3 Frame - - - - - Reads an MP3 frame from a stream - - input stream - A valid MP3 frame, or null if none found - - - Reads an MP3Frame from a stream - http://mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm has some good info - also see http://www.codeproject.com/KB/audio-video/mpegaudioinfo.aspx - - A valid MP3 frame, or null if none found - - - - Constructs an MP3 frame - - - - - checks if the four bytes represent a valid header, - if they are, will parse the values into Mp3Frame - - - - - Sample rate of this frame - - - - - Frame length in bytes - - - - - Bit Rate - - - - - Raw frame data (includes header bytes) - - - - - MPEG Version - - - - - MPEG Layer - - - - - Channel Mode - - - - - The number of samples in this frame - - - - - The channel extension bits - - - - - The bitrate index (directly from the header) - - - - - Whether the Copyright bit is set - - - - - Whether a CRC is present - - - - - Not part of the MP3 frame itself - indicates where in the stream we found this header - - - - - MP3 Frame Decompressor using ACM - - - - - Creates a new ACM frame decompressor - - The MP3 source format - - - - Output format (PCM) - - - - - Decompresses a frame - - The MP3 frame - destination buffer - Offset within destination buffer - Bytes written into destination buffer - - - - Resets the MP3 Frame Decompressor after a reposition operation - - - - - Disposes of this MP3 frame decompressor - - - - - Finalizer ensuring that resources get released properly - - - - - MPEG Layer flags - - - - - Reserved - - - - - Layer 3 - - - - - Layer 2 - - - - - Layer 1 - - - - - MPEG Version Flags - - - - - Version 2.5 - - - - - Reserved - - - - - Version 2 - - - - - Version 1 - - - - - Represents a Xing VBR header - - - - - Load Xing Header - - Frame - Xing Header - - - - Sees if a frame contains a Xing header - - - - - Number of frames - - - - - Number of bytes - - - - - VBR Scale property - - - - - The MP3 frame - - - - - ASIO 64 bit value - Unfortunately the ASIO API was implemented it before compiler supported consistently 64 bit - integer types. By using the structure the data layout on a little-endian system like the - Intel x86 architecture will result in a "non native" storage of the 64 bit data. The most - significant 32 bit are stored first in memory, the least significant bits are stored in the - higher memory space. However each 32 bit is stored in the native little-endian fashion - - - - - most significant bits (Bits 32..63) - - - - - least significant bits (Bits 0..31) - - - - - ASIO Callbacks - - - - - ASIO Buffer Switch Callback - - - - - ASIO Sample Rate Did Change Callback - - - - - ASIO Message Callback - - - - - ASIO Buffer Switch Time Info Callback - - - - - Buffer switch callback - void (*bufferSwitch) (long doubleBufferIndex, AsioBool directProcess); - - - - - Sample Rate Changed callback - void (*sampleRateDidChange) (AsioSampleRate sRate); - - - - - ASIO Message callback - long (*asioMessage) (long selector, long value, void* message, double* opt); - - - - - ASIO Buffer Switch Time Info Callback - AsioTime* (*bufferSwitchTimeInfo) (AsioTime* params, long doubleBufferIndex, AsioBool directProcess); - - - - - ASIO Channel Info - - - - - on input, channel index - - - - - Is Input - - - - - Is Active - - - - - Channel Info - - - - - ASIO Sample Type - - - - - Name - - - - - Main AsioDriver Class. To use this class, you need to query first the GetAsioDriverNames() and - then use the GetAsioDriverByName to instantiate the correct AsioDriver. - This is the first AsioDriver binding fully implemented in C#! - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Gets the ASIO driver names installed. - - a list of driver names. Use this name to GetAsioDriverByName - - - - Instantiate a AsioDriver given its name. - - The name of the driver - an AsioDriver instance - - - - Instantiate the ASIO driver by GUID. - - The GUID. - an AsioDriver instance - - - - Inits the AsioDriver.. - - The sys handle. - - - - - Gets the name of the driver. - - - - - - Gets the driver version. - - - - - - Gets the error message. - - - - - - Starts this instance. - - - - - Stops this instance. - - - - - Gets the number of channels. - - The num input channels. - The num output channels. - - - - Gets the latencies (n.b. does not throw an exception) - - The input latency. - The output latency. - - - - Gets the size of the buffer. - - Size of the min. - Size of the max. - Size of the preferred. - The granularity. - - - - Determines whether this instance can use the specified sample rate. - - The sample rate. - - true if this instance [can sample rate] the specified sample rate; otherwise, false. - - - - - Gets the sample rate. - - - - - - Sets the sample rate. - - The sample rate. - - - - Gets the clock sources. - - The clocks. - The num sources. - - - - Sets the clock source. - - The reference. - - - - Gets the sample position. - - The sample pos. - The time stamp. - - - - Gets the channel info. - - The channel number. - if set to true [true for input info]. - Channel Info - - - - Creates the buffers. - - The buffer infos. - The num channels. - Size of the buffer. - The callbacks. - - - - Disposes the buffers. - - - - - Controls the panel. - - - - - Futures the specified selector. - - The selector. - The opt. - - - - Notifies OutputReady to the AsioDriver. - - - - - - Releases this instance. - - - - - Handles the exception. Throws an exception based on the error. - - The error to check. - Method name - - - - Inits the vTable method from GUID. This is a tricky part of this class. - - The ASIO GUID. - - - - Internal VTable structure to store all the delegates to the C++ COM method. - - - - - ASIODriverCapability holds all the information from the AsioDriver. - Use ASIODriverExt to get the Capabilities - - - - - Drive Name - - - - - Number of Input Channels - - - - - Number of Output Channels - - - - - Input Latency - - - - - Output Latency - - - - - Buffer Minimum Size - - - - - Buffer Maximum Size - - - - - Buffer Preferred Size - - - - - Buffer Granularity - - - - - Sample Rate - - - - - Input Channel Info - - - - - Output Channel Info - - - - - Callback used by the AsioDriverExt to get wave data - - - - - AsioDriverExt is a simplified version of the AsioDriver. It provides an easier - way to access the capabilities of the Driver and implement the callbacks necessary - for feeding the driver. - Implementation inspired from Rob Philpot's with a managed C++ ASIO wrapper BlueWave.Interop.Asio - http://www.codeproject.com/KB/mcpp/Asio.Net.aspx - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Initializes a new instance of the class based on an already - instantiated AsioDriver instance. - - A AsioDriver already instantiated. - - - - Allows adjustment of which is the first output channel we write to - - Output Channel offset - Input Channel offset - - - - Gets the driver used. - - The ASIOdriver. - - - - Starts playing the buffers. - - - - - Stops playing the buffers. - - - - - Shows the control panel. - - - - - Releases this instance. - - - - - Determines whether the specified sample rate is supported. - - The sample rate. - - true if [is sample rate supported]; otherwise, false. - - - - - Sets the sample rate. - - The sample rate. - - - - Gets or sets the fill buffer callback. - - The fill buffer callback. - - - - Gets the capabilities of the AsioDriver. - - The capabilities. - - - - Creates the buffers for playing. - - The number of outputs channels. - The number of input channel. - if set to true [use max buffer size] else use Prefered size - - - - Builds the capabilities internally. - - - - - Callback called by the AsioDriver on fill buffer demand. Redirect call to external callback. - - Index of the double buffer. - if set to true [direct process]. - - - - Callback called by the AsioDriver on event "Samples rate changed". - - The sample rate. - - - - Asio message call back. - - The selector. - The value. - The message. - The opt. - - - - - Buffers switch time info call back. - - The asio time param. - Index of the double buffer. - if set to true [direct process]. - - - - - ASIO Error Codes - - - - - This value will be returned whenever the call succeeded - - - - - unique success return value for ASIOFuture calls - - - - - hardware input or output is not present or available - - - - - hardware is malfunctioning (can be returned by any ASIO function) - - - - - input parameter invalid - - - - - hardware is in a bad mode or used in a bad mode - - - - - hardware is not running when sample position is inquired - - - - - sample clock or rate cannot be determined or is not present - - - - - not enough memory for completing the request - - - - - ASIO Message Selector - - - - - selector in <value>, returns 1L if supported, - - - - - returns engine (host) asio implementation version, - - - - - request driver reset. if accepted, this - - - - - not yet supported, will currently always return 0L. - - - - - the driver went out of sync, such that - - - - - the drivers latencies have changed. The engine - - - - - if host returns true here, it will expect the - - - - - supports timecode - - - - - unused - value: number of commands, message points to mmc commands - - - - - kAsioSupportsXXX return 1 if host supports this - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - driver detected an overload - - - - - This class stores convertors for different interleaved WaveFormat to ASIOSampleType separate channel - format. - - - - - Selects the sample convertor based on the input WaveFormat and the output ASIOSampleTtype. - - The wave format. - The type. - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor Float to INT - - - - - Optimized convertor for 2 channels INT to INT - - - - - Generic convertor INT to INT - - - - - Optimized convertor for 2 channels INT to SHORT - - - - - Generic convertor INT to SHORT - - - - - Generic convertor INT to FLOAT - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor SHORT - - - - - Generic converter 24 LSB - - - - - Generic convertor for float - - - - - ASIO Sample Type - - - - - Int 16 MSB - - - - - Int 24 MSB (used for 20 bits as well) - - - - - Int 32 MSB - - - - - IEEE 754 32 bit float - - - - - IEEE 754 64 bit double float - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - Int 16 LSB - - - - - Int 24 LSB - used for 20 bits as well - - - - - Int 32 LSB - - - - - IEEE 754 32 bit float, as found on Intel x86 architecture - - - - - IEEE 754 64 bit double float, as found on Intel x86 architecture - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - DSD 1 bit data, 8 samples per byte. First sample in Least significant bit. - - - - - DSD 1 bit data, 8 samples per byte. First sample in Most significant bit. - - - - - DSD 8 bit data, 1 sample per byte. No Endianness required. - - - - - ASIO common Exception. - - - - - Gets the name of the error. - - The error. - the name of the error - - - - Represents an installed ACM Driver - - - - - Helper function to determine whether a particular codec is installed - - The short name of the function - Whether the codec is installed - - - - Attempts to add a new ACM driver from a file - - Full path of the .acm or dll file containing the driver - Handle to the driver - - - - Removes a driver previously added using AddLocalDriver - - Local driver to remove - - - - Show Format Choose Dialog - - Owner window handle, can be null - Window title - Enumeration flags. None to get everything - Enumeration format. Only needed with certain enumeration flags - The selected format - Textual description of the selected format - Textual description of the selected format tag - True if a format was selected - - - - Gets the maximum size needed to store a WaveFormat for ACM interop functions - - - - - Finds a Driver by its short name - - Short Name - The driver, or null if not found - - - - Gets a list of the ACM Drivers installed - - - - - The callback for acmDriverEnum - - - - - Creates a new ACM Driver object - - Driver handle - - - - The short name of this driver - - - - - The full name of this driver - - - - - The driver ID - - - - - ToString - - - - - The list of FormatTags for this ACM Driver - - - - - Gets all the supported formats for a given format tag - - Format tag - Supported formats - - - - Opens this driver - - - - - Closes this driver - - - - - Dispose - - - - - Flags for use with acmDriverAdd - - - - - ACM_DRIVERADDF_LOCAL - - - - - ACM_DRIVERADDF_GLOBAL - - - - - ACM_DRIVERADDF_FUNCTION - - - - - ACM_DRIVERADDF_NOTIFYHWND - - - - - Interop structure for ACM driver details (ACMDRIVERDETAILS) - http://msdn.microsoft.com/en-us/library/dd742889%28VS.85%29.aspx - - - - - DWORD cbStruct - - - - - FOURCC fccType - - - - - FOURCC fccComp - - - - - WORD wMid; - - - - - WORD wPid - - - - - DWORD vdwACM - - - - - DWORD vdwDriver - - - - - DWORD fdwSupport; - - - - - DWORD cFormatTags - - - - - DWORD cFilterTags - - - - - HICON hicon - - - - - TCHAR szShortName[ACMDRIVERDETAILS_SHORTNAME_CHARS]; - - - - - TCHAR szLongName[ACMDRIVERDETAILS_LONGNAME_CHARS]; - - - - - TCHAR szCopyright[ACMDRIVERDETAILS_COPYRIGHT_CHARS]; - - - - - TCHAR szLicensing[ACMDRIVERDETAILS_LICENSING_CHARS]; - - - - - TCHAR szFeatures[ACMDRIVERDETAILS_FEATURES_CHARS]; - - - - - ACMDRIVERDETAILS_SHORTNAME_CHARS - - - - - ACMDRIVERDETAILS_LONGNAME_CHARS - - - - - ACMDRIVERDETAILS_COPYRIGHT_CHARS - - - - - ACMDRIVERDETAILS_LICENSING_CHARS - - - - - ACMDRIVERDETAILS_FEATURES_CHARS - - - - - Flags indicating what support a particular ACM driver has - - - - ACMDRIVERDETAILS_SUPPORTF_CODEC - Codec - - - ACMDRIVERDETAILS_SUPPORTF_CONVERTER - Converter - - - ACMDRIVERDETAILS_SUPPORTF_FILTER - Filter - - - ACMDRIVERDETAILS_SUPPORTF_HARDWARE - Hardware - - - ACMDRIVERDETAILS_SUPPORTF_ASYNC - Async - - - ACMDRIVERDETAILS_SUPPORTF_LOCAL - Local - - - ACMDRIVERDETAILS_SUPPORTF_DISABLED - Disabled - - - - ACM_DRIVERENUMF_NOLOCAL, Only global drivers should be included in the enumeration - - - - - ACM_DRIVERENUMF_DISABLED, Disabled ACM drivers should be included in the enumeration - - - - - ACM Format - - - - - Format Index - - - - - Format Tag - - - - - Support Flags - - - - - WaveFormat - - - - - WaveFormat Size - - - - - Format Description - - - - - ACMFORMATCHOOSE - http://msdn.microsoft.com/en-us/library/dd742911%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD fdwStyle; - - - - - HWND hwndOwner; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - LPCTSTR pszTitle; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - LPTSTR pszName; - n.b. can be written into - - - - - DWORD cchName - Should be at least 128 unless name is zero - - - - - DWORD fdwEnum; - - - - - LPWAVEFORMATEX pwfxEnum; - - - - - HINSTANCE hInstance; - - - - - LPCTSTR pszTemplateName; - - - - - LPARAM lCustData; - - - - - ACMFORMATCHOOSEHOOKPROC pfnHook; - - - - - None - - - - - ACMFORMATCHOOSE_STYLEF_SHOWHELP - - - - - ACMFORMATCHOOSE_STYLEF_ENABLEHOOK - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATE - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATEHANDLE - - - - - ACMFORMATCHOOSE_STYLEF_INITTOWFXSTRUCT - - - - - ACMFORMATCHOOSE_STYLEF_CONTEXTHELP - - - - - ACMFORMATDETAILS - http://msdn.microsoft.com/en-us/library/dd742913%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD dwFormatIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD fdwSupport; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - ACMFORMATDETAILS_FORMAT_CHARS - - - - - Format Enumeration Flags - - - - - None - - - - - ACM_FORMATENUMF_CONVERT - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will only enumerate destination formats that can be converted from the given pwfx format. - - - - - ACM_FORMATENUMF_HARDWARE - The enumerator should only enumerate formats that are supported as native input or output formats on one or more of the installed waveform-audio devices. This flag provides a way for an application to choose only formats native to an installed waveform-audio device. This flag must be used with one or both of the ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT flags. Specifying both ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT will enumerate only formats that can be opened for input or output. This is true regardless of whether this flag is specified. - - - - - ACM_FORMATENUMF_INPUT - Enumerator should enumerate only formats that are supported for input (recording). - - - - - ACM_FORMATENUMF_NCHANNELS - The nChannels member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_NSAMPLESPERSEC - The nSamplesPerSec member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_OUTPUT - Enumerator should enumerate only formats that are supported for output (playback). - - - - - ACM_FORMATENUMF_SUGGEST - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate all suggested destination formats for the given pwfx format. This mechanism can be used instead of the acmFormatSuggest function to allow an application to choose the best suggested format for conversion. The dwFormatIndex member will always be set to zero on return. - - - - - ACM_FORMATENUMF_WBITSPERSAMPLE - The wBitsPerSample member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_WFORMATTAG - The wFormatTag member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. The dwFormatTag member of the ACMFORMATDETAILS structure must be equal to the wFormatTag member. - - - - - ACM_FORMATSUGGESTF_WFORMATTAG - - - - - ACM_FORMATSUGGESTF_NCHANNELS - - - - - ACM_FORMATSUGGESTF_NSAMPLESPERSEC - - - - - ACM_FORMATSUGGESTF_WBITSPERSAMPLE - - - - - ACM_FORMATSUGGESTF_TYPEMASK - - - - - ACM Format Tag - - - - - Format Tag Index - - - - - Format Tag - - - - - Format Size - - - - - Support Flags - - - - - Standard Formats Count - - - - - Format Description - - - - - DWORD cbStruct; - - - - - DWORD dwFormatTagIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD cbFormatSize; - - - - - DWORD fdwSupport; - - - - - DWORD cStandardFormats; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - ACMFORMATTAGDETAILS_FORMATTAG_CHARS - - - - - Interop definitions for Windows ACM (Audio Compression Manager) API - - - - - http://msdn.microsoft.com/en-us/library/dd742910%28VS.85%29.aspx - UINT ACMFORMATCHOOSEHOOKPROC acmFormatChooseHookProc( - HWND hwnd, - UINT uMsg, - WPARAM wParam, - LPARAM lParam - - - - - http://msdn.microsoft.com/en-us/library/dd742916%28VS.85%29.aspx - MMRESULT acmFormatSuggest( - HACMDRIVER had, - LPWAVEFORMATEX pwfxSrc, - LPWAVEFORMATEX pwfxDst, - DWORD cbwfxDst, - DWORD fdwSuggest); - - - - - http://msdn.microsoft.com/en-us/library/dd742928%28VS.85%29.aspx - MMRESULT acmStreamOpen( - LPHACMSTREAM phas, - HACMDRIVER had, - LPWAVEFORMATEX pwfxSrc, - LPWAVEFORMATEX pwfxDst, - LPWAVEFILTER pwfltr, - DWORD_PTR dwCallback, - DWORD_PTR dwInstance, - DWORD fdwOpen - - - - - A version with pointers for troubleshooting - - - - - AcmStream encapsulates an Audio Compression Manager Stream - used to convert audio from one format to another - - - - - Creates a new ACM stream to convert one format to another. Note that - not all conversions can be done in one step - - The source audio format - The destination audio format - - - - Creates a new ACM stream to convert one format to another, using a - specified driver identifier and wave filter - - the driver identifier - the source format - the wave filter - - - - Returns the number of output bytes for a given number of input bytes - - Number of input bytes - Number of output bytes - - - - Returns the number of source bytes for a given number of destination bytes - - Number of destination bytes - Number of source bytes - - - - Suggests an appropriate PCM format that the compressed format can be converted - to in one step - - The compressed format - The PCM format - - - - Returns the Source Buffer. Fill this with data prior to calling convert - - - - - Returns the Destination buffer. This will contain the converted data - after a successful call to Convert - - - - - Report that we have repositioned in the source stream - - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of source bytes actually converted - The number of converted bytes in the DestinationBuffer - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of converted bytes in the DestinationBuffer - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - ACMSTREAMHEADER_STATUSF_DONE - - - - - ACMSTREAMHEADER_STATUSF_PREPARED - - - - - ACMSTREAMHEADER_STATUSF_INQUEUE - - - - - Interop structure for ACM stream headers. - ACMSTREAMHEADER - http://msdn.microsoft.com/en-us/library/dd742926%28VS.85%29.aspx - - - - - ACM_STREAMOPENF_QUERY, ACM will be queried to determine whether it supports the given conversion. A conversion stream will not be opened, and no handle will be returned in the phas parameter. - - - - - ACM_STREAMOPENF_ASYNC, Stream conversion should be performed asynchronously. If this flag is specified, the application can use a callback function to be notified when the conversion stream is opened and closed and after each buffer is converted. In addition to using a callback function, an application can examine the fdwStatus member of the ACMSTREAMHEADER structure for the ACMSTREAMHEADER_STATUSF_DONE flag. - - - - - ACM_STREAMOPENF_NONREALTIME, ACM will not consider time constraints when converting the data. By default, the driver will attempt to convert the data in real time. For some formats, specifying this flag might improve the audio quality or other characteristics. - - - - - CALLBACK_TYPEMASK, callback type mask - - - - - CALLBACK_NULL, no callback - - - - - CALLBACK_WINDOW, dwCallback is a HWND - - - - - CALLBACK_TASK, dwCallback is a HTASK - - - - - CALLBACK_FUNCTION, dwCallback is a FARPROC - - - - - CALLBACK_THREAD, thread ID replaces 16 bit task - - - - - CALLBACK_EVENT, dwCallback is an EVENT Handle - - - - - ACM_STREAMSIZEF_SOURCE - - - - - ACM_STREAMSIZEF_DESTINATION - - - - - Summary description for WaveFilter. - - - - - cbStruct - - - - - dwFilterTag - - - - - fdwFilter - - - - - reserved - - - - ACM_METRIC_COUNT_DRIVERS - - - ACM_METRIC_COUNT_CODECS - - - ACM_METRIC_COUNT_CONVERTERS - - - ACM_METRIC_COUNT_FILTERS - - - ACM_METRIC_COUNT_DISABLED - - - ACM_METRIC_COUNT_HARDWARE - - - ACM_METRIC_COUNT_LOCAL_DRIVERS - - - ACM_METRIC_COUNT_LOCAL_CODECS - - - ACM_METRIC_COUNT_LOCAL_CONVERTERS - - - ACM_METRIC_COUNT_LOCAL_FILTERS - - - ACM_METRIC_COUNT_LOCAL_DISABLED - - - ACM_METRIC_HARDWARE_WAVE_INPUT - - - ACM_METRIC_HARDWARE_WAVE_OUTPUT - - - ACM_METRIC_MAX_SIZE_FORMAT - - - ACM_METRIC_MAX_SIZE_FILTER - - - ACM_METRIC_DRIVER_SUPPORT - - - ACM_METRIC_DRIVER_PRIORITY - - - - ACM_STREAMCONVERTF_BLOCKALIGN - - - - - ACM_STREAMCONVERTF_START - - - - - ACM_STREAMCONVERTF_END - - - - - Wave Callback Info - - - - - Callback Strategy - - - - - Window Handle (if applicable) - - - - - Sets up a new WaveCallbackInfo for function callbacks - - - - - Sets up a new WaveCallbackInfo to use a New Window - IMPORTANT: only use this on the GUI thread - - - - - Sets up a new WaveCallbackInfo to use an existing window - IMPORTANT: only use this on the GUI thread - - - - - Wave Callback Strategy - - - - - Use a function - - - - - Create a new window (should only be done if on GUI thread) - - - - - Use an existing window handle - - - - - Use an event handle - - - - - WaveHeader interop structure (WAVEHDR) - http://msdn.microsoft.com/en-us/library/dd743837%28VS.85%29.aspx - - - - pointer to locked data buffer (lpData) - - - length of data buffer (dwBufferLength) - - - used for input only (dwBytesRecorded) - - - for client's use (dwUser) - - - assorted flags (dwFlags) - - - loop control counter (dwLoops) - - - PWaveHdr, reserved for driver (lpNext) - - - reserved for driver - - - - Wave Header Flags enumeration - - - - - WHDR_BEGINLOOP - This buffer is the first buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_DONE - Set by the device driver to indicate that it is finished with the buffer and is returning it to the application. - - - - - WHDR_ENDLOOP - This buffer is the last buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_INQUEUE - Set by Windows to indicate that the buffer is queued for playback. - - - - - WHDR_PREPARED - Set by Windows to indicate that the buffer has been prepared with the waveInPrepareHeader or waveOutPrepareHeader function. - - - - - WaveInCapabilities structure (based on WAVEINCAPS2 from mmsystem.h) - http://msdn.microsoft.com/en-us/library/ms713726(VS.85).aspx - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Number of channels supported - - - - - The product name - - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name from the registry if supported - - - - - Event Args for WaveInStream event - - - - - Creates new WaveInEventArgs - - - - - Buffer containing recorded data. Note that it might not be completely - full. - - - - - The number of recorded bytes in Buffer. - - - - - MME Wave function interop - - - - - CALLBACK_NULL - No callback - - - - - CALLBACK_FUNCTION - dwCallback is a FARPROC - - - - - CALLBACK_EVENT - dwCallback is an EVENT handle - - - - - CALLBACK_WINDOW - dwCallback is a HWND - - - - - CALLBACK_THREAD - callback is a thread ID - - - - - WIM_OPEN - - - - - WIM_CLOSE - - - - - WIM_DATA - - - - - WOM_CLOSE - - - - - WOM_DONE - - - - - WOM_OPEN - - - - - WaveOutCapabilities structure (based on WAVEOUTCAPS2 from mmsystem.h) - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/multimed/htm/_win32_waveoutcaps_str.asp - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Optional functionality supported by the device - - - - - Number of channels supported - - - - - Whether playback control is supported - - - - - The product name - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Supported wave formats for WaveOutCapabilities - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Flags indicating what features this WaveOut device supports - - - - supports pitch control (WAVECAPS_PITCH) - - - supports playback rate control (WAVECAPS_PLAYBACKRATE) - - - supports volume control (WAVECAPS_VOLUME) - - - supports separate left-right volume control (WAVECAPS_LRVOLUME) - - - (WAVECAPS_SYNC) - - - (WAVECAPS_SAMPLEACCURATE) - - - - Sample provider interface to make WaveChannel32 extensible - Still a bit ugly, hence internal at the moment - and might even make these into - bit depth converting WaveProviders - - - - - ADSR sample provider allowing you to specify attack, decay, sustain and release values - - - - - Creates a new AdsrSampleProvider with default values - - - - - Attack time in seconds - - - - - Release time in seconds - - - - - Reads audio from this sample provider - - - - - Enters the Release phase - - - - - The output WaveFormat - - - - - Sample Provider to concatenate multiple sample providers together - - - - - Creates a new ConcatenatingSampleProvider - - The source providers to play one after the other. Must all share the same sample rate and channel count - - - - The WaveFormat of this Sample Provider - - - - - Read Samples from this sample provider - - - - - Sample Provider to allow fading in and out - - - - - Creates a new FadeInOutSampleProvider - - The source stream with the audio to be faded in or out - If true, we start faded out - - - - Requests that a fade-in begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Requests that a fade-out begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Reads samples from this sample provider - - Buffer to read into - Offset within buffer to write to - Number of samples desired - Number of samples read - - - - WaveFormat of this SampleProvider - - - - - Simple SampleProvider that passes through audio unchanged and raises - an event every n samples with the maximum sample value from the period - for metering purposes - - - - - Number of Samples per notification - - - - - Raised periodically to inform the user of the max volume - - - - - Initialises a new instance of MeteringSampleProvider that raises 10 stream volume - events per second - - Source sample provider - - - - Initialises a new instance of MeteringSampleProvider - - source sampler provider - Number of samples between notifications - - - - The WaveFormat of this sample provider - - - - - Reads samples from this Sample Provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Event args for aggregated stream volume - - - - - Max sample values array (one for each channel) - - - - - A sample provider mixer, allowing inputs to be added and removed - - - - - Creates a new MixingSampleProvider, with no inputs, but a specified WaveFormat - - The WaveFormat of this mixer. All inputs must be in this format - - - - Creates a new MixingSampleProvider, based on the given inputs - - Mixer inputs - must all have the same waveformat, and must - all be of the same WaveFormat. There must be at least one input - - - - Returns the mixer inputs (read-only - use AddMixerInput to add an input - - - - - When set to true, the Read method always returns the number - of samples requested, even if there are no inputs, or if the - current inputs reach their end. Setting this to true effectively - makes this a never-ending sample provider, so take care if you plan - to write it out to a file. - - - - - Adds a WaveProvider as a Mixer input. - Must be PCM or IEEE float already - - IWaveProvider mixer input - - - - Adds a new mixer input - - Mixer input - - - - Raised when a mixer input has been removed because it has ended - - - - - Removes a mixer input - - Mixer input to remove - - - - Removes all mixer inputs - - - - - The output WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - SampleProvider event args - - - - - Constructs a new SampleProviderEventArgs - - - - - The Sample Provider - - - - - No nonsense mono to stereo provider, no volume adjustment, - just copies input to left and right. - - - - - Initializes a new instance of MonoToStereoSampleProvider - - Source sample provider - - - - WaveFormat of this provider - - - - - Reads samples from this provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Multiplier for left channel (default is 1.0) - - - - - Multiplier for right channel (default is 1.0) - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing sample provider, allowing re-patching of input channels to different - output channels - - Input sample providers. Must all be of the same sample rate, but can have any number of channels - Desired number of output channels. - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads samples from this sample provider - - Buffer to be filled with sample data - Offset into buffer to start writing to, usually 0 - Number of samples required - Number of samples read - - - - The output WaveFormat for this SampleProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Simple class that raises an event on every sample - - - - - Initializes a new instance of NotifyingSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Sample notifier - - - - - Allows you to: - 1. insert a pre-delay of silence before the source begins - 2. skip over a certain amount of the beginning of the source - 3. only play a set amount from the source - 4. insert silence at the end after the source is complete - - - - - Number of samples of silence to insert before playing source - - - - - Amount of silence to insert before playing - - - - - Number of samples in source to discard - - - - - Amount of audio to skip over from the source before beginning playback - - - - - Number of samples to read from source (if 0, then read it all) - - - - - Amount of audio to take from the source (TimeSpan.Zero means play to end) - - - - - Number of samples of silence to insert after playing source - - - - - Amount of silence to insert after playing source - - - - - Creates a new instance of offsetSampleProvider - - The Source Sample Provider to read from - - - - The WaveFormat of this SampleProvider - - - - - Reads from this sample provider - - Sample buffer - Offset within sample buffer to read to - Number of samples required - Number of samples read - - - - Converts a mono sample provider to stereo, with a customisable pan strategy - - - - - Initialises a new instance of the PanningSampleProvider - - Source sample provider, must be mono - - - - Pan value, must be between -1 (left) and 1 (right) - - - - - The pan strategy currently in use - - - - - The WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Pair of floating point values, representing samples or multipliers - - - - - Left value - - - - - Right value - - - - - Required Interface for a Panning Strategy - - - - - Gets the left and right multipliers for a given pan value - - Pan value from -1 to 1 - Left and right multipliers in a stereo sample pair - - - - Simplistic "balance" control - treating the mono input as if it was stereo - In the centre, both channels full volume. Opposite channel decays linearly - as balance is turned to to one side - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Square Root Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Sinus Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Linear Pan - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Converts an IWaveProvider containing 16 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm16BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Samples required - Number of samples read - - - - Converts an IWaveProvider containing 24 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm24BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 32 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm32BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 8 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm8BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples to read - Number of samples read - - - - Utility class that takes an IWaveProvider input at any bit depth - and exposes it as an ISampleProvider. Can turn mono inputs into stereo, - and allows adjusting of volume - (The eventual successor to WaveChannel32) - This class also serves as an example of how you can link together several simple - Sample Providers to form a more useful class. - - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - force mono inputs to become stereo - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - The WaveFormat of this Sample Provider - - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Raised periodically to inform the user of the max volume - (before the volume meter) - - - - - Helper base class for classes converting to ISampleProvider - - - - - Source Wave Provider - - - - - Source buffer (to avoid constantly creating small buffers during playback) - - - - - Initialises a new instance of SampleProviderConverterBase - - Source Wave provider - - - - Wave format of this wave provider - - - - - Reads samples from the source wave provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Ensure the source buffer exists and is big enough - - Bytes required - - - - Utility class for converting to SampleProvider - - - - - Helper function to go from IWaveProvider to a SampleProvider - Must already be PCM or IEEE float - - The WaveProvider to convert - A sample provider - - - - Helper class for when you need to convert back to an IWaveProvider from - an ISampleProvider. Keeps it as IEEE float - - - - - Initializes a new instance of the WaveProviderFloatToWaveProvider class - - Source wave provider - - - - Reads from this provider - - - - - The waveformat of this WaveProvider (same as the source) - - - - - Converts a sample provider to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts a sample provider to 24 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream, clipping if necessary - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - The Format of this IWaveProvider - - - - - - Volume of this channel. 1.0 = full scale, 0.0 to mute - - - - - Signal Generator - Sin, Square, Triangle, SawTooth, White Noise, Pink Noise, Sweep. - - - Posibility to change ISampleProvider - Example : - --------- - WaveOut _waveOutGene = new WaveOut(); - WaveGenerator wg = new SignalGenerator(); - wg.Type = ... - wg.Frequency = ... - wg ... - _waveOutGene.Init(wg); - _waveOutGene.Play(); - - - - - Initializes a new instance for the Generator (Default :: 44.1Khz, 2 channels, Sinus, Frequency = 440, Gain = 1) - - - - - Initializes a new instance for the Generator (UserDef SampleRate & Channels) - - Desired sample rate - Number of channels - - - - The waveformat of this WaveProvider (same as the source) - - - - - Frequency for the Generator. (20.0 - 20000.0 Hz) - Sin, Square, Triangle, SawTooth, Sweep (Start Frequency). - - - - - Return Log of Frequency Start (Read only) - - - - - End Frequency for the Sweep Generator. (Start Frequency in Frequency) - - - - - Return Log of Frequency End (Read only) - - - - - Gain for the Generator. (0.0 to 1.0) - - - - - Channel PhaseReverse - - - - - Type of Generator. - - - - - Length Seconds for the Sweep Generator. - - - - - Reads from this provider. - - - - - Private :: Random for WhiteNoise & Pink Noise (Value form -1 to 1) - - Random value from -1 to +1 - - - - Signal Generator type - - - - - Pink noise - - - - - White noise - - - - - Sweep - - - - - Sine wave - - - - - Square wave - - - - - Triangle Wave - - - - - Sawtooth wave - - - - - Author: Freefall - Date: 05.08.16 - Based on: the port of Stephan M. Bernsee´s pitch shifting class - Port site: https://sites.google.com/site/mikescoderama/pitch-shifting - Test application and github site: https://github.com/Freefall63/NAudio-Pitchshifter - - NOTE: I strongly advice to add a Limiter for post-processing. - For my needs the FastAttackCompressor1175 provides acceptable results: - https://github.com/Jiyuu/SkypeFX/blob/master/JSNet/FastAttackCompressor1175.cs - - UPDATE: Added a simple Limiter based on the pydirac implementation. - https://github.com/echonest/remix/blob/master/external/pydirac225/source/Dirac_LE.cpp - - - - - - Creates a new SMB Pitch Shifting Sample Provider with default settings - - Source provider - - - - Creates a new SMB Pitch Shifting Sample Provider with custom settings - - Source provider - FFT Size (any power of two <= 4096: 4096, 2048, 1024, 512, ...) - Oversampling (number of overlapping windows) - Initial pitch (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - Read from this sample provider - - - - - WaveFormat - - - - - Pitch Factor (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - - Takes a stereo input and turns it to mono - - - - - Creates a new mono ISampleProvider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this SampleProvider - - - - - Very simple sample provider supporting adjustable gain - - - - - Initializes a new instance of VolumeSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Helper class turning an already 32 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Helper class turning an already 64 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Fully managed resampling sample provider, based on the WDL Resampler - - - - - Constructs a new resampler - - Source to resample - Desired output sample rate - - - - Reads from this sample provider - - - - - Output WaveFormat - - - - - Useful extension methods to make switching between WaveAndSampleProvider easier - - - - - Converts a WaveProvider into a SampleProvider (only works for PCM) - - WaveProvider to convert - - - - - Allows sending a SampleProvider directly to an IWavePlayer without needing to convert - back to an IWaveProvider - - The WavePlayer - - - - - - Turns WaveFormatExtensible into a standard waveformat if possible - - Input wave format - A standard PCM or IEEE waveformat, or the original waveformat - - - - Converts a ISampleProvider to a IWaveProvider but still 32 bit float - - SampleProvider to convert - An IWaveProvider - - - - Converts a ISampleProvider to a IWaveProvider but and convert to 16 bit - - SampleProvider to convert - A 16 bit IWaveProvider - - - - Concatenates one Sample Provider on the end of another - - The sample provider to play first - The sample provider to play next - A single sampleprovider to play one after the other - - - - Concatenates one Sample Provider on the end of another with silence inserted - - The sample provider to play first - Silence duration to insert between the two - The sample provider to play next - A single sample provider - - - - Skips over a specified amount of time (by consuming source stream) - - Source sample provider - Duration to skip over - A sample provider that skips over the specified amount of time - - - - Takes a specified amount of time from the source stream - - Source sample provider - Duration to take - A sample provider that reads up to the specified amount of time - - - - Converts a Stereo Sample Provider to mono, allowing mixing of channel volume - - Stereo Source Provider - Amount of left channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - Amount of right channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - A mono SampleProvider - - - - Converts a Mono ISampleProvider to stereo - - Mono Source Provider - Amount to mix to left channel (1.0 is full volume) - Amount to mix to right channel (1.0 is full volume) - - - - - Microsoft ADPCM - See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm - - - - - Empty constructor needed for marshalling from a pointer - - - - - Samples per block - - - - - Number of coefficients - - - - - Coefficients - - - - - Microsoft ADPCM - - Sample Rate - Channels - - - - Serializes this wave format - - Binary writer - - - - String Description of this WaveFormat - - - - - GSM 610 - - - - - Creates a GSM 610 WaveFormat - For now hardcoded to 13kbps - - - - - Samples per block - - - - - Writes this structure to a BinaryWriter - - - - - IMA/DVI ADPCM Wave Format - Work in progress - - - - - parameterless constructor for Marshalling - - - - - Creates a new IMA / DVI ADPCM Wave Format - - Sample Rate - Number of channels - Bits Per Sample - - - - MP3 WaveFormat, MPEGLAYER3WAVEFORMAT from mmreg.h - - - - - Wave format ID (wID) - - - - - Padding flags (fdwFlags) - - - - - Block Size (nBlockSize) - - - - - Frames per block (nFramesPerBlock) - - - - - Codec Delay (nCodecDelay) - - - - - Creates a new MP3 WaveFormat - - - - - Wave Format Padding Flags - - - - - MPEGLAYER3_FLAG_PADDING_ISO - - - - - MPEGLAYER3_FLAG_PADDING_ON - - - - - MPEGLAYER3_FLAG_PADDING_OFF - - - - - Wave Format ID - - - - MPEGLAYER3_ID_UNKNOWN - - - MPEGLAYER3_ID_MPEG - - - MPEGLAYER3_ID_CONSTANTFRAMESIZE - - - - DSP Group TrueSpeech - - - - - DSP Group TrueSpeech WaveFormat - - - - - Writes this structure to a BinaryWriter - - - - - Represents a Wave file format - - - - format type - - - number of channels - - - sample rate - - - for buffer estimation - - - block size of data - - - number of bits per sample of mono data - - - number of following bytes - - - - Creates a new PCM 44.1Khz stereo 16 bit format - - - - - Creates a new 16 bit wave format with the specified sample - rate and channel count - - Sample Rate - Number of channels - - - - Gets the size of a wave buffer equivalent to the latency in milliseconds. - - The milliseconds. - - - - - Creates a WaveFormat with custom members - - The encoding - Sample Rate - Number of channels - Average Bytes Per Second - Block Align - Bits Per Sample - - - - - Creates an A-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a Mu-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a new PCM format with the specified sample rate, bit depth and channels - - - - - Creates a new 32 bit IEEE floating point wave format - - sample rate - number of channels - - - - Helper function to retrieve a WaveFormat structure from a pointer - - WaveFormat structure - - - - - Helper function to marshal WaveFormat to an IntPtr - - WaveFormat - IntPtr to WaveFormat structure (needs to be freed by callee) - - - - Reads in a WaveFormat (with extra data) from a fmt chunk (chunk identifier and - length should already have been read) - - Binary reader - Format chunk length - A WaveFormatExtraData - - - - Reads a new WaveFormat object from a stream - - A binary reader that wraps the stream - - - - Reports this WaveFormat as a string - - String describing the wave format - - - - Compares with another WaveFormat object - - Object to compare to - True if the objects are the same - - - - Provides a Hashcode for this WaveFormat - - A hashcode - - - - Returns the encoding type used - - - - - Writes this WaveFormat object to a stream - - the output stream - - - - Returns the number of channels (1=mono,2=stereo etc) - - - - - Returns the sample rate (samples per second) - - - - - Returns the average number of bytes used per second - - - - - Returns the block alignment - - - - - Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) - Can be 0 for some codecs - - - - - Returns the number of extra bytes used by this waveformat. Often 0, - except for compressed formats which store extra data after the WAVEFORMATEX header - - - - - Custom marshaller for WaveFormat structures - - - - - Gets the instance of this marshaller - - - - - - - Clean up managed data - - - - - Clean up native data - - - - - - Get native data size - - - - - Marshal managed to native - - - - - Marshal Native to Managed - - - - - Summary description for WaveFormatEncoding. - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - - - - - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - WAVE_FORMAT_EXTENSIBLE - - - - - - - WaveFormatExtensible - http://www.microsoft.com/whdc/device/audio/multichaud.mspx - - - - - Parameterless constructor for marshalling - - - - - Creates a new WaveFormatExtensible for PCM or IEEE - - - - - WaveFormatExtensible for PCM or floating point can be awkward to work with - This creates a regular WaveFormat structure representing the same audio format - Returns the WaveFormat unchanged for non PCM or IEEE float - - - - - - SubFormat (may be one of AudioMediaSubtypes) - - - - - Serialize - - - - - - String representation - - - - - This class used for marshalling from unmanaged code - - - - - Allows the extra data to be read - - - - - parameterless constructor for marshalling - - - - - Reads this structure from a BinaryReader - - - - - Writes this structure to a BinaryWriter - - - - - The WMA wave format. - May not be much use because WMA codec is a DirectShow DMO not an ACM - - - - - Generic interface for wave recording - - - - - Recording WaveFormat - - - - - Start Recording - - - - - Stop Recording - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - WASAPI Loopback Capture - based on a contribution from "Pygmy" - http://naudio.codeplex.com/discussions/203605 - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Gets the default audio loopback capture device - - The default audio loopback capture device - - - - Capturing wave format - - - - - Specify loopback - - - - - Allows recording using the Windows waveIn APIs - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Creates a WaveIn device using the specified window handle for callbacks - - A valid window handle - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Called when we get a new buffer of recorded data - - - - - Start recording - - - - - Stop recording - - - - - Gets the current position in bytes from the wave input device. - it calls directly into waveInGetPosition) - - Position in bytes - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - Recording using waveIn api with event callbacks. - Use this for recording in non-gui applications - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Start recording - - - - - Stop recording - - - - - Gets the current position in bytes from the wave input device. - it calls directly into waveInGetPosition) - - Position in bytes - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - This class writes audio data to a .aif file on disk - - - - - Creates an Aiff file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Aiff File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - AiffFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new AiffFileWriter - - The filename to write to - The Wave Format of the output data - - - - The aiff file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this aiff file - - - - - Returns false: Cannot read from a AiffFileWriter - - - - - Returns true: Can write to a AiffFileWriter - - - - - Returns false: Cannot seek within a AiffFileWriter - - - - - Read is not supported for a AiffFileWriter - - - - - Seek is not supported for a AiffFileWriter - - - - - SetLength is not supported for AiffFileWriter - - - - - - Gets the Position in the AiffFile (i.e. number of bytes written so far) - - - - - Appends bytes to the AiffFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Aiff file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Aiff file - They will be converted to the appropriate bit depth depending on the WaveFormat of the AIF file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Aiff file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this AiffFileWriter - - - - - Raised when ASIO data has been recorded. - It is important to handle this as quickly as possible as it is in the buffer callback - - - - - Initialises a new instance of AsioAudioAvailableEventArgs - - Pointers to the ASIO buffers for each channel - Pointers to the ASIO buffers for each channel - Number of samples in each buffer - Audio format within each buffer - - - - Pointer to a buffer per input channel - - - - - Pointer to a buffer per output channel - Allows you to write directly to the output buffers - If you do so, set SamplesPerBuffer = true, - and make sure all buffers are written to with valid data - - - - - Set to true if you have written to the output buffers - If so, AsioOut will not read from its source - - - - - Number of samples in each buffer - - - - - Converts all the recorded audio into a buffer of 32 bit floating point samples, interleaved by channel - - The samples as 32 bit floating point, interleaved - - - - Audio format within each buffer - Most commonly this will be one of, Int32LSB, Int16LSB, Int24LSB or Float32LSB - - - - - Gets as interleaved samples, allocating a float array - - The samples as 32 bit floating point values - - - - ASIO Out Player. New implementation using an internal C# binding. - - This implementation is only supporting Short16Bit and Float32Bit formats and is optimized - for 2 outputs channels . - SampleRate is supported only if AsioDriver is supporting it - - This implementation is probably the first AsioDriver binding fully implemented in C#! - - Original Contributor: Mark Heath - New Contributor to C# binding : Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Playback Stopped - - - - - When recording, fires whenever recorded audio is available - - - - - Initializes a new instance of the class with the first - available ASIO Driver. - - - - - Initializes a new instance of the class with the driver name. - - Name of the device. - - - - Opens an ASIO output device - - Device number (zero based) - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Dispose - - - - - Gets the names of the installed ASIO Driver. - - an array of driver names - - - - Determines whether ASIO is supported. - - - true if ASIO is supported; otherwise, false. - - - - - Inits the driver from the asio driver name. - - Name of the driver. - - - - Shows the control panel - - - - - Starts playback - - - - - Stops playback - - - - - Pauses playback - - - - - Initialises to play - - Source wave provider - - - - Initialises to play, with optional recording - - Source wave provider - set to null for record only - Number of channels to record - Specify sample rate here if only recording, ignored otherwise - - - - driver buffer update callback to fill the wave buffer. - - The input channels. - The output channels. - - - - Gets the latency (in ms) of the playback driver - - - - - Automatically stop when the end of the input stream is reached - Disable this if auto-stop is causing hanging issues - - - - - A flag to let you know that we have reached the end of the input file - Useful if AutoStop is set to false - You can monitor this yourself and call Stop when it is true - - - - - Playback State - - - - - Driver Name - - - - - The number of output channels we are currently using for playback - (Must be less than or equal to DriverOutputChannelCount) - - - - - The number of input channels we are currently recording from - (Must be less than or equal to DriverInputChannelCount) - - - - - The maximum number of input channels this ASIO driver supports - - - - - The maximum number of output channels this ASIO driver supports - - - - - The number of samples per channel, per buffer. - - - - - By default the first channel on the input WaveProvider is sent to the first ASIO output. - This option sends it to the specified channel number. - Warning: make sure you don't set it higher than the number of available output channels - - the number of source channels. - n.b. Future NAudio may modify this - - - - - Input channel offset (used when recording), allowing you to choose to record from just one - specific input rather than them all - - - - - Sets the volume (1.0 is unity gain) - Not supported for ASIO Out. Set the volume on the input stream instead - - - - - Get the input channel name - - channel index (zero based) - channel name - - - - Get the output channel name - - channel index (zero based) - channel name - - - - https://tech.ebu.ch/docs/tech/tech3285.pdf - - - - - Constructs a new BextChunkInfo - - - - - Description (max 256 chars) - - - - - Originator (max 32 chars) - - - - - Originator Reference (max 32 chars) - - - - - Originator Date Time - - - - - Origination Date as string - - - - - Origination as time - - - - - Time reference (first sample count since midnight) - - - - - version 2 has loudness stuff which we don't know so using version 1 - - - - - 64 bytes http://en.wikipedia.org/wiki/UMID - - - - - for version 2 = 180 bytes (10 before are loudness values), using version 1 = 190 bytes - - - - - Coding history arbitrary length string at end of structure - http://www.ebu.ch/CMSimages/fr/tec_text_r98-1999_tcm7-4709.pdf - A=PCM,F=48000,W=16,M=stereo,T=original,CR/LF - - - - - Broadcast WAVE File Writer - - - - - Createa a new BwfWriter - - Rarget filename - WaveFormat - Chunk information - - - - Write audio data to this BWF - - - - - Flush writer, and fix up header sizes - - - - - Disposes this writer - - - - - A wave file writer that adds cue support - - - - - Writes a wave file, including a cues chunk - - - - - Adds a cue to the Wave file - - Sample position - Label text - - - - Updates the header, and writes the cues out - - - - - NativeDirectSoundOut using DirectSound COM interop. - Contact author: Alexandre Mutel - alexandre_mutel at yahoo.fr - Modified by: Graham "Gee" Plumb - - - - - Playback Stopped - - - - - Gets the DirectSound output devices in the system - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - (40ms seems to work under Vista). - - The latency. - Selected device - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets the current position from the wave output device. - - - - - Initialise playback - - The waveprovider to be played - - - - Current playback state - - - - - - The volume 1.0 is full scale - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Determines whether the SecondaryBuffer is lost. - - - true if [is buffer lost]; otherwise, false. - - - - - Convert ms to bytes size according to WaveFormat - - The ms - number of byttes - - - - Processes the samples in a separate thread. - - - - - Stop playback - - - - - Clean up the SecondaryBuffer - - - - In DirectSound, when playback is started, - the rest of the sound that was played last time is played back as noise. - This happens even if the secondary buffer is completely silenced, - so it seems that the buffer in the primary buffer or higher is not cleared. - - - To solve this problem fill the secondary buffer with silence data when stop playback. - - - - - - Feeds the SecondaryBuffer with the WaveStream - - number of bytes to feed - - - - IDirectSound interface - - - - - IDirectSoundBuffer interface - - - - - IDirectSoundNotify interface - - - - - Instanciate DirectSound from the DLL - - The GUID. - The direct sound. - The p unk outer. - - - - DirectSound default playback device GUID - - - - - DirectSound default capture device GUID - - - - - DirectSound default device for voice playback - - - - - DirectSound default device for voice capture - - - - - The DSEnumCallback function is an application-defined callback function that enumerates the DirectSound drivers. - The system calls this function in response to the application's call to the DirectSoundEnumerate or DirectSoundCaptureEnumerate function. - - Address of the GUID that identifies the device being enumerated, or NULL for the primary device. This value can be passed to the DirectSoundCreate8 or DirectSoundCaptureCreate8 function to create a device object for that driver. - Address of a null-terminated string that provides a textual description of the DirectSound device. - Address of a null-terminated string that specifies the module name of the DirectSound driver corresponding to this device. - Address of application-defined data. This is the pointer passed to DirectSoundEnumerate or DirectSoundCaptureEnumerate as the lpContext parameter. - Returns TRUE to continue enumerating drivers, or FALSE to stop. - - - - The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system. - - callback function - User context - - - - Gets the HANDLE of the desktop window. - - HANDLE of the Desktop window - - - - Class for enumerating DirectSound devices - - - - - The device identifier - - - - - Device description - - - - - Device module name - - - - - IWaveBuffer interface use to store wave datas. - Data can be manipulated with arrays (,, - , ) that are pointing to the same memory buffer. - This is a requirement for all subclasses. - - Use the associated Count property based on the type of buffer to get the number of data in the - buffer. - - for the standard implementation using C# unions. - - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets the byte buffer count. - - The byte buffer count. - - - - Gets the float buffer count. - - The float buffer count. - - - - Gets the short buffer count. - - The short buffer count. - - - - Gets the int buffer count. - - The int buffer count. - - - - Represents the interface to a device that can play a WaveFile - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Initialise playback - - The waveprovider to be played - - - - The volume - 1.0f is full scale - Note that not all implementations necessarily support volume changes - - - - - Current playback state - - - - - Indicates that playback has gone into a stopped state due to - reaching the end of the input stream or an error has been encountered during playback - - - - - Interface for IWavePlayers that can report position - - - - - Position (in terms of bytes played - does not necessarily translate directly to the position within the source audio file) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Generic interface for all WaveProviders. - - - - - Gets the WaveFormat of this WaveProvider. - - The wave format. - - - - Fill the specified buffer with wave data. - - The buffer to fill of wave data. - Offset into buffer - The number of bytes to read - the number of bytes written to the buffer. - - - - Like IWaveProvider, but makes it much simpler to put together a 32 bit floating - point mixing engine - - - - - Gets the WaveFormat of this Sample Provider. - - The wave format. - - - - Fill the specified buffer with 32 bit floating point samples - - The buffer to fill with samples. - Offset into buffer - The number of samples to read - the number of samples written to the buffer. - - - - Media Foundation Encoder class allows you to use Media Foundation to encode an IWaveProvider - to any supported encoding format - - - - - Queries the available bitrates for a given encoding output type, sample rate and number of channels - - Audio subtype - a value from the AudioSubtypes class - The sample rate of the PCM to encode - The number of channels of the PCM to encode - An array of available bitrates in average bits per second - - - - Gets all the available media types for a particular - - Audio subtype - a value from the AudioSubtypes class - An array of available media types that can be encoded with this subtype - - - - Helper function to simplify encoding Window Media Audio - Should be supported on Vista and above (not tested) - - Input provider, must be PCM - Output file path, should end with .wma - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to MP3 - By default, will only be available on Windows 8 and above - - Input provider, must be PCM - Output file path, should end with .mp3 - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to AAC - By default, will only be available on Windows 7 and above - - Input provider, must be PCM - Output file path, should end with .mp4 (or .aac on Windows 8) - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Tries to find the encoding media type with the closest bitrate to that specified - - Audio subtype, a value from AudioSubtypes - Your encoder input format (used to check sample rate and channel count) - Your desired bitrate - The closest media type, or null if none available - - - - Creates a new encoder that encodes to the specified output media type - - Desired output media type - - - - Encodes a file - - Output filename (container type is deduced from the filename) - Input provider (should be PCM, some encoders will also allow IEEE float) - - - - Disposes this instance - - - - - - Disposes this instance - - - - - Finalizer - - - - - Playback State - - - - - Stopped - - - - - Playing - - - - - Paused - - - - - Stopped Event Args - - - - - Initializes a new instance of StoppedEventArgs - - An exception to report (null if no exception) - - - - An exception. Will be null if the playback or record operation stopped due to - the user requesting stop or reached the end of the input audio - - - - - Support for playback using Wasapi - - - - - Playback Stopped - - - - - WASAPI Out shared mode, default - - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - Desired latency in milliseconds - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Creates a new WASAPI Output - - Device to use - - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Begin Playback - - - - - Stop playback and flush buffers - - - - - Stop playback without flushing buffers - - - - - Initialize for playing the specified wave stream - - IWaveProvider to play - - - - Playback State - - - - - Volume - - - - - Retrieve the AudioStreamVolume object for this audio stream - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Dispose - - - - - WaveBuffer class use to store wave datas. Data can be manipulated with arrays - (,,, ) that are pointing to the - same memory buffer. Use the associated Count property based on the type of buffer to get the number of - data in the buffer. - Implicit casting is now supported to float[], byte[], int[], short[]. - You must not use Length on returned arrays. - - n.b. FieldOffset is 8 now to allow it to work natively on 64 bit - - - - - Number of Bytes - - - - - Initializes a new instance of the class. - - The number of bytes. The size of the final buffer will be aligned on 4 Bytes (upper bound) - - - - Initializes a new instance of the class binded to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Binds this WaveBuffer instance to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets or sets the byte buffer count. - - The byte buffer count. - - - - Gets or sets the float buffer count. - - The float buffer count. - - - - Gets or sets the short buffer count. - - The short buffer count. - - - - Gets or sets the int buffer count. - - The int buffer count. - - - - Clears the associated buffer. - - - - - Copy this WaveBuffer to a destination buffer up to ByteBufferCount bytes. - - - - - Checks the validity of the count parameters. - - Name of the arg. - The value. - The size of value. - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - Writes to a stream by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The stream the method will output to - The source WaveProvider - - - - WaveFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new WaveFileWriter - - The filename to write to - The Wave Format of the output data - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - Total time (calculated from Length and average bytes per second) - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriter - - - - - Returns true: Can write to a WaveFileWriter - - - - - Returns false: Cannot seek within a WaveFileWriter - - - - - Read is not supported for a WaveFileWriter - - - - - Seek is not supported for a WaveFileWriter - - - - - SetLength is not supported for WaveFileWriter - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - Also updates header, so that WAV file will be valid up to the point currently written - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriter - - - - - Represents a wave out device - - - - - Indicates playback has stopped automatically - - - - - Retrieves the capabilities of a waveOut device - - Device to test - The WaveOut device capabilities - - - - Returns the number of Wave Out devices available in the system - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Creates a default WaveOut device - Will use window callbacks if called from a GUI thread, otherwise function - callbacks - - - - - Creates a WaveOut device using the specified window handle for callbacks - - A valid window handle - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Alternative WaveOut class, making use of the Event callback - - - - - Indicates playback has stopped automatically - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Provides a buffered store of samples - Read method will return queued samples or fill buffer with zeroes - Now backed by a circular buffer - - - - - Creates a new buffered WaveProvider - - WaveFormat - - - - If true, always read the amount of data requested, padding with zeroes if necessary - By default is set to true - - - - - Buffer length in bytes - - - - - Buffer duration - - - - - If true, when the buffer is full, start throwing away data - if false, AddSamples will throw an exception when buffer is full - - - - - The number of buffered bytes - - - - - Buffered Duration - - - - - Gets the WaveFormat - - - - - Adds samples. Takes a copy of buffer, so that buffer can be reused if necessary - - - - - Reads from this WaveProvider - Will always return count bytes, since we will zero-fill the buffer if not enough available - - - - - Discards all audio from the buffer - - - - - Provide WaveProvider that can apply effects in real time using DMO. - - If the audio thread is running on the STA thread, please generate and operate from the same thread. - If the audio thread is running on the MTA thread, please operate on any MTA thread. - - Types of DMO effectors to use - Parameters of the effect to be used - - - - Create a new DmoEffectWaveProvider - - Input Stream - - - - Stream Wave Format - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Get Effector Parameters - - - - - Dispose - - - - - The Media Foundation Resampler Transform - - - - - Creates the Media Foundation Resampler, allowing modifying of sample rate, bit depth and channel count - - Source provider, must be PCM - Output format, must also be PCM - - - - Creates a resampler with a specified target output sample rate - - Source provider - Output sample rate - - - - Creates and configures the actual Resampler transform - - A newly created and configured resampler MFT - - - - Gets or sets the Resampler quality. n.b. set the quality before starting to resample. - 1 is lowest quality (linear interpolation) and 60 is best quality - - - - - Disposes this resampler - - - - - WaveProvider that can mix together multiple 32 bit floating point input provider - All channels must have the same number of inputs and same sample rate - n.b. Work in Progress - not tested yet - - - - - Creates a new MixingWaveProvider32 - - - - - Creates a new 32 bit MixingWaveProvider32 - - inputs - must all have the same format. - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove an input from the mixer - - waveProvider to remove - - - - The number of inputs to this mixer - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Converts from mono to stereo, allowing freedom to route all, some, or none of the incoming signal to left or right channels - - - - - Creates a new stereo waveprovider based on a mono input - - Mono 16 bit PCM input - - - - 1.0 to copy the mono stream to the left channel without adjusting volume - - - - - 1.0 to copy the mono stream to the right channel without adjusting volume - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels. Number of outputs is equal to total number of channels in inputs - - Input wave providers. Must all be of the same format, but can have any number of channels - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels - - Input wave providers. Must all be of the same format, but can have any number of channels - Desired number of output channels. (-1 means use total number of input channels) - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads data from this WaveProvider - - Buffer to be filled with sample data - Offset to write to within buffer, usually 0 - Number of bytes required - Number of bytes read - - - - The WaveFormat of this WaveProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Silence producing wave provider - Useful for playing silence when doing a WASAPI Loopback Capture - - - - - Creates a new silence producing wave provider - - Desired WaveFormat (should be PCM / IEE float - - - - Read silence from into the buffer - - - - - WaveFormat of this silence producing wave provider - - - - - Takes a stereo 16 bit input and turns it mono, allowing you to select left or right channel only or mix them together - - - - - Creates a new mono waveprovider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Helper class allowing us to modify the volume of a 16 bit stream without converting to IEEE float - - - - - Constructs a new VolumeWaveProvider16 - - Source provider, must be 16 bit PCM - - - - Gets or sets volume. - 1.0 is full scale, 0.0 is silence, anything over 1.0 will amplify but potentially clip - - - - - WaveFormat of this WaveProvider - - - - - Read bytes from this WaveProvider - - Buffer to read into - Offset within buffer to read to - Bytes desired - Bytes read - - - - Converts 16 bit PCM to IEEE float, optionally adjusting volume along the way - - - - - Creates a new Wave16toFloatProvider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts IEEE float to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Creates a new WaveFloatTo16Provider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Buffered WaveProvider taking source data from WaveIn - - - - - Creates a new WaveInProvider - n.b. Should make sure the WaveFormat is set correctly on IWaveIn before calling - - The source of wave data - - - - Reads data from the WaveInProvider - - - - - The WaveFormat - - - - - Base class for creating a 16 bit wave provider - - - - - Initializes a new instance of the WaveProvider16 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider16 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a short array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Base class for creating a 32 bit floating point wave provider - Can also be used as a base class for an ISampleProvider that can - be plugged straight into anything requiring an IWaveProvider - - - - - Initializes a new instance of the WaveProvider32 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider32 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a float array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Utility class to intercept audio from an IWaveProvider and - save it to disk - - - - - Constructs a new WaveRecorder - - The location to write the WAV file to - The Source Wave Provider - - - - Read simply returns what the source returns, but writes to disk along the way - - - - - The WaveFormat - - - - - Closes the WAV file - - - - A read-only stream of AIFF data based on an aiff file - with an associated WaveFormat - originally contributed to NAudio by Giawa - - - - Supports opening a AIF file - The AIF is of similar nastiness to the WAV format. - This supports basic reading of uncompressed PCM AIF files, - with 8, 16, 24 and 32 bit PCM data. - - - - - Creates an Aiff File Reader based on an input stream - - The input stream containing a AIF file including header - - - - Ensures valid AIFF header and then finds data offset. - - The stream, positioned at the start of audio data - The format found - The position of the data chunk - The length of the data chunk - Additional chunks found - - - - Cleans up the resources associated with this AiffFileReader - - - - - - - - - - - - - - - Number of Samples (if possible to calculate) - - - - - Position in the AIFF file - - - - - - Reads bytes from the AIFF File - - - - - - AIFF Chunk - - - - - Chunk Name - - - - - Chunk Length - - - - - Chunk start - - - - - Creates a new AIFF Chunk - - - - - AudioFileReader simplifies opening an audio file in NAudio - Simply pass in the filename, and it will attempt to open the - file and set up a conversion path that turns into PCM IEEE float. - ACM codecs will be used for conversion. - It provides a volume property and implements both WaveStream and - ISampleProvider, making it possibly the only stage in your audio - pipeline necessary for simple playback scenarios - - - - - Initializes a new instance of AudioFileReader - - The file to open - - - - Creates the reader stream, supporting all filetypes in the core NAudio library, - and ensuring we are in PCM format - - File Name - - - - File Name - - - - - WaveFormat of this stream - - - - - Length of this stream (in bytes) - - - - - Position of this stream (in bytes) - - - - - Reads from this wave stream - - Audio buffer - Offset into buffer - Number of bytes required - Number of bytes read - - - - Reads audio from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Gets or Sets the Volume of this AudioFileReader. 1.0f is full volume - - - - - Helper to convert source to dest bytes - - - - - Helper to convert dest to source bytes - - - - - Disposes this AudioFileReader - - True if called from Dispose - - - - Helper stream that lets us read from compressed audio files with large block alignment - as though we could read any amount and reposition anywhere - - - - - Creates a new BlockAlignReductionStream - - the input stream - - - - Block alignment of this stream - - - - - Wave Format - - - - - Length of this Stream - - - - - Current position within stream - - - - - Disposes this WaveStream - - - - - Reads data from this stream - - - - - - - - - Implementation of Com IStream - - - - - Holds information on a cue: a labeled position within a Wave file - - - - - Cue position in samples - - - - - Label of the cue - - - - - Creates a Cue based on a sample position and label - - - - - - - Holds a list of cues - - - The specs for reading and writing cues from the cue and list RIFF chunks - are from http://www.sonicspot.com/guide/wavefiles.html and http://www.wotsit.org/ - ------------------------------ - The cues are stored like this: - ------------------------------ - struct CuePoint - { - Int32 dwIdentifier; - Int32 dwPosition; - Int32 fccChunk; - Int32 dwChunkStart; - Int32 dwBlockStart; - Int32 dwSampleOffset; - } - - struct CueChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwCuePoints; - CuePoint[] points; - } - ------------------------------ - Labels look like this: - ------------------------------ - struct ListHeader - { - Int32 listID; /* 'list' */ - Int32 chunkSize; /* includes the Type ID below */ - Int32 typeID; /* 'adtl' */ - } - - struct LabelChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwIdentifier; - Char[] dwText; /* Encoded with extended ASCII */ - } LabelChunk; - - - - - Creates an empty cue list - - - - - Adds an item to the list - - Cue - - - - Gets sample positions for the embedded cues - - Array containing the cue positions - - - - Gets labels for the embedded cues - - Array containing the labels - - - - Creates a cue list from the cue RIFF chunk and the list RIFF chunk - - The data contained in the cue chunk - The data contained in the list chunk - - - - Gets the cues as the concatenated cue and list RIFF chunks. - - RIFF chunks containing the cue data - - - - Number of cues - - - - - Accesses the cue at the specified index - - - - - - - Checks if the cue and list chunks exist and if so, creates a cue list - - - - - A wave file reader supporting cue reading - - - - - Loads a wavefile and supports reading cues - - - - - - Loads a wave from a stream and supports reading cues - - - - - - Cue List (can be null if cues not present) - - - - - An interface for WaveStreams which can report notification of individual samples - - - - - A sample has been detected - - - - - Sample event arguments - - - - - Left sample - - - - - Right sample - - - - - Constructor - - - - - Class for reading any file that Media Foundation can play - Will only work in Windows Vista and above - Automatically converts to PCM - If it is a video file with multiple audio streams, it will pick out the first audio stream - - - - - Allows customisation of this reader class - - - - - Sets up the default settings for MediaFoundationReader - - - - - Allows us to request IEEE float output (n.b. no guarantee this will be accepted) - - - - - If true, the reader object created in the constructor is used in Read - Should only be set to true if you are working entirely on an STA thread, or - entirely with MTA threads. - - - - - If true, the reposition does not happen immediately, but waits until the - next call to read to be processed. - - - - - Default constructor - - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename (can also be a URL e.g. http:// mms:// file://) - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename - Advanced settings - - - - Initializes - - - - - Creates the reader (overridable by ) - - - - - Reads from this wave stream - - Buffer to read into - Offset in buffer - Bytes required - Number of bytes read; 0 indicates end of stream - - - - WaveFormat of this stream (n.b. this is after converting to PCM) - - - - - The bytesRequired of this stream in bytes (n.b may not be accurate) - - - - - Current position within this stream - - - - - Cleans up after finishing with this reader - - true if called from Dispose - - - - WaveFormat has changed - - - - - Class for reading from MP3 files - - - - - The MP3 wave format (n.b. NOT the output format of this stream - see the WaveFormat property) - - - - Supports opening a MP3 file - - - Supports opening a MP3 file - MP3 File name - Factory method to build a frame decompressor - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - Factory method to build a frame decompressor - - - - Function that can create an MP3 Frame decompressor - - A WaveFormat object describing the MP3 file format - An MP3 Frame decompressor - - - - Creates an ACM MP3 Frame decompressor. This is the default with NAudio - - A WaveFormat object based - - - - - Gets the total length of this file in milliseconds. - - - - - ID3v2 tag if present - - - - - ID3v1 tag if present - - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - This is the length in bytes of data available to be read out from the Read method - (i.e. the decompressed MP3 length) - n.b. this may return 0 for files whose length is unknown - - - - - - - - - - - - - - - Reads decompressed PCM data from our MP3 file. - - - - - Xing header if present - - - - - Disposes this WaveStream - - - - - WaveStream that simply passes on data from its source stream - (e.g. a MemoryStream) - - - - - Initialises a new instance of RawSourceWaveStream - - The source stream containing raw audio - The waveformat of the audio in the source stream - - - - Initialises a new instance of RawSourceWaveStream - - The buffer containing raw audio - Offset in the source buffer to read from - Number of bytes to read in the buffer - The waveformat of the audio in the source stream - - - - The WaveFormat of this stream - - - - - The length in bytes of this stream (if supported) - - - - - The current position in this stream - - - - - Reads data from the stream - - - - - Wave Stream for converting between sample rates - - - - - WaveStream to resample using the DMO Resampler - - Input Stream - Desired Output Format - - - - Stream Wave Format - - - - - Stream length in bytes - - - - - Stream position in bytes - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Dispose - - True if disposing (not from finalizer) - - - - Holds information about a RIFF file chunk - - - - - Creates a RiffChunk object - - - - - The chunk identifier - - - - - The chunk identifier converted to a string - - - - - The chunk length - - - - - The stream position this chunk is located at - - - - - A simple compressor - - - - - Create a new simple compressor stream - - Source stream - - - - Make-up Gain - - - - - Threshold - - - - - Ratio - - - - - Attack time - - - - - Release time - - - - - Turns gain on or off - - - - - Gets the WaveFormat of this stream - - - - - Reads bytes from this stream - - Buffer to read into - Offset in array to read into - Number of bytes to read - Number of bytes read - - - - MediaFoundationReader supporting reading from a stream - - - - - Constructs a new media foundation reader from a stream - - - - - Creates the reader - - - - - WaveStream that converts 32 bit audio back down to 16 bit, clipping if necessary - - - - - The method reuses the same buffer to prevent - unnecessary allocations. - - - - - Creates a new Wave32To16Stream - - the source stream - - - - Sets the volume for this stream. 1.0f is full scale - - - - - - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - Destination buffer - Offset into destination buffer - - Number of bytes read. - - - - Conversion to 16 bit and clipping - - - - - - - - - - Clip indicator. Can be reset. - - - - - Disposes this WaveStream - - - - - Represents Channel for the WaveMixerStream - 32 bit output and 16 bit input - It's output is always stereo - The input stream can be panned - - - - - Creates a new WaveChannel32 - - the source stream - stream volume (1 is 0dB) - pan control (-1 to 1) - - - - Creates a WaveChannel32 with default settings - - The source stream - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - If true, Read always returns the number of bytes requested - - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Pan of this channel (from -1 to 1) - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - Sample - - - - - Raise the sample event (no check for null because it has already been done) - - - - This class supports the reading of WAV files, - providing a repositionable WaveStream that returns the raw data - contained in the WAV file - - - - Supports opening a WAV file - The WAV file format is a real mess, but we will only - support the basic WAV file format which actually covers the vast - majority of WAV files out there. For more WAV file format information - visit www.wotsit.org. If you have a WAV file that can't be read by - this class, email it to the NAudio project and we will probably - fix this reader to support it - - - - - Creates a Wave File Reader based on an input stream - - The input stream containing a WAV file including header - - - - Gets a list of the additional chunks found in this file - - - - - Gets the data for the specified chunk - - - - - Cleans up the resources associated with this WaveFileReader - - - - - - - - - - This is the length of audio data contained in this WAV file, in bytes - (i.e. the byte length of the data chunk, not the length of the WAV file itself) - - - - - - Number of Sample Frames (if possible to calculate) - This currently does not take into account number of channels - Multiply number of channels if you want the total number of samples - - - - - Position in the WAV data chunk. - - - - - - Reads bytes from the Wave File - - - - - - Attempts to read the next sample or group of samples as floating point normalised into the range -1.0f to 1.0f - - An array of samples, 1 for mono, 2 for stereo etc. Null indicates end of file reached - - - - - Attempts to read a sample into a float. n.b. only applicable for uncompressed formats - Will normalise the value read into the range -1.0f to 1.0f if it comes from a PCM encoding - - False if the end of the WAV data chunk was reached - - - - IWaveProvider that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source Provider - - - - Gets the WaveFormat of this stream - - - - - Indicates that a reposition has taken place, and internal buffers should be reset - - - - - Reads bytes from this stream - - Buffer to read into - Offset in buffer to read into - Number of bytes to read - Number of bytes read - - - - Disposes this stream - - true if the user called this - - - - Disposes this resource - - - - - Finalizer - - - - - WaveStream that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source stream - - - - Creates a stream that can convert to PCM - - The source stream - A PCM stream - - - - Gets or sets the current position in the stream - - - - - Converts source bytes to destination bytes - - - - - Converts destination bytes to source bytes - - - - - Returns the stream length - - - - - Gets the WaveFormat of this stream - - - - - - - Buffer to read into - Offset within buffer to write to - Number of bytes to read - Bytes read - - - - Disposes this stream - - true if the user called this - - - - A buffer of Wave samples - - - - - creates a new wavebuffer - - WaveIn device to write to - Buffer size in bytes - - - - Place this buffer back to record more audio - - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - - Provides access to the actual record buffer (for reading only) - - - - - Indicates whether the Done flag is set on this buffer - - - - - Indicates whether the InQueue flag is set on this buffer - - - - - Number of bytes recorded - - - - - The buffer size in bytes - - - - - WaveStream that can mix together multiple 32 bit input streams - (Normally used with stereo input channels) - All channels must have the same number of inputs - - - - - Creates a new 32 bit WaveMixerStream - - - - - Creates a new 32 bit WaveMixerStream - - An Array of WaveStreams - must all have the same format. - Use WaveChannel is designed for this purpose. - Automatically stop when all inputs have been read - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove a WaveStream from the mixer - - waveStream to remove - - - - The number of inputs to this mixer - - - - - Automatically stop when all inputs have been read - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Length of this Wave Stream (in bytes) - - - - - - Position within this Wave Stream (in bytes) - - - - - - - - - - - Disposes this WaveStream - - - - - Simply shifts the input stream in time, optionally - clipping its start and end. - (n.b. may include looping in the future) - - - - - Creates a new WaveOffsetStream - - the source stream - the time at which we should start reading from the source stream - amount to trim off the front of the source stream - length of time to play from source stream - - - - Creates a WaveOffsetStream with default settings (no offset or pre-delay, - and whole length of source stream) - - The source stream - - - - The length of time before which no audio will be played - - - - - An offset into the source stream from which to start playing - - - - - Length of time to read from the source stream - - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - A buffer of Wave samples for streaming to a Wave Output device - - - - - creates a new wavebuffer - - WaveOut device to write to - Buffer size in bytes - Stream to provide more data - Lock to protect WaveOut API's from being called on >1 thread - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - this is called by the WAVE callback and should be used to refill the buffer - - - - Whether the header's in queue flag is set - - - - - The buffer size in bytes - - - - - Base class for all WaveStream classes. Derives from stream. - - - - - Retrieves the WaveFormat for this stream - - - - - We can read from this stream - - - - - We can seek within this stream - - - - - We can't write to this stream - - - - - Flush does not need to do anything - See - - - - - An alternative way of repositioning. - See - - - - - Sets the length of the WaveStream. Not Supported. - - - - - - Writes to the WaveStream. Not Supported. - - - - - The block alignment for this wavestream. Do not modify the Position - to anything that is not a whole multiple of this value - - - - - Moves forward or backwards the specified number of seconds in the stream - - Number of seconds to move, can be negative - - - - The current position in the stream in Time format - - - - - Total length in real-time of the stream (may be an estimate for compressed files) - - - - - Whether the WaveStream has non-zero sample data at the current position for the - specified count - - Number of bytes to read - - - - MP3 Frame decompressor using the Windows Media MP3 Decoder DMO object - - - - - Initializes a new instance of the DMO MP3 Frame decompressor - - - - - - Converted PCM WaveFormat - - - - - Decompress a single frame of MP3 - - - - - Alerts us that a reposition has occured so the MP3 decoder needs to reset its state - - - - - Dispose of this obejct and clean up resources - - - - - http://tech.ebu.ch/docs/tech/tech3306-2009.pdf - - - - - WaveFormat - - - - - Data Chunk Position - - - - - Data Chunk Length - - - - - Riff Chunks - - - - - Soundfont generator - - - - - Gets the generator type - - - - - Generator amount as an unsigned short - - - - - Generator amount as a signed short - - - - - Low byte amount - - - - - High byte amount - - - - - Instrument - - - - - Sample Header - - - - - - - - - - Generator types - - - - Start address offset - - - End address offset - - - Start loop address offset - - - End loop address offset - - - Start address coarse offset - - - Modulation LFO to pitch - - - Vibrato LFO to pitch - - - Modulation envelope to pitch - - - Initial filter cutoff frequency - - - Initial filter Q - - - Modulation LFO to filter Cutoff frequency - - - Modulation envelope to filter cutoff frequency - - - End address coarse offset - - - Modulation LFO to volume - - - Unused - - - Chorus effects send - - - Reverb effects send - - - Pan - - - Unused - - - Unused - - - Unused - - - Delay modulation LFO - - - Frequency modulation LFO - - - Delay vibrato LFO - - - Frequency vibrato LFO - - - Delay modulation envelope - - - Attack modulation envelope - - - Hold modulation envelope - - - Decay modulation envelope - - - Sustain modulation envelop - - - Release modulation envelope - - - Key number to modulation envelope hold - - - Key number to modulation envelope decay - - - Delay volume envelope - - - Attack volume envelope - - - Hold volume envelope - - - Decay volume envelope - - - Sustain volume envelope - - - Release volume envelope - - - Key number to volume envelope hold - - - Key number to volume envelope decay - - - Instrument - - - Reserved - - - Key range - - - Velocity range - - - Start loop address coarse offset - - - Key number - - - Velocity - - - Initial attenuation - - - Reserved - - - End loop address coarse offset - - - Coarse tune - - - Fine tune - - - Sample ID - - - Sample modes - - - Reserved - - - Scale tuning - - - Exclusive class - - - Overriding root key - - - Unused - - - Unused - - - - A soundfont info chunk - - - - - SoundFont Version - - - - - WaveTable sound engine - - - - - Bank name - - - - - Data ROM - - - - - Creation Date - - - - - Author - - - - - Target Product - - - - - Copyright - - - - - Comments - - - - - Tools - - - - - ROM Version - - - - - - - - - - SoundFont instrument - - - - - instrument name - - - - - Zones - - - - - - - - - - Instrument Builder - - - - - Transform Types - - - - - Linear - - - - - Modulator - - - - - Source Modulation data type - - - - - Destination generator type - - - - - Amount - - - - - Source Modulation Amount Type - - - - - Source Transform Type - - - - - - - - - - Controller Sources - - - - - No Controller - - - - - Note On Velocity - - - - - Note On Key Number - - - - - Poly Pressure - - - - - Channel Pressure - - - - - Pitch Wheel - - - - - Pitch Wheel Sensitivity - - - - - Source Types - - - - - Linear - - - - - Concave - - - - - Convex - - - - - Switch - - - - - Modulator Type - - - - - - - - - - - A SoundFont Preset - - - - - Preset name - - - - - Patch Number - - - - - Bank number - 0 - 127, GM percussion bank is 128 - - - - - Zones - - - - - - - - - - Class to read the SoundFont file presets chunk - - - - - The Presets contained in this chunk - - - - - The instruments contained in this chunk - - - - - The sample headers contained in this chunk - - - - - - - - - - just reads a chunk ID at the current position - - chunk ID - - - - reads a chunk at the current position - - - - - creates a new riffchunk from current position checking that we're not - at the end of this chunk first - - the new chunk - - - - useful for chunks that just contain a string - - chunk as string - - - - A SoundFont Sample Header - - - - - The sample name - - - - - Start offset - - - - - End offset - - - - - Start loop point - - - - - End loop point - - - - - Sample Rate - - - - - Original pitch - - - - - Pitch correction - - - - - Sample Link - - - - - SoundFont Sample Link Type - - - - - - - - - - SoundFont sample modes - - - - - No loop - - - - - Loop Continuously - - - - - Reserved no loop - - - - - Loop and continue - - - - - Sample Link Type - - - - - Mono Sample - - - - - Right Sample - - - - - Left Sample - - - - - Linked Sample - - - - - ROM Mono Sample - - - - - ROM Right Sample - - - - - ROM Left Sample - - - - - ROM Linked Sample - - - - - SoundFont Version Structure - - - - - Major Version - - - - - Minor Version - - - - - Builds a SoundFont version - - - - - Reads a SoundFont Version structure - - - - - Writes a SoundFont Version structure - - - - - Gets the length of this structure - - - - - Represents a SoundFont - - - - - Loads a SoundFont from a file - - Filename of the SoundFont - - - - Loads a SoundFont from a stream - - stream - - - - The File Info Chunk - - - - - The Presets - - - - - The Instruments - - - - - The Sample Headers - - - - - The Sample Data - - - - - - - - - - base class for structures that can read themselves - - - - - A SoundFont zone - - - - - - - - - - Modulators for this Zone - - - - - Generators for this Zone - - - - - Summary description for Fader. - - - - - Required designer variable. - - - - - Creates a new Fader control - - - - - Clean up any resources being used. - - - - - - - - - - - - - - - - - - - - - - - - - Minimum value of this fader - - - - - Maximum value of this fader - - - - - Current value of this fader - - - - - Fader orientation - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Pan slider control - - - - - Required designer variable. - - - - - True when pan value changed - - - - - Creates a new PanSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - - The current Pan setting - - - - - Control that represents a potentiometer - TODO list: - Optional Log scale - Optional reverse scale - Keyboard control - Optional bitmap mode - Optional complete draw mode - Tooltip support - - - - - Value changed event - - - - - Creates a new pot control - - - - - Minimum Value of the Pot - - - - - Maximum Value of the Pot - - - - - The current value of the pot - - - - - Draws the control - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Handles the mouse up event to allow changing value by dragging - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Implements a rudimentary volume meter - - - - - Basic volume meter - - - - - On Fore Color Changed - - - - - Current Value - - - - - Minimum decibels - - - - - Maximum decibels - - - - - Meter orientation - - - - - Paints the volume meter - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - VolumeSlider control - - - - - Required designer variable. - - - - - Volume changed event - - - - - Creates a new VolumeSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - The volume for this control - - - - - Windows Forms control for painting audio waveforms - - - - - Constructs a new instance of the WaveFormPainter class - - - - - On Resize - - - - - On ForeColor Changed - - - - - - Add Max Value - - - - - - On Paint - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Control for viewing waveforms - - - - - Required designer variable. - - - - - Creates a new WaveViewer control - - - - - sets the associated wavestream - - - - - The zoom level, in samples per pixel - - - - - Start position (currently in bytes) - - - - - Clean up any resources being used. - - - - - - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Audio Subtype GUIDs - http://msdn.microsoft.com/en-us/library/windows/desktop/aa372553%28v=vs.85%29.aspx - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - μ-law coding - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Adaptive delta pulse code modulation (ADPCM) - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Dolby Digital Plus formatted for HDMI output. - http://msdn.microsoft.com/en-us/library/windows/hardware/ff538392(v=vs.85).aspx - Reference : internet - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - IMFActivate, defined in mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Creates the object associated with this activation object. - - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - - - Provides a generic way to store key/value pairs on an object. - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms704598%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - IMFByteStream - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms698720%28v=vs.85%29.aspx - - - - - Retrieves the characteristics of the byte stream. - virtual HRESULT STDMETHODCALLTYPE GetCapabilities(/*[out]*/ __RPC__out DWORD *pdwCapabilities) = 0; - - - - - Retrieves the length of the stream. - virtual HRESULT STDMETHODCALLTYPE GetLength(/*[out]*/ __RPC__out QWORD *pqwLength) = 0; - - - - - Sets the length of the stream. - virtual HRESULT STDMETHODCALLTYPE SetLength(/*[in]*/ QWORD qwLength) = 0; - - - - - Retrieves the current read or write position in the stream. - virtual HRESULT STDMETHODCALLTYPE GetCurrentPosition(/*[out]*/ __RPC__out QWORD *pqwPosition) = 0; - - - - - Sets the current read or write position. - virtual HRESULT STDMETHODCALLTYPE SetCurrentPosition(/*[in]*/ QWORD qwPosition) = 0; - - - - - Queries whether the current position has reached the end of the stream. - virtual HRESULT STDMETHODCALLTYPE IsEndOfStream(/*[out]*/ __RPC__out BOOL *pfEndOfStream) = 0; - - - - - Reads data from the stream. - virtual HRESULT STDMETHODCALLTYPE Read(/*[size_is][out]*/ __RPC__out_ecount_full(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbRead) = 0; - - - - - Begins an asynchronous read operation from the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginRead(/*[out]*/ _Out_writes_bytes_(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous read operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndRead(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbRead) = 0; - - - - - Writes data to the stream. - virtual HRESULT STDMETHODCALLTYPE Write(/*[size_is][in]*/ __RPC__in_ecount_full(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbWritten) = 0; - - - - - Begins an asynchronous write operation to the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginWrite(/*[in]*/ _In_reads_bytes_(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous write operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndWrite(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbWritten) = 0; - - - - - Moves the current position in the stream by a specified offset. - virtual HRESULT STDMETHODCALLTYPE Seek(/*[in]*/ MFBYTESTREAM_SEEK_ORIGIN SeekOrigin, /*[in]*/ LONGLONG llSeekOffset, /*[in]*/ DWORD dwSeekFlags, /*[out]*/ __RPC__out QWORD *pqwCurrentPosition) = 0; - - - - - Clears any internal buffers used by the stream. - virtual HRESULT STDMETHODCALLTYPE Flush( void) = 0; - - - - - Closes the stream and releases any resources associated with the stream. - virtual HRESULT STDMETHODCALLTYPE Close( void) = 0; - - - - - Represents a generic collection of IUnknown pointers. - - - - - Retrieves the number of objects in the collection. - - - - - Retrieves an object in the collection. - - - - - Adds an object to the collection. - - - - - Removes an object from the collection. - - - - - Removes an object from the collection. - - - - - Removes all items from the collection. - - - - - IMFMediaBuffer - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms696261%28v=vs.85%29.aspx - - - - - Gives the caller access to the memory in the buffer. - - - - - Unlocks a buffer that was previously locked. - - - - - Retrieves the length of the valid data in the buffer. - - - - - Sets the length of the valid data in the buffer. - - - - - Retrieves the allocated size of the buffer. - - - - - IMFMediaEvent - Represents an event generated by a Media Foundation object. Use this interface to get information about the event. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms702249%28v=vs.85%29.aspx - Mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the event type. - - - virtual HRESULT STDMETHODCALLTYPE GetType( - /* [out] */ __RPC__out MediaEventType *pmet) = 0; - - - - - Retrieves the extended type of the event. - - - virtual HRESULT STDMETHODCALLTYPE GetExtendedType( - /* [out] */ __RPC__out GUID *pguidExtendedType) = 0; - - - - - Retrieves an HRESULT that specifies the event status. - - - virtual HRESULT STDMETHODCALLTYPE GetStatus( - /* [out] */ __RPC__out HRESULT *phrStatus) = 0; - - - - - Retrieves the value associated with the event, if any. - - - virtual HRESULT STDMETHODCALLTYPE GetValue( - /* [out] */ __RPC__out PROPVARIANT *pvValue) = 0; - - - - - Represents a description of a media format. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms704850%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the major type of the format. - - - - - Queries whether the media type is a compressed format. - - - - - Compares two media types and determines whether they are identical. - - - - - Retrieves an alternative representation of the media type. - - - - - Frees memory that was allocated by the GetRepresentation method. - - - - - Creates an instance of either the sink writer or the source reader. - - - - - Creates an instance of the sink writer or source reader, given a URL. - - - - - Creates an instance of the sink writer or source reader, given an IUnknown pointer. - - - - - CLSID_MFReadWriteClassFactory - - - - - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms702192%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves flags associated with the sample. - - - - - Sets flags associated with the sample. - - - - - Retrieves the presentation time of the sample. - - - - - Sets the presentation time of the sample. - - - - - Retrieves the duration of the sample. - - - - - Sets the duration of the sample. - - - - - Retrieves the number of buffers in the sample. - - - - - Retrieves a buffer from the sample. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - - - - Adds a buffer to the end of the list of buffers in the sample. - - - - - Removes a buffer at a specified index from the sample. - - - - - Removes all buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. - - - - - Copies the sample data to a buffer. - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Adds a stream to the sink writer. - - - - - Sets the input format for a stream on the sink writer. - - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - - - Indicates a gap in an input stream. - - - - - Places a marker in the specified stream. - - - - - Notifies the media sink that a stream has reached the end of a segment. - - - - - Flushes one or more streams. - - - - - (Finalize) Completes all writing operations on the sink writer. - - - - - Queries the underlying media sink or encoder for an interface. - - - - - Gets statistics about the performance of the sink writer. - - - - - IMFSourceReader interface - http://msdn.microsoft.com/en-us/library/windows/desktop/dd374655%28v=vs.85%29.aspx - - - - - Queries whether a stream is selected. - - - - - Selects or deselects one or more streams. - - - - - Gets a format that is supported natively by the media source. - - - - - Gets the current media type for a stream. - - - - - Sets the media type for a stream. - - - - - Seeks to a new position in the media source. - - - - - Reads the next sample from the media source. - - - - - Flushes one or more streams. - - - - - Queries the underlying media source or decoder for an interface. - - - - - Gets an attribute from the underlying media source. - - - - - Contains flags that indicate the status of the IMFSourceReader::ReadSample method - http://msdn.microsoft.com/en-us/library/windows/desktop/dd375773(v=vs.85).aspx - - - - - No Error - - - - - An error occurred. If you receive this flag, do not make any further calls to IMFSourceReader methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the IMFSourceReader::GetCurrentMediaType method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. - - - - - IMFTransform, defined in mftransform.h - - - - - Retrieves the minimum and maximum number of input and output streams. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamLimits( - /* [out] */ __RPC__out DWORD *pdwInputMinimum, - /* [out] */ __RPC__out DWORD *pdwInputMaximum, - /* [out] */ __RPC__out DWORD *pdwOutputMinimum, - /* [out] */ __RPC__out DWORD *pdwOutputMaximum) = 0; - - - - - Retrieves the current number of input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamCount( - /* [out] */ __RPC__out DWORD *pcInputStreams, - /* [out] */ __RPC__out DWORD *pcOutputStreams) = 0; - - - - - Retrieves the stream identifiers for the input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamIDs( - DWORD dwInputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwInputIDArraySize) DWORD *pdwInputIDs, - DWORD dwOutputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwOutputIDArraySize) DWORD *pdwOutputIDs) = 0; - - - - - Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamInfo( - DWORD dwInputStreamID, - /* [out] */ __RPC__out MFT_INPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamInfo( - DWORD dwOutputStreamID, - /* [out] */ __RPC__out MFT_OUTPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the global attribute store for this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetAttributes( - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an input stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamAttributes( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamAttributes( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Removes an input stream from this MFT. - - - virtual HRESULT STDMETHODCALLTYPE DeleteInputStream( - DWORD dwStreamID) = 0; - - - - - Adds one or more new input streams to this MFT. - - - virtual HRESULT STDMETHODCALLTYPE AddInputStreams( - DWORD cStreams, - /* [in] */ __RPC__in DWORD *adwStreamIDs) = 0; - - - - - Gets an available media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputAvailableType( - DWORD dwInputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Retrieves an available media type for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputAvailableType( - DWORD dwOutputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetInputType( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetOutputType( - DWORD dwOutputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Gets the current media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputCurrentType( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Gets the current media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputCurrentType( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStatus( - DWORD dwInputStreamID, - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Queries whether the Media Foundation transform (MFT) is ready to produce output data. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStatus( - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Sets the range of time stamps the client needs for output. - - - virtual HRESULT STDMETHODCALLTYPE SetOutputBounds( - LONGLONG hnsLowerBound, - LONGLONG hnsUpperBound) = 0; - - - - - Sends an event to an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessEvent( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaEvent *pEvent) = 0; - - - - - Sends a message to the Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessMessage( - MFT_MESSAGE_TYPE eMessage, - ULONG_PTR ulParam) = 0; - - - - - Delivers data to an input stream on this Media Foundation transform (MFT). - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessInput( - DWORD dwInputStreamID, - IMFSample *pSample, - DWORD dwFlags) = 0; - - - - - Generates output from the current input data. - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessOutput( - DWORD dwFlags, - DWORD cOutputBufferCount, - /* [size_is][out][in] */ MFT_OUTPUT_DATA_BUFFER *pOutputSamples, - /* [out] */ DWORD *pdwStatus) = 0; - - - - - See mfobjects.h - - - - - Unknown event type. - - - - - Signals a serious error. - - - - - Custom event type. - - - - - A non-fatal error occurred during streaming. - - - - - Session Unknown - - - - - Raised after the IMFMediaSession::SetTopology method completes asynchronously - - - - - Raised by the Media Session when the IMFMediaSession::ClearTopologies method completes asynchronously. - - - - - Raised when the IMFMediaSession::Start method completes asynchronously. - - - - - Raised when the IMFMediaSession::Pause method completes asynchronously. - - - - - Raised when the IMFMediaSession::Stop method completes asynchronously. - - - - - Raised when the IMFMediaSession::Close method completes asynchronously. - - - - - Raised by the Media Session when it has finished playing the last presentation in the playback queue. - - - - - Raised by the Media Session when the playback rate changes. - - - - - Raised by the Media Session when it completes a scrubbing request. - - - - - Raised by the Media Session when the session capabilities change. - - - - - Raised by the Media Session when the status of a topology changes. - - - - - Raised by the Media Session when a new presentation starts. - - - - - Raised by a media source a new presentation is ready. - - - - - License acquisition is about to begin. - - - - - License acquisition is complete. - - - - - Individualization is about to begin. - - - - - Individualization is complete. - - - - - Signals the progress of a content enabler object. - - - - - A content enabler object's action is complete. - - - - - Raised by a trusted output if an error occurs while enforcing the output policy. - - - - - Contains status information about the enforcement of an output policy. - - - - - A media source started to buffer data. - - - - - A media source stopped buffering data. - - - - - The network source started opening a URL. - - - - - The network source finished opening a URL. - - - - - Raised by a media source at the start of a reconnection attempt. - - - - - Raised by a media source at the end of a reconnection attempt. - - - - - Raised by the enhanced video renderer (EVR) when it receives a user event from the presenter. - - - - - Raised by the Media Session when the format changes on a media sink. - - - - - Source Unknown - - - - - Raised when a media source starts without seeking. - - - - - Raised by a media stream when the source starts without seeking. - - - - - Raised when a media source seeks to a new position. - - - - - Raised by a media stream after a call to IMFMediaSource::Start causes a seek in the stream. - - - - - Raised by a media source when it starts a new stream. - - - - - Raised by a media source when it restarts or seeks a stream that is already active. - - - - - Raised by a media source when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media source when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media source when a presentation ends. - - - - - Raised by a media stream when the stream ends. - - - - - Raised when a media stream delivers a new sample. - - - - - Signals that a media stream does not have data available at a specified time. - - - - - Raised by a media stream when it starts or stops thinning the stream. - - - - - Raised by a media stream when the media type of the stream changes. - - - - - Raised by a media source when the playback rate changes. - - - - - Raised by the sequencer source when a segment is completed and is followed by another segment. - - - - - Raised by a media source when the source's characteristics change. - - - - - Raised by a media source to request a new playback rate. - - - - - Raised by a media source when it updates its metadata. - - - - - Raised by the sequencer source when the IMFSequencerSource::UpdateTopology method completes asynchronously. - - - - - Sink Unknown - - - - - Raised by a stream sink when it completes the transition to the running state. - - - - - Raised by a stream sink when it completes the transition to the stopped state. - - - - - Raised by a stream sink when it completes the transition to the paused state. - - - - - Raised by a stream sink when the rate has changed. - - - - - Raised by a stream sink to request a new media sample from the pipeline. - - - - - Raised by a stream sink after the IMFStreamSink::PlaceMarker method is called. - - - - - Raised by a stream sink when the stream has received enough preroll data to begin rendering. - - - - - Raised by a stream sink when it completes a scrubbing request. - - - - - Raised by a stream sink when the sink's media type is no longer valid. - - - - - Raised by the stream sinks of the EVR if the video device changes. - - - - - Provides feedback about playback quality to the quality manager. - - - - - Raised when a media sink becomes invalid. - - - - - The audio session display name changed. - - - - - The volume or mute state of the audio session changed - - - - - The audio device was removed. - - - - - The Windows audio server system was shut down. - - - - - The grouping parameters changed for the audio session. - - - - - The audio session icon changed. - - - - - The default audio format for the audio device changed. - - - - - The audio session was disconnected from a Windows Terminal Services session - - - - - The audio session was preempted by an exclusive-mode connection. - - - - - Trust Unknown - - - - - The output policy for a stream changed. - - - - - Content protection message - - - - - The IMFOutputTrustAuthority::SetPolicy method completed. - - - - - DRM License Backup Completed - - - - - DRM License Backup Progress - - - - - DRM License Restore Completed - - - - - DRM License Restore Progress - - - - - DRM License Acquisition Completed - - - - - DRM Individualization Completed - - - - - DRM Individualization Progress - - - - - DRM Proximity Completed - - - - - DRM License Store Cleaned - - - - - DRM Revocation Download Completed - - - - - Transform Unknown - - - - - Sent by an asynchronous MFT to request a new input sample. - - - - - Sent by an asynchronous MFT when new output data is available from the MFT. - - - - - Sent by an asynchronous Media Foundation transform (MFT) when a drain operation is complete. - - - - - Sent by an asynchronous MFT in response to an MFT_MESSAGE_COMMAND_MARKER message. - - - - - Media Foundation attribute guids - http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - Specifies whether an MFT performs asynchronous processing. - - - - - Enables the use of an asynchronous MFT. - - - - - Contains flags for an MFT activation object. - - - - - Specifies the category for an MFT. - - - - - Contains the class identifier (CLSID) of an MFT. - - - - - Contains the registered input types for a Media Foundation transform (MFT). - - - - - Contains the registered output types for a Media Foundation transform (MFT). - - - - - Contains the symbolic link for a hardware-based MFT. - - - - - Contains the display name for a hardware-based MFT. - - - - - Contains a pointer to the stream attributes of the connected stream on a hardware-based MFT. - - - - - Specifies whether a hardware-based MFT is connected to another hardware-based MFT. - - - - - Specifies the preferred output format for an encoder. - - - - - Specifies whether an MFT is registered only in the application's process. - - - - - Contains configuration properties for an encoder. - - - - - Specifies whether a hardware device source uses the system time for time stamps. - - - - - Contains an IMFFieldOfUseMFTUnlock pointer, which can be used to unlock the MFT. - - - - - Contains the merit value of a hardware codec. - - - - - Specifies whether a decoder is optimized for transcoding rather than for playback. - - - - - Contains a pointer to the proxy object for the application's presentation descriptor. - - - - - Contains a pointer to the presentation descriptor from the protected media path (PMP). - - - - - Specifies the duration of a presentation, in 100-nanosecond units. - - - - - Specifies the total size of the source file, in bytes. - - - - - Specifies the audio encoding bit rate for the presentation, in bits per second. - - - - - Specifies the video encoding bit rate for the presentation, in bits per second. - - - - - Specifies the MIME type of the content. - - - - - Specifies when a presentation was last modified. - - - - - The identifier of the playlist element in the presentation. - - - - - Contains the preferred RFC 1766 language of the media source. - - - - - The time at which the presentation must begin, relative to the start of the media source. - - - - - Specifies whether the audio streams in the presentation have a variable bit rate. - - - - - Media type Major Type - - - - - Media Type subtype - - - - - Audio block alignment - - - - - Audio average bytes per second - - - - - Audio number of channels - - - - - Audio samples per second - - - - - Audio bits per sample - - - - - Enables the source reader or sink writer to use hardware-based Media Foundation transforms (MFTs). - - - - - Contains additional format data for a media type. - - - - - Specifies for a media type whether each sample is independent of the other samples in the stream. - - - - - Specifies for a media type whether the samples have a fixed size. - - - - - Contains a DirectShow format GUID for a media type. - - - - - Specifies the preferred legacy format structure to use when converting an audio media type. - - - - - Specifies for a media type whether the media data is compressed. - - - - - Approximate data rate of the video stream, in bits per second, for a video media type. - - - - - Specifies the payload type of an Advanced Audio Coding (AAC) stream. - 0 - The stream contains raw_data_block elements only - 1 - Audio Data Transport Stream (ADTS). The stream contains an adts_sequence, as defined by MPEG-2. - 2 - Audio Data Interchange Format (ADIF). The stream contains an adif_sequence, as defined by MPEG-2. - 3 - The stream contains an MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream, as defined by ISO/IEC 14496-3. - - - - - Media Foundation Errors - - - - RANGES - 14000 - 14999 = General Media Foundation errors - 15000 - 15999 = ASF parsing errors - 16000 - 16999 = Media Source errors - 17000 - 17999 = MEDIAFOUNDATION Network Error Events - 18000 - 18999 = MEDIAFOUNDATION WMContainer Error Events - 19000 - 19999 = MEDIAFOUNDATION Media Sink Error Events - 20000 - 20999 = Renderer errors - 21000 - 21999 = Topology Errors - 25000 - 25999 = Timeline Errors - 26000 - 26999 = Unused - 28000 - 28999 = Transform errors - 29000 - 29999 = Content Protection errors - 40000 - 40999 = Clock errors - 41000 - 41999 = MF Quality Management Errors - 42000 - 42999 = MF Transcode API Errors - - - - - MessageId: MF_E_PLATFORM_NOT_INITIALIZED - - MessageText: - - Platform not initialized. Please call MFStartup().%0 - - - - - MessageId: MF_E_BUFFERTOOSMALL - - MessageText: - - The buffer was too small to carry out the requested action.%0 - - - - - MessageId: MF_E_INVALIDREQUEST - - MessageText: - - The request is invalid in the current state.%0 - - - - - MessageId: MF_E_INVALIDSTREAMNUMBER - - MessageText: - - The stream number provided was invalid.%0 - - - - - MessageId: MF_E_INVALIDMEDIATYPE - - MessageText: - - The data specified for the media type is invalid, inconsistent, or not supported by this object.%0 - - - - - MessageId: MF_E_NOTACCEPTING - - MessageText: - - The callee is currently not accepting further input.%0 - - - - - MessageId: MF_E_NOT_INITIALIZED - - MessageText: - - This object needs to be initialized before the requested operation can be carried out.%0 - - - - - MessageId: MF_E_UNSUPPORTED_REPRESENTATION - - MessageText: - - The requested representation is not supported by this object.%0 - - - - - MessageId: MF_E_NO_MORE_TYPES - - MessageText: - - An object ran out of media types to suggest therefore the requested chain of streaming objects cannot be completed.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SERVICE - - MessageText: - - The object does not support the specified service.%0 - - - - - MessageId: MF_E_UNEXPECTED - - MessageText: - - An unexpected error has occurred in the operation requested.%0 - - - - - MessageId: MF_E_INVALIDNAME - - MessageText: - - Invalid name.%0 - - - - - MessageId: MF_E_INVALIDTYPE - - MessageText: - - Invalid type.%0 - - - - - MessageId: MF_E_INVALID_FILE_FORMAT - - MessageText: - - The file does not conform to the relevant file format specification. - - - - - MessageId: MF_E_INVALIDINDEX - - MessageText: - - Invalid index.%0 - - - - - MessageId: MF_E_INVALID_TIMESTAMP - - MessageText: - - An invalid timestamp was given.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SCHEME - - MessageText: - - The scheme of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_BYTESTREAM_TYPE - - MessageText: - - The byte stream type of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_TIME_FORMAT - - MessageText: - - The given time format is unsupported.%0 - - - - - MessageId: MF_E_NO_SAMPLE_TIMESTAMP - - MessageText: - - The Media Sample does not have a timestamp.%0 - - - - - MessageId: MF_E_NO_SAMPLE_DURATION - - MessageText: - - The Media Sample does not have a duration.%0 - - - - - MessageId: MF_E_INVALID_STREAM_DATA - - MessageText: - - The request failed because the data in the stream is corrupt.%0\n. - - - - - MessageId: MF_E_RT_UNAVAILABLE - - MessageText: - - Real time services are not available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE - - MessageText: - - The specified rate is not supported.%0 - - - - - MessageId: MF_E_THINNING_UNSUPPORTED - - MessageText: - - This component does not support stream-thinning.%0 - - - - - MessageId: MF_E_REVERSE_UNSUPPORTED - - MessageText: - - The call failed because no reverse playback rates are available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE_TRANSITION - - MessageText: - - The requested rate transition cannot occur in the current state.%0 - - - - - MessageId: MF_E_RATE_CHANGE_PREEMPTED - - MessageText: - - The requested rate change has been pre-empted and will not occur.%0 - - - - - MessageId: MF_E_NOT_FOUND - - MessageText: - - The specified object or value does not exist.%0 - - - - - MessageId: MF_E_NOT_AVAILABLE - - MessageText: - - The requested value is not available.%0 - - - - - MessageId: MF_E_NO_CLOCK - - MessageText: - - The specified operation requires a clock and no clock is available.%0 - - - - - MessageId: MF_S_MULTIPLE_BEGIN - - MessageText: - - This callback and state had already been passed in to this event generator earlier.%0 - - - - - MessageId: MF_E_MULTIPLE_BEGIN - - MessageText: - - This callback has already been passed in to this event generator.%0 - - - - - MessageId: MF_E_MULTIPLE_SUBSCRIBERS - - MessageText: - - Some component is already listening to events on this event generator.%0 - - - - - MessageId: MF_E_TIMER_ORPHANED - - MessageText: - - This timer was orphaned before its callback time arrived.%0 - - - - - MessageId: MF_E_STATE_TRANSITION_PENDING - - MessageText: - - A state transition is already pending.%0 - - - - - MessageId: MF_E_UNSUPPORTED_STATE_TRANSITION - - MessageText: - - The requested state transition is unsupported.%0 - - - - - MessageId: MF_E_UNRECOVERABLE_ERROR_OCCURRED - - MessageText: - - An unrecoverable error has occurred.%0 - - - - - MessageId: MF_E_SAMPLE_HAS_TOO_MANY_BUFFERS - - MessageText: - - The provided sample has too many buffers.%0 - - - - - MessageId: MF_E_SAMPLE_NOT_WRITABLE - - MessageText: - - The provided sample is not writable.%0 - - - - - MessageId: MF_E_INVALID_KEY - - MessageText: - - The specified key is not valid. - - - - - MessageId: MF_E_BAD_STARTUP_VERSION - - MessageText: - - You are calling MFStartup with the wrong MF_VERSION. Mismatched bits? - - - - - MessageId: MF_E_UNSUPPORTED_CAPTION - - MessageText: - - The caption of the given URL is unsupported.%0 - - - - - MessageId: MF_E_INVALID_POSITION - - MessageText: - - The operation on the current offset is not permitted.%0 - - - - - MessageId: MF_E_ATTRIBUTENOTFOUND - - MessageText: - - The requested attribute was not found.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_ALLOWED - - MessageText: - - The specified property type is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_SUPPORTED - - MessageText: - - The specified property type is not supported.%0 - - - - - MessageId: MF_E_PROPERTY_EMPTY - - MessageText: - - The specified property is empty.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_EMPTY - - MessageText: - - The specified property is not empty.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_NOT_ALLOWED - - MessageText: - - The vector property specified is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_REQUIRED - - MessageText: - - A vector property is required in this context.%0 - - - - - MessageId: MF_E_OPERATION_CANCELLED - - MessageText: - - The operation is cancelled.%0 - - - - - MessageId: MF_E_BYTESTREAM_NOT_SEEKABLE - - MessageText: - - The provided bytestream was expected to be seekable and it is not.%0 - - - - - MessageId: MF_E_DISABLED_IN_SAFEMODE - - MessageText: - - The Media Foundation platform is disabled when the system is running in Safe Mode.%0 - - - - - MessageId: MF_E_CANNOT_PARSE_BYTESTREAM - - MessageText: - - The Media Source could not parse the byte stream.%0 - - - - - MessageId: MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS - - MessageText: - - Mutually exclusive flags have been specified to source resolver. This flag combination is invalid.%0 - - - - - MessageId: MF_E_MEDIAPROC_WRONGSTATE - - MessageText: - - MediaProc is in the wrong state%0 - - - - - MessageId: MF_E_RT_THROUGHPUT_NOT_AVAILABLE - - MessageText: - - Real time I/O service can not provide requested throughput.%0 - - - - - MessageId: MF_E_RT_TOO_MANY_CLASSES - - MessageText: - - The workqueue cannot be registered with more classes.%0 - - - - - MessageId: MF_E_RT_WOULDBLOCK - - MessageText: - - This operation cannot succeed because another thread owns this object.%0 - - - - - MessageId: MF_E_NO_BITPUMP - - MessageText: - - Internal. Bitpump not found.%0 - - - - - MessageId: MF_E_RT_OUTOFMEMORY - - MessageText: - - No more RT memory available.%0 - - - - - MessageId: MF_E_RT_WORKQUEUE_CLASS_NOT_SPECIFIED - - MessageText: - - An MMCSS class has not been set for this work queue.%0 - - - - - MessageId: MF_E_INSUFFICIENT_BUFFER - - MessageText: - - Insufficient memory for response.%0 - - - - - MessageId: MF_E_CANNOT_CREATE_SINK - - MessageText: - - Activate failed to create mediasink. Call OutputNode::GetUINT32(MF_TOPONODE_MAJORTYPE) for more information. %0 - - - - - MessageId: MF_E_BYTESTREAM_UNKNOWN_LENGTH - - MessageText: - - The length of the provided bytestream is unknown.%0 - - - - - MessageId: MF_E_SESSION_PAUSEWHILESTOPPED - - MessageText: - - The media session cannot pause from a stopped state.%0 - - - - - MessageId: MF_S_ACTIVATE_REPLACED - - MessageText: - - The activate could not be created in the remote process for some reason it was replaced with empty one.%0 - - - - - MessageId: MF_E_FORMAT_CHANGE_NOT_SUPPORTED - - MessageText: - - The data specified for the media type is supported, but would require a format change, which is not supported by this object.%0 - - - - - MessageId: MF_E_INVALID_WORKQUEUE - - MessageText: - - The operation failed because an invalid combination of workqueue ID and flags was specified.%0 - - - - - MessageId: MF_E_DRM_UNSUPPORTED - - MessageText: - - No DRM support is available.%0 - - - - - MessageId: MF_E_UNAUTHORIZED - - MessageText: - - This operation is not authorized.%0 - - - - - MessageId: MF_E_OUT_OF_RANGE - - MessageText: - - The value is not in the specified or valid range.%0 - - - - - MessageId: MF_E_INVALID_CODEC_MERIT - - MessageText: - - The registered codec merit is not valid.%0 - - - - - MessageId: MF_E_HW_MFT_FAILED_START_STREAMING - - MessageText: - - Hardware MFT failed to start streaming due to lack of hardware resources.%0 - - - - - MessageId: MF_S_ASF_PARSEINPROGRESS - - MessageText: - - Parsing is still in progress and is not yet complete.%0 - - - - - MessageId: MF_E_ASF_PARSINGINCOMPLETE - - MessageText: - - Not enough data have been parsed to carry out the requested action.%0 - - - - - MessageId: MF_E_ASF_MISSINGDATA - - MessageText: - - There is a gap in the ASF data provided.%0 - - - - - MessageId: MF_E_ASF_INVALIDDATA - - MessageText: - - The data provided are not valid ASF.%0 - - - - - MessageId: MF_E_ASF_OPAQUEPACKET - - MessageText: - - The packet is opaque, so the requested information cannot be returned.%0 - - - - - MessageId: MF_E_ASF_NOINDEX - - MessageText: - - The requested operation failed since there is no appropriate ASF index.%0 - - - - - MessageId: MF_E_ASF_OUTOFRANGE - - MessageText: - - The value supplied is out of range for this operation.%0 - - - - - MessageId: MF_E_ASF_INDEXNOTLOADED - - MessageText: - - The index entry requested needs to be loaded before it can be available.%0 - - - - - MessageId: MF_E_ASF_TOO_MANY_PAYLOADS - - MessageText: - - The packet has reached the maximum number of payloads.%0 - - - - - MessageId: MF_E_ASF_UNSUPPORTED_STREAM_TYPE - - MessageText: - - Stream type is not supported.%0 - - - - - MessageId: MF_E_ASF_DROPPED_PACKET - - MessageText: - - One or more ASF packets were dropped.%0 - - - - - MessageId: MF_E_NO_EVENTS_AVAILABLE - - MessageText: - - There are no events available in the queue.%0 - - - - - MessageId: MF_E_INVALID_STATE_TRANSITION - - MessageText: - - A media source cannot go from the stopped state to the paused state.%0 - - - - - MessageId: MF_E_END_OF_STREAM - - MessageText: - - The media stream cannot process any more samples because there are no more samples in the stream.%0 - - - - - MessageId: MF_E_SHUTDOWN - - MessageText: - - The request is invalid because Shutdown() has been called.%0 - - - - - MessageId: MF_E_MP3_NOTFOUND - - MessageText: - - The MP3 object was not found.%0 - - - - - MessageId: MF_E_MP3_OUTOFDATA - - MessageText: - - The MP3 parser ran out of data before finding the MP3 object.%0 - - - - - MessageId: MF_E_MP3_NOTMP3 - - MessageText: - - The file is not really a MP3 file.%0 - - - - - MessageId: MF_E_MP3_NOTSUPPORTED - - MessageText: - - The MP3 file is not supported.%0 - - - - - MessageId: MF_E_NO_DURATION - - MessageText: - - The Media stream has no duration.%0 - - - - - MessageId: MF_E_INVALID_FORMAT - - MessageText: - - The Media format is recognized but is invalid.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_FOUND - - MessageText: - - The property requested was not found.%0 - - - - - MessageId: MF_E_PROPERTY_READ_ONLY - - MessageText: - - The property is read only.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_ALLOWED - - MessageText: - - The specified property is not allowed in this context.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NOT_STARTED - - MessageText: - - The media source is not started.%0 - - - - - MessageId: MF_E_UNSUPPORTED_FORMAT - - MessageText: - - The Media format is recognized but not supported.%0 - - - - - MessageId: MF_E_MP3_BAD_CRC - - MessageText: - - The MPEG frame has bad CRC.%0 - - - - - MessageId: MF_E_NOT_PROTECTED - - MessageText: - - The file is not protected.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_WRONGSTATE - - MessageText: - - The media source is in the wrong state%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED - - MessageText: - - No streams are selected in source presentation descriptor.%0 - - - - - MessageId: MF_E_CANNOT_FIND_KEYFRAME_SAMPLE - - MessageText: - - No key frame sample was found.%0 - - - - - MessageId: MF_E_NETWORK_RESOURCE_FAILURE - - MessageText: - - An attempt to acquire a network resource failed.%0 - - - - - MessageId: MF_E_NET_WRITE - - MessageText: - - Error writing to the network.%0 - - - - - MessageId: MF_E_NET_READ - - MessageText: - - Error reading from the network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_NETWORK - - MessageText: - - Internal. Entry cannot complete operation without network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_ASYNC - - MessageText: - - Internal. Async op is required.%0 - - - - - MessageId: MF_E_NET_BWLEVEL_NOT_SUPPORTED - - MessageText: - - Internal. Bandwidth levels are not supported.%0 - - - - - MessageId: MF_E_NET_STREAMGROUPS_NOT_SUPPORTED - - MessageText: - - Internal. Stream groups are not supported.%0 - - - - - MessageId: MF_E_NET_MANUALSS_NOT_SUPPORTED - - MessageText: - - Manual stream selection is not supported.%0 - - - - - MessageId: MF_E_NET_INVALID_PRESENTATION_DESCRIPTOR - - MessageText: - - Invalid presentation descriptor.%0 - - - - - MessageId: MF_E_NET_CACHESTREAM_NOT_FOUND - - MessageText: - - Cannot find cache stream.%0 - - - - - MessageId: MF_I_MANUAL_PROXY - - MessageText: - - The proxy setting is manual.%0 - - - - duplicate removed - MessageId=17011 Severity=Informational Facility=MEDIAFOUNDATION SymbolicName=MF_E_INVALID_REQUEST - Language=English - The request is invalid in the current state.%0 - . - - MessageId: MF_E_NET_REQUIRE_INPUT - - MessageText: - - Internal. Entry cannot complete operation without input.%0 - - - - - MessageId: MF_E_NET_REDIRECT - - MessageText: - - The client redirected to another server.%0 - - - - - MessageId: MF_E_NET_REDIRECT_TO_PROXY - - MessageText: - - The client is redirected to a proxy server.%0 - - - - - MessageId: MF_E_NET_TOO_MANY_REDIRECTS - - MessageText: - - The client reached maximum redirection limit.%0 - - - - - MessageId: MF_E_NET_TIMEOUT - - MessageText: - - The server, a computer set up to offer multimedia content to other computers, could not handle your request for multimedia content in a timely manner. Please try again later.%0 - - - - - MessageId: MF_E_NET_CLIENT_CLOSE - - MessageText: - - The control socket is closed by the client.%0 - - - - - MessageId: MF_E_NET_BAD_CONTROL_DATA - - MessageText: - - The server received invalid data from the client on the control connection.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_SERVER - - MessageText: - - The server is not a compatible streaming media server.%0 - - - - - MessageId: MF_E_NET_UNSAFE_URL - - MessageText: - - Url.%0 - - - - - MessageId: MF_E_NET_CACHE_NO_DATA - - MessageText: - - Data is not available.%0 - - - - - MessageId: MF_E_NET_EOL - - MessageText: - - End of line.%0 - - - - - MessageId: MF_E_NET_BAD_REQUEST - - MessageText: - - The request could not be understood by the server.%0 - - - - - MessageId: MF_E_NET_INTERNAL_SERVER_ERROR - - MessageText: - - The server encountered an unexpected condition which prevented it from fulfilling the request.%0 - - - - - MessageId: MF_E_NET_SESSION_NOT_FOUND - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_NET_NOCONNECTION - - MessageText: - - There is no connection established with the Windows Media server. The operation failed.%0 - - - - - MessageId: MF_E_NET_CONNECTION_FAILURE - - MessageText: - - The network connection has failed.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_PUSHSERVER - - MessageText: - - The Server service that received the HTTP push request is not a compatible version of Windows Media Services (WMS). This error may indicate the push request was received by IIS instead of WMS. Ensure WMS is started and has the HTTP Server control protocol properly enabled and try again.%0 - - - - - MessageId: MF_E_NET_SERVER_ACCESSDENIED - - MessageText: - - The Windows Media server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_PROXY_ACCESSDENIED - - MessageText: - - The proxy server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_CANNOTCONNECT - - MessageText: - - Unable to establish a connection to the server.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_TEMPLATE - - MessageText: - - The specified push template is invalid.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_PUBLISHING_POINT - - MessageText: - - The specified push publishing point is invalid.%0 - - - - - MessageId: MF_E_NET_BUSY - - MessageText: - - The requested resource is in use.%0 - - - - - MessageId: MF_E_NET_RESOURCE_GONE - - MessageText: - - The Publishing Point or file on the Windows Media Server is no longer available.%0 - - - - - MessageId: MF_E_NET_ERROR_FROM_PROXY - - MessageText: - - The proxy experienced an error while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_PROXY_TIMEOUT - - MessageText: - - The proxy did not receive a timely response while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_SERVER_UNAVAILABLE - - MessageText: - - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.%0 - - - - - MessageId: MF_E_NET_TOO_MUCH_DATA - - MessageText: - - The encoding process was unable to keep up with the amount of supplied data.%0 - - - - - MessageId: MF_E_NET_SESSION_INVALID - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_OFFLINE_MODE - - MessageText: - - The requested URL is not available in offline mode.%0 - - - - - MessageId: MF_E_NET_UDP_BLOCKED - - MessageText: - - A device in the network is blocking UDP traffic.%0 - - - - - MessageId: MF_E_NET_UNSUPPORTED_CONFIGURATION - - MessageText: - - The specified configuration value is not supported.%0 - - - - - MessageId: MF_E_NET_PROTOCOL_DISABLED - - MessageText: - - The networking protocol is disabled.%0 - - - - - MessageId: MF_E_ALREADY_INITIALIZED - - MessageText: - - This object has already been initialized and cannot be re-initialized at this time.%0 - - - - - MessageId: MF_E_BANDWIDTH_OVERRUN - - MessageText: - - The amount of data passed in exceeds the given bitrate and buffer window.%0 - - - - - MessageId: MF_E_LATE_SAMPLE - - MessageText: - - The sample was passed in too late to be correctly processed.%0 - - - - - MessageId: MF_E_FLUSH_NEEDED - - MessageText: - - The requested action cannot be carried out until the object is flushed and the queue is emptied.%0 - - - - - MessageId: MF_E_INVALID_PROFILE - - MessageText: - - The profile is invalid.%0 - - - - - MessageId: MF_E_INDEX_NOT_COMMITTED - - MessageText: - - The index that is being generated needs to be committed before the requested action can be carried out.%0 - - - - - MessageId: MF_E_NO_INDEX - - MessageText: - - The index that is necessary for the requested action is not found.%0 - - - - - MessageId: MF_E_CANNOT_INDEX_IN_PLACE - - MessageText: - - The requested index cannot be added in-place to the specified ASF content.%0 - - - - - MessageId: MF_E_MISSING_ASF_LEAKYBUCKET - - MessageText: - - The ASF leaky bucket parameters must be specified in order to carry out this request.%0 - - - - - MessageId: MF_E_INVALID_ASF_STREAMID - - MessageText: - - The stream id is invalid. The valid range for ASF stream id is from 1 to 127.%0 - - - - - MessageId: MF_E_STREAMSINK_REMOVED - - MessageText: - - The requested Stream Sink has been removed and cannot be used.%0 - - - - - MessageId: MF_E_STREAMSINKS_OUT_OF_SYNC - - MessageText: - - The various Stream Sinks in this Media Sink are too far out of sync for the requested action to take place.%0 - - - - - MessageId: MF_E_STREAMSINKS_FIXED - - MessageText: - - Stream Sinks cannot be added to or removed from this Media Sink because its set of streams is fixed.%0 - - - - - MessageId: MF_E_STREAMSINK_EXISTS - - MessageText: - - The given Stream Sink already exists.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_CANCELED - - MessageText: - - Sample allocations have been canceled.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_EMPTY - - MessageText: - - The sample allocator is currently empty, due to outstanding requests.%0 - - - - - MessageId: MF_E_SINK_ALREADYSTOPPED - - MessageText: - - When we try to sopt a stream sink, it is already stopped %0 - - - - - MessageId: MF_E_ASF_FILESINK_BITRATE_UNKNOWN - - MessageText: - - The ASF file sink could not reserve AVIO because the bitrate is unknown.%0 - - - - - MessageId: MF_E_SINK_NO_STREAMS - - MessageText: - - No streams are selected in sink presentation descriptor.%0 - - - - - MessageId: MF_S_SINK_NOT_FINALIZED - - MessageText: - - The sink has not been finalized before shut down. This may cause sink generate a corrupted content.%0 - - - - - MessageId: MF_E_METADATA_TOO_LONG - - MessageText: - - A metadata item was too long to write to the output container.%0 - - - - - MessageId: MF_E_SINK_NO_SAMPLES_PROCESSED - - MessageText: - - The operation failed because no samples were processed by the sink.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_PROCAMP_HW - - MessageText: - - There is no available procamp hardware with which to perform color correction.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_DEINTERLACE_HW - - MessageText: - - There is no available deinterlacing hardware with which to deinterlace the video stream.%0 - - - - - MessageId: MF_E_VIDEO_REN_COPYPROT_FAILED - - MessageText: - - A video stream requires copy protection to be enabled, but there was a failure in attempting to enable copy protection.%0 - - - - - MessageId: MF_E_VIDEO_REN_SURFACE_NOT_SHARED - - MessageText: - - A component is attempting to access a surface for sharing that is not shared.%0 - - - - - MessageId: MF_E_VIDEO_DEVICE_LOCKED - - MessageText: - - A component is attempting to access a shared device that is already locked by another component.%0 - - - - - MessageId: MF_E_NEW_VIDEO_DEVICE - - MessageText: - - The device is no longer available. The handle should be closed and a new one opened.%0 - - - - - MessageId: MF_E_NO_VIDEO_SAMPLE_AVAILABLE - - MessageText: - - A video sample is not currently queued on a stream that is required for mixing.%0 - - - - - MessageId: MF_E_NO_AUDIO_PLAYBACK_DEVICE - - MessageText: - - No audio playback device was found.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_IN_USE - - MessageText: - - The requested audio playback device is currently in use.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_INVALIDATED - - MessageText: - - The audio playback device is no longer present.%0 - - - - - MessageId: MF_E_AUDIO_SERVICE_NOT_RUNNING - - MessageText: - - The audio service is not running.%0 - - - - - MessageId: MF_E_TOPO_INVALID_OPTIONAL_NODE - - MessageText: - - The topology contains an invalid optional node. Possible reasons are incorrect number of outputs and inputs or optional node is at the beginning or end of a segment. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_FIND_DECRYPTOR - - MessageText: - - No suitable transform was found to decrypt the content. %0 - - - - - MessageId: MF_E_TOPO_CODEC_NOT_FOUND - - MessageText: - - No suitable transform was found to encode or decode the content. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_CONNECT - - MessageText: - - Unable to find a way to connect nodes%0 - - - - - MessageId: MF_E_TOPO_UNSUPPORTED - - MessageText: - - Unsupported operations in topoloader%0 - - - - - MessageId: MF_E_TOPO_INVALID_TIME_ATTRIBUTES - - MessageText: - - The topology or its nodes contain incorrectly set time attributes%0 - - - - - MessageId: MF_E_TOPO_LOOPS_IN_TOPOLOGY - - MessageText: - - The topology contains loops, which are unsupported in media foundation topologies%0 - - - - - MessageId: MF_E_TOPO_MISSING_PRESENTATION_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_STREAM_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a stream descriptor%0 - - - - - MessageId: MF_E_TOPO_STREAM_DESCRIPTOR_NOT_SELECTED - - MessageText: - - A stream descriptor was set on a source stream node but it was not selected on the presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_SOURCE - - MessageText: - - A source stream node in the topology does not have a source%0 - - - - - MessageId: MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED - - MessageText: - - The topology loader does not support sink activates on output nodes.%0 - - - - - MessageId: MF_E_SEQUENCER_UNKNOWN_SEGMENT_ID - - MessageText: - - The sequencer cannot find a segment with the given ID.%0\n. - - - - - MessageId: MF_S_SEQUENCER_CONTEXT_CANCELED - - MessageText: - - The context was canceled.%0\n. - - - - - MessageId: MF_E_NO_SOURCE_IN_CACHE - - MessageText: - - Cannot find source in source cache.%0\n. - - - - - MessageId: MF_S_SEQUENCER_SEGMENT_AT_END_OF_STREAM - - MessageText: - - Cannot update topology flags.%0\n. - - - - - MessageId: MF_E_TRANSFORM_TYPE_NOT_SET - - MessageText: - - A valid type has not been set for this stream or a stream that it depends on.%0 - - - - - MessageId: MF_E_TRANSFORM_STREAM_CHANGE - - MessageText: - - A stream change has occurred. Output cannot be produced until the streams have been renegotiated.%0 - - - - - MessageId: MF_E_TRANSFORM_INPUT_REMAINING - - MessageText: - - The transform cannot take the requested action until all of the input data it currently holds is processed or flushed.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_MISSING - - MessageText: - - The transform requires a profile but no profile was supplied or found.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_INVALID_OR_CORRUPT - - MessageText: - - The transform requires a profile but the supplied profile was invalid or corrupt.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_TRUNCATED - - MessageText: - - The transform requires a profile but the supplied profile ended unexpectedly while parsing.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_PID_NOT_RECOGNIZED - - MessageText: - - The property ID does not match any property supported by the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VARIANT_TYPE_WRONG - - MessageText: - - The variant does not have the type expected for this property ID.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_NOT_WRITEABLE - - MessageText: - - An attempt was made to set the value on a read-only property.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_ARRAY_VALUE_WRONG_NUM_DIM - - MessageText: - - The array property value has an unexpected number of dimensions.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_SIZE_WRONG - - MessageText: - - The array or blob property value has an unexpected size.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_OUT_OF_RANGE - - MessageText: - - The property value is out of range for this transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_INCOMPATIBLE - - MessageText: - - The property value is incompatible with some other property or mediatype set on the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_OUTPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set output mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_INPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set input mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_MEDIATYPE_COMBINATION - - MessageText: - - The requested operation is not supported for the currently set combination of mediatypes.%0 - - - - - MessageId: MF_E_TRANSFORM_CONFLICTS_WITH_OTHER_CURRENTLY_ENABLED_FEATURES - - MessageText: - - The requested feature is not supported in combination with some other currently enabled feature.%0 - - - - - MessageId: MF_E_TRANSFORM_NEED_MORE_INPUT - - MessageText: - - The transform cannot produce output until it gets more input samples.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_SPKR_CONFIG - - MessageText: - - The requested operation is not supported for the current speaker configuration.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING - - MessageText: - - The transform cannot accept mediatype changes in the middle of processing.%0 - - - - - MessageId: MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT - - MessageText: - - The caller should not propagate this event to downstream components.%0 - - - - - MessageId: MF_E_UNSUPPORTED_D3D_TYPE - - MessageText: - - The input type is not supported for D3D device.%0 - - - - - MessageId: MF_E_TRANSFORM_ASYNC_LOCKED - - MessageText: - - The caller does not appear to support this transform's asynchronous capabilities.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_INITIALIZE_ACM_DRIVER - - MessageText: - - An audio compression manager driver could not be initialized by the transform.%0 - - - - - MessageId: MF_E_LICENSE_INCORRECT_RIGHTS - - MessageText: - - You are not allowed to open this file. Contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_OUTOFDATE - - MessageText: - - The license for this media file has expired. Get a new license or contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_REQUIRED - - MessageText: - - You need a license to perform the requested operation on this media file.%0 - - - - - MessageId: MF_E_DRM_HARDWARE_INCONSISTENT - - MessageText: - - The licenses for your media files are corrupted. Contact Microsoft product support.%0 - - - - - MessageId: MF_E_NO_CONTENT_PROTECTION_MANAGER - - MessageText: - - The APP needs to provide IMFContentProtectionManager callback to access the protected media file.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NO_RIGHTS - - MessageText: - - Client does not have rights to restore licenses.%0 - - - - - MessageId: MF_E_BACKUP_RESTRICTED_LICENSE - - MessageText: - - Licenses are restricted and hence can not be backed up.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NEEDS_INDIVIDUALIZATION - - MessageText: - - License restore requires machine to be individualized.%0 - - - - - MessageId: MF_S_PROTECTION_NOT_REQUIRED - - MessageText: - - Protection for stream is not required.%0 - - - - - MessageId: MF_E_COMPONENT_REVOKED - - MessageText: - - Component is revoked.%0 - - - - - MessageId: MF_E_TRUST_DISABLED - - MessageText: - - Trusted functionality is currently disabled on this component.%0 - - - - - MessageId: MF_E_WMDRMOTA_NO_ACTION - - MessageText: - - No Action is set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_ALREADY_SET - - MessageText: - - Action is already set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_HEADER_NOT_AVAILABLE - - MessageText: - - DRM Heaader is not available.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_ENCRYPTION_SCHEME_NOT_SUPPORTED - - MessageText: - - Current encryption scheme is not supported.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_MISMATCH - - MessageText: - - Action does not match with current configuration.%0 - - - - - MessageId: MF_E_WMDRMOTA_INVALID_POLICY - - MessageText: - - Invalid policy for WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_POLICY_UNSUPPORTED - - MessageText: - - The policies that the Input Trust Authority requires to be enforced are unsupported by the outputs.%0 - - - - - MessageId: MF_E_OPL_NOT_SUPPORTED - - MessageText: - - The OPL that the license requires to be enforced are not supported by the Input Trust Authority.%0 - - - - - MessageId: MF_E_TOPOLOGY_VERIFICATION_FAILED - - MessageText: - - The topology could not be successfully verified.%0 - - - - - MessageId: MF_E_SIGNATURE_VERIFICATION_FAILED - - MessageText: - - Signature verification could not be completed successfully for this component.%0 - - - - - MessageId: MF_E_DEBUGGING_NOT_ALLOWED - - MessageText: - - Running this process under a debugger while using protected content is not allowed.%0 - - - - - MessageId: MF_E_CODE_EXPIRED - - MessageText: - - MF component has expired.%0 - - - - - MessageId: MF_E_GRL_VERSION_TOO_LOW - - MessageText: - - The current GRL on the machine does not meet the minimum version requirements.%0 - - - - - MessageId: MF_E_GRL_RENEWAL_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any renewal entries for the specified revocation.%0 - - - - - MessageId: MF_E_GRL_EXTENSIBLE_ENTRY_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any extensible entries for the specified extension GUID.%0 - - - - - MessageId: MF_E_KERNEL_UNTRUSTED - - MessageText: - - The kernel isn't secure for high security level content.%0 - - - - - MessageId: MF_E_PEAUTH_UNTRUSTED - - MessageText: - - The response from protected environment driver isn't valid.%0 - - - - - MessageId: MF_E_NON_PE_PROCESS - - MessageText: - - A non-PE process tried to talk to PEAuth.%0 - - - - - MessageId: MF_E_REBOOT_REQUIRED - - MessageText: - - We need to reboot the machine.%0 - - - - - MessageId: MF_S_WAIT_FOR_POLICY_SET - - MessageText: - - Protection for this stream is not guaranteed to be enforced until the MEPolicySet event is fired.%0 - - - - - MessageId: MF_S_VIDEO_DISABLED_WITH_UNKNOWN_SOFTWARE_OUTPUT - - MessageText: - - This video stream is disabled because it is being sent to an unknown software output.%0 - - - - - MessageId: MF_E_GRL_INVALID_FORMAT - - MessageText: - - The GRL file is not correctly formed, it may have been corrupted or overwritten.%0 - - - - - MessageId: MF_E_GRL_UNRECOGNIZED_FORMAT - - MessageText: - - The GRL file is in a format newer than those recognized by this GRL Reader.%0 - - - - - MessageId: MF_E_ALL_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and required all processes that can run protected media to restart.%0 - - - - - MessageId: MF_E_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and the current process needs to restart.%0 - - - - - MessageId: MF_E_USERMODE_UNTRUSTED - - MessageText: - - The user space is untrusted for protected content play.%0 - - - - - MessageId: MF_E_PEAUTH_SESSION_NOT_STARTED - - MessageText: - - PEAuth communication session hasn't been started.%0 - - - - - MessageId: MF_E_PEAUTH_PUBLICKEY_REVOKED - - MessageText: - - PEAuth's public key is revoked.%0 - - - - - MessageId: MF_E_GRL_ABSENT - - MessageText: - - The GRL is absent.%0 - - - - - MessageId: MF_S_PE_TRUSTED - - MessageText: - - The Protected Environment is trusted.%0 - - - - - MessageId: MF_E_PE_UNTRUSTED - - MessageText: - - The Protected Environment is untrusted.%0 - - - - - MessageId: MF_E_PEAUTH_NOT_STARTED - - MessageText: - - The Protected Environment Authorization service (PEAUTH) has not been started.%0 - - - - - MessageId: MF_E_INCOMPATIBLE_SAMPLE_PROTECTION - - MessageText: - - The sample protection algorithms supported by components are not compatible.%0 - - - - - MessageId: MF_E_PE_SESSIONS_MAXED - - MessageText: - - No more protected environment sessions can be supported.%0 - - - - - MessageId: MF_E_HIGH_SECURITY_LEVEL_CONTENT_NOT_ALLOWED - - MessageText: - - WMDRM ITA does not allow protected content with high security level for this release.%0 - - - - - MessageId: MF_E_TEST_SIGNED_COMPONENTS_NOT_ALLOWED - - MessageText: - - WMDRM ITA cannot allow the requested action for the content as one or more components is not properly signed.%0 - - - - - MessageId: MF_E_ITA_UNSUPPORTED_ACTION - - MessageText: - - WMDRM ITA does not support the requested action.%0 - - - - - MessageId: MF_E_ITA_ERROR_PARSING_SAP_PARAMETERS - - MessageText: - - WMDRM ITA encountered an error in parsing the Secure Audio Path parameters.%0 - - - - - MessageId: MF_E_POLICY_MGR_ACTION_OUTOFBOUNDS - - MessageText: - - The Policy Manager action passed in is invalid.%0 - - - - - MessageId: MF_E_BAD_OPL_STRUCTURE_FORMAT - - MessageText: - - The structure specifying Output Protection Level is not the correct format.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_PROTECTION_GUID - - MessageText: - - WMDRM ITA does not recognize the Explicite Analog Video Output Protection guid specified in the license.%0 - - - - - MessageId: MF_E_NO_PMP_HOST - - MessageText: - - IMFPMPHost object not available.%0 - - - - - MessageId: MF_E_ITA_OPL_DATA_NOT_INITIALIZED - - MessageText: - - WMDRM ITA could not initialize the Output Protection Level data.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Analog Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_DIGITAL_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Digital Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_CLOCK_INVALID_CONTINUITY_KEY - - MessageText: - - The continuity key supplied is not currently valid.%0 - - - - - MessageId: MF_E_CLOCK_NO_TIME_SOURCE - - MessageText: - - No Presentation Time Source has been specified.%0 - - - - - MessageId: MF_E_CLOCK_STATE_ALREADY_SET - - MessageText: - - The clock is already in the requested state.%0 - - - - - MessageId: MF_E_CLOCK_NOT_SIMPLE - - MessageText: - - The clock has too many advanced features to carry out the request.%0 - - - - - MessageId: MF_S_CLOCK_STOPPED - - MessageText: - - Timer::SetTimer returns this success code if called happened while timer is stopped. Timer is not going to be dispatched until clock is running%0 - - - - - MessageId: MF_E_NO_MORE_DROP_MODES - - MessageText: - - The component does not support any more drop modes.%0 - - - - - MessageId: MF_E_NO_MORE_QUALITY_LEVELS - - MessageText: - - The component does not support any more quality levels.%0 - - - - - MessageId: MF_E_DROPTIME_NOT_SUPPORTED - - MessageText: - - The component does not support drop time functionality.%0 - - - - - MessageId: MF_E_QUALITYKNOB_WAIT_LONGER - - MessageText: - - Quality Manager needs to wait longer before bumping the Quality Level up.%0 - - - - - MessageId: MF_E_QM_INVALIDSTATE - - MessageText: - - Quality Manager is in an invalid state. Quality Management is off at this moment.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_CONTAINERTYPE - - MessageText: - - No transcode output container type is specified.%0 - - - - - MessageId: MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS - - MessageText: - - The profile does not have a media type configuration for any selected source streams.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_MATCHING_ENCODER - - MessageText: - - Cannot find an encoder MFT that accepts the user preferred output type.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_INITIALIZED - - MessageText: - - Memory allocator is not initialized.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_COMMITED - - MessageText: - - Memory allocator is not committed yet.%0 - - - - - MessageId: MF_E_ALLOCATOR_ALREADY_COMMITED - - MessageText: - - Memory allocator has already been committed.%0 - - - - - MessageId: MF_E_STREAM_ERROR - - MessageText: - - An error occurred in media stream.%0 - - - - - MessageId: MF_E_INVALID_STREAM_STATE - - MessageText: - - Stream is not in a state to handle the request.%0 - - - - - MessageId: MF_E_HW_STREAM_NOT_CONNECTED - - MessageText: - - Hardware stream is not connected yet.%0 - - - - - Main interface for using Media Foundation with NAudio - - - - - initializes MediaFoundation - only needs to be called once per process - - - - - Enumerate the installed MediaFoundation transforms in the specified category - - A category from MediaFoundationTransformCategories - - - - - uninitializes MediaFoundation - - - - - Creates a Media type - - - - - Creates a media type from a WaveFormat - - - - - Creates a memory buffer of the specified size - - Memory buffer size in bytes - The memory buffer - - - - Creates a sample object - - The sample object - - - - Creates a new attributes store - - Initial size - The attributes store - - - - Creates a media foundation byte stream based on a stream object - (usable with WinRT streams) - - The input stream - A media foundation byte stream - - - - Creates a source reader based on a byte stream - - The byte stream - A media foundation source reader - - - - Interop definitions for MediaFoundation - thanks to Lucian Wischik for the initial work on many of these definitions (also various interfaces) - n.b. the goal is to make as much of this internal as possible, and provide - better .NET APIs using the MediaFoundationApi class instead - - - - - Initializes Microsoft Media Foundation. - - - - - Shuts down the Microsoft Media Foundation platform - - - - - Creates an empty media type. - - - - - Initializes a media type from a WAVEFORMATEX structure. - - - - - Converts a Media Foundation audio media type to a WAVEFORMATEX structure. - - TODO: try making second parameter out WaveFormatExtraData - - - - Creates the source reader from a URL. - - - - - Creates the source reader from a byte stream. - - - - - Creates the sink writer from a URL or byte stream. - - - - - Creates a Microsoft Media Foundation byte stream that wraps an IRandomAccessStream object. - - - - - Gets a list of Microsoft Media Foundation transforms (MFTs) that match specified search criteria. - - - - - Creates an empty media sample. - - - - - Allocates system memory and creates a media buffer to manage it. - - - - - Creates an empty attribute store. - - - - - Gets a list of output formats from an audio encoder. - - - - - All streams - - - - - First audio stream - - - - - First video stream - - - - - Media source - - - - - Media Foundation SDK Version - - - - - Media Foundation API Version - - - - - Media Foundation Version - - - - - An abstract base class for simplifying working with Media Foundation Transforms - You need to override the method that actually creates and configures the transform - - - - - The Source Provider - - - - - The Output WaveFormat - - - - - Constructs a new MediaFoundationTransform wrapper - Will read one second at a time - - The source provider for input data to the transform - The desired output format - - - - To be implemented by overriding classes. Create the transform object, set up its input and output types, - and configure any custom properties in here - - An object implementing IMFTrasform - - - - Disposes this MediaFoundation transform - - - - - Disposes this Media Foundation Transform - - - - - Destructor - - - - - The output WaveFormat of this Media Foundation Transform - - - - - Reads data out of the source, passing it through the transform - - Output buffer - Offset within buffer to write to - Desired byte count - Number of bytes read - - - - Attempts to read from the transform - Some useful info here: - http://msdn.microsoft.com/en-gb/library/windows/desktop/aa965264%28v=vs.85%29.aspx#process_data - - - - - - Indicate that the source has been repositioned and completely drain out the transforms buffers - - - - - Media Foundation Transform Categories - - - - - MFT_CATEGORY_VIDEO_DECODER - - - - - MFT_CATEGORY_VIDEO_ENCODER - - - - - MFT_CATEGORY_VIDEO_EFFECT - - - - - MFT_CATEGORY_MULTIPLEXER - - - - - MFT_CATEGORY_DEMULTIPLEXER - - - - - MFT_CATEGORY_AUDIO_DECODER - - - - - MFT_CATEGORY_AUDIO_ENCODER - - - - - MFT_CATEGORY_AUDIO_EFFECT - - - - - MFT_CATEGORY_VIDEO_PROCESSOR - - - - - MFT_CATEGORY_OTHER - - - - - Media Type helper class, simplifying working with IMFMediaType - (will probably change in the future, to inherit from an attributes class) - Currently does not release the COM object, so you must do that yourself - - - - - Wraps an existing IMFMediaType object - - The IMFMediaType object - - - - Creates and wraps a new IMFMediaType object - - - - - Creates and wraps a new IMFMediaType object based on a WaveFormat - - WaveFormat - - - - Tries to get a UINT32 value, returning a default value if it doesn't exist - - Attribute key - Default value - Value or default if key doesn't exist - - - - The Sample Rate (valid for audio media types) - - - - - The number of Channels (valid for audio media types) - - - - - The number of bits per sample (n.b. not always valid for compressed audio types) - - - - - The average bytes per second (valid for audio media types) - - - - - The Media Subtype. For audio, is a value from the AudioSubtypes class - - - - - The Major type, e.g. audio or video (from the MediaTypes class) - - - - - Access to the actual IMFMediaType object - Use to pass to MF APIs or Marshal.ReleaseComObject when you are finished with it - - - - - Major Media Types - http://msdn.microsoft.com/en-us/library/windows/desktop/aa367377%28v=vs.85%29.aspx - - - - - Default - - - - - Audio - - - - - Video - - - - - Protected Media - - - - - Synchronized Accessible Media Interchange (SAMI) captions. - - - - - Script stream - - - - - Still image stream. - - - - - HTML stream. - - - - - Binary stream. - - - - - A stream that contains data files. - - - - - Contains information about an input stream on a Media Foundation transform (MFT) - - - - - Maximum amount of time between an input sample and the corresponding output sample, in 100-nanosecond units. - - - - - Bitwise OR of zero or more flags from the _MFT_INPUT_STREAM_INFO_FLAGS enumeration. - - - - - The minimum size of each input buffer, in bytes. - - - - - Maximum amount of input data, in bytes, that the MFT holds to perform lookahead. - - - - - The memory alignment required for input buffers. If the MFT does not require a specific alignment, the value is zero. - - - - - Defines messages for a Media Foundation transform (MFT). - - - - - Requests the MFT to flush all stored data. - - - - - Requests the MFT to drain any stored data. - - - - - Sets or clears the Direct3D Device Manager for DirectX Video Accereration (DXVA). - - - - - Drop samples - requires Windows 7 - - - - - Command Tick - requires Windows 8 - - - - - Notifies the MFT that streaming is about to begin. - - - - - Notifies the MFT that streaming is about to end. - - - - - Notifies the MFT that an input stream has ended. - - - - - Notifies the MFT that the first sample is about to be processed. - - - - - Marks a point in the stream. This message applies only to asynchronous MFTs. Requires Windows 7 - - - - - Contains information about an output buffer for a Media Foundation transform. - - - - - Output stream identifier. - - - - - Pointer to the IMFSample interface. - - - - - Before calling ProcessOutput, set this member to zero. - - - - - Before calling ProcessOutput, set this member to NULL. - - - - - Contains information about an output stream on a Media Foundation transform (MFT). - - - - - Bitwise OR of zero or more flags from the _MFT_OUTPUT_STREAM_INFO_FLAGS enumeration. - - - - - Minimum size of each output buffer, in bytes. - - - - - The memory alignment required for output buffers. - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The Media Subtype - - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. - - - - - The time stamp of the most recent sample to be encoded. - - - - - The time stamp of the most recent sample given to the media sink. - - - - - The time stamp of the most recent stream tick. - - - - - The system time of the most recent sample request from the media sink. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Contains flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - - - - - The MFT performs asynchronous data processing in software. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. - - - - - The MFT that must be unlocked by the application before use. - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. - - - - - Bitwise OR of all the flags, excluding MFT_ENUM_FLAG_SORTANDFILTER. - - - - - Indicates the status of an input stream on a Media Foundation transform (MFT). - - - - - None - - - - - The input stream can receive more data at this time. - - - - - Describes an input stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of input data must contain complete, unbroken units of data. - - - - - Each media sample that the client provides as input must contain exactly one unit of data, as defined for the MFT_INPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All input samples must be the same size. - - - - - MTF Input Stream Holds buffers - - - - - The MFT does not hold input samples after the IMFTransform::ProcessInput method returns. - - - - - This input stream can be removed by calling IMFTransform::DeleteInputStream. - - - - - This input stream is optional. - - - - - The MFT can perform in-place processing. - - - - - Defines flags for the IMFTransform::ProcessOutput method. - - - - - None - - - - - The MFT can still generate output from this stream without receiving any more input. - - - - - The format has changed on this output stream, or there is a new preferred format for this stream. - - - - - The MFT has removed this output stream. - - - - - There is no sample ready for this stream. - - - - - Indicates whether a Media Foundation transform (MFT) can produce output data. - - - - - None - - - - - There is a sample available for at least one output stream. - - - - - Describes an output stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of output data from the MFT contains complete, unbroken units of data. - - - - - Each output sample contains exactly one unit of data, as defined for the MFT_OUTPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All output samples are the same size. - - - - - The MFT can discard the output data from this output stream, if requested by the client. - - - - - This output stream is optional. - - - - - The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. - - - - - The MFT can either provide output samples for this stream or it can use samples that the client allocates. - - - - - The MFT does not require the client to process the output for this stream. - - - - - The MFT might remove this output stream during streaming. - - - - - Defines flags for processing output samples in a Media Foundation transform (MFT). - - - - - None - - - - - Do not produce output for streams in which the pSample member of the MFT_OUTPUT_DATA_BUFFER structure is NULL. - - - - - Regenerates the last output sample. - - - - - Process Output Status flags - - - - - None - - - - - The Media Foundation transform (MFT) has created one or more new output streams. - - - - - Defines flags for the setting or testing the media type on a Media Foundation transform (MFT). - - - - - None - - - - - Test the proposed media type, but do not set it. - - - - - Represents a MIDI Channel AfterTouch Event. - - - - - Creates a new ChannelAfterTouchEvent from raw MIDI data - - A binary reader - - - - Creates a new Channel After-Touch Event - - Absolute time - Channel - After-touch pressure - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The aftertouch pressure value - - - - - Represents a MIDI control change event - - - - - Reads a control change event from a MIDI stream - - Binary reader on the MIDI stream - - - - Creates a control change event - - Time - MIDI Channel Number - The MIDI Controller - Controller value - - - - Describes this control change event - - A string describing this event - - - - - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The controller number - - - - - The controller value - - - - - Represents a MIDI key signature event event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new Key signature event with the specified data - - - - - Creates a deep clone of this MIDI event. - - - - - Number of sharps or flats - - - - - Major or Minor key - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event - - - - - Gets the type of this meta event - - - - - Empty constructor - - - - - Custom constructor for use by derived types, who will manage the data themselves - - Meta event type - Meta data length - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Reads a meta-event from a stream - - A binary reader based on the stream of MIDI data - A new MetaEvent object - - - - Describes this meta event - - - - - - - - - - MIDI MetaEvent Type - - - - Track sequence number - - - Text event - - - Copyright - - - Sequence track name - - - Track instrument name - - - Lyric - - - Marker - - - Cue point - - - Program (patch) name - - - Device (port) name - - - MIDI Channel (not official?) - - - MIDI Port (not official?) - - - End track - - - Set tempo - - - SMPTE offset - - - Time signature - - - Key signature - - - Sequencer specific - - - - MIDI command codes - - - - Note Off - - - Note On - - - Key After-touch - - - Control change - - - Patch change - - - Channel after-touch - - - Pitch wheel change - - - Sysex message - - - Eox (comes at end of a sysex message) - - - Timing clock (used when synchronization is required) - - - Start sequence - - - Continue sequence - - - Stop sequence - - - Auto-Sensing - - - Meta-event - - - - MidiController enumeration - http://www.midi.org/techspecs/midimessages.php#3 - - - - Bank Select (MSB) - - - Modulation (MSB) - - - Breath Controller - - - Foot controller (MSB) - - - Main volume - - - Pan - - - Expression - - - Bank Select LSB - - - Sustain - - - Portamento On/Off - - - Sostenuto On/Off - - - Soft Pedal On/Off - - - Legato Footswitch - - - Reset all controllers - - - All notes off - - - - Represents an individual MIDI event - - - - The MIDI command code - - - - Creates a MidiEvent from a raw message received using - the MME MIDI In APIs - - The short MIDI message - A new MIDI Event - - - - Constructs a MidiEvent from a BinaryStream - - The binary stream of MIDI data - The previous MIDI event (pass null for first event) - A new MidiEvent - - - - Converts this MIDI event to a short message (32 bit integer) that - can be sent by the Windows MIDI out short message APIs - Cannot be implemented for all MIDI messages - - A short message - - - - Default constructor - - - - - Creates a MIDI event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - - - - Creates a deep clone of this MIDI event. - - - - - The MIDI Channel Number for this event (1-16) - - - - - The Delta time for this event - - - - - The absolute time for this event - - - - - The command code for this event - - - - - Whether this is a note off event - - - - - Whether this is a note on event - - - - - Determines if this is an end track event - - - - - Displays a summary of the MIDI event - - A string containing a brief description of this MIDI event - - - - Utility function that can read a variable length integer from a binary stream - - The binary stream - The integer read - - - - Writes a variable length integer to a binary stream - - Binary stream - The value to write - - - - Exports this MIDI event's data - Overriden in derived classes, but they should call this version - - Absolute time used to calculate delta. - Is updated ready for the next delta calculation - Stream to write to - - - - A helper class to manage collection of MIDI events - It has the ability to organise them in tracks - - - - - Creates a new Midi Event collection - - Initial file type - Delta Ticks Per Quarter Note - - - - The number of tracks - - - - - The absolute time that should be considered as time zero - Not directly used here, but useful for timeshifting applications - - - - - The number of ticks per quarter note - - - - - Gets events on a specified track - - Track number - The list of events - - - - Gets events on a specific track - - Track number - The list of events - - - - Adds a new track - - The new track event list - - - - Adds a new track - - Initial events to add to the new track - The new track event list - - - - Removes a track - - Track number to remove - - - - Clears all events - - - - - The MIDI file type - - - - - Adds an event to the appropriate track depending on file type - - The event to be added - The original (or desired) track number - When adding events in type 0 mode, the originalTrack parameter - is ignored. If in type 1 mode, it will use the original track number to - store the new events. If the original track was 0 and this is a channel based - event, it will create new tracks if necessary and put it on the track corresponding - to its channel number - - - - Sorts, removes empty tracks and adds end track markers - - - - - Gets an enumerator for the lists of track events - - - - - Gets an enumerator for the lists of track events - - - - - Utility class for comparing MidiEvent objects - - - - - Compares two MidiEvents - Sorts by time, with EndTrack always sorted to the end - - - - - Class able to read a MIDI file - - - - - Opens a MIDI file for reading - - Name of MIDI file - - - - MIDI File format - - - - - Opens a MIDI file for reading - - Name of MIDI file - If true will error on non-paired note events - - - - Opens a MIDI file stream for reading - - The input stream containing a MIDI file - If true will error on non-paired note events - - - - The collection of events in this MIDI file - - - - - Number of tracks in this MIDI file - - - - - Delta Ticks Per Quarter Note - - - - - Describes the MIDI file - - A string describing the MIDI file and its events - - - - Exports a MIDI file - - Filename to export to - Events to export - - - - Represents a MIDI in device - - - - - Called when a MIDI message is received - - - - - An invalid MIDI message - - - - - Gets the number of MIDI input devices available in the system - - - - - Opens a specified MIDI in device - - The device number - - - - Closes this MIDI in device - - - - - Closes this MIDI in device - - - - - Start the MIDI in device - - - - - Stop the MIDI in device - - - - - Reset the MIDI in device - - - - - Gets the MIDI in device info - - - - - Closes the MIDI out device - - True if called from Dispose - - - - Cleanup - - - - - MIDI In Device Capabilities - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name - - - - - Support - Reserved - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - MIDI In Message Information - - - - - Create a new MIDI In Message EventArgs - - - - - - - The Raw message received from the MIDI In API - - - - - The raw message interpreted as a MidiEvent - - - - - The timestamp in milliseconds for this message - - - - - MIM_OPEN - - - - - MIM_CLOSE - - - - - MIM_DATA - - - - - MIM_LONGDATA - - - - - MIM_ERROR - - - - - MIM_LONGERROR - - - - - MIM_MOREDATA - - - - - MOM_OPEN - - - - - MOM_CLOSE - - - - - MOM_DONE - - - - - Represents a MIDI message - - - - - Creates a new MIDI message - - Status - Data parameter 1 - Data parameter 2 - - - - Creates a new MIDI message from a raw message - - A packed MIDI message from an MMIO function - - - - Creates a Note On message - - Note number (0 to 127) - Volume (0 to 127) - MIDI channel (1 to 16) - A new MidiMessage object - - - - Creates a Note Off message - - Note number - Volume - MIDI channel (1-16) - A new MidiMessage object - - - - Creates a patch change message - - The patch number - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Creates a Control Change message - - The controller number to change - The value to set the controller to - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Returns the raw MIDI message data - - - - - Represents a MIDI out device - - - - - Gets the number of MIDI devices available in the system - - - - - Gets the MIDI Out device info - - - - - Opens a specified MIDI out device - - The device number - - - - Closes this MIDI out device - - - - - Closes this MIDI out device - - - - - Gets or sets the volume for this MIDI out device - - - - - Resets the MIDI out device - - - - - Sends a MIDI out message - - Message - Parameter 1 - Parameter 2 - - - - Sends a MIDI message to the MIDI out device - - The message to send - - - - Closes the MIDI out device - - True if called from Dispose - - - - Send a long message, for example sysex. - - The bytes to send. - - - - Cleanup - - - - - class representing the capabilities of a MIDI out device - MIDIOUTCAPS: http://msdn.microsoft.com/en-us/library/dd798467%28VS.85%29.aspx - - - - - MIDICAPS_VOLUME - - - - - separate left-right volume control - MIDICAPS_LRVOLUME - - - - - MIDICAPS_CACHE - - - - - MIDICAPS_STREAM - driver supports midiStreamOut directly - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - Returns the number of supported voices - - - - - Gets the polyphony of the device - - - - - Returns true if the device supports all channels - - - - - Queries whether a particular channel is supported - - Channel number to test - True if the channel is supported - - - - Returns true if the device supports patch caching - - - - - Returns true if the device supports separate left and right volume - - - - - Returns true if the device supports MIDI stream out - - - - - Returns true if the device supports volume control - - - - - Returns the type of technology used by this MIDI out device - - - - - Represents the different types of technology used by a MIDI out device - - from mmsystem.h - - - The device is a MIDI port - - - The device is a MIDI synth - - - The device is a square wave synth - - - The device is an FM synth - - - The device is a MIDI mapper - - - The device is a WaveTable synth - - - The device is a software synth - - - - Represents a note MIDI event - - - - - Reads a NoteEvent from a stream of MIDI data - - Binary Reader for the stream - - - - Creates a MIDI Note Event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - MIDI Note Number - MIDI Note Velocity - - - - - - - - - The MIDI note number - - - - - The note velocity - - - - - The note name - - - - - Describes the Note Event - - Note event as a string - - - - - - - - - Represents a MIDI note on event - - - - - Reads a new Note On event from a stream of MIDI data - - Binary reader on the MIDI data stream - - - - Creates a NoteOn event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI note number - MIDI note velocity - MIDI note duration - - - - Creates a deep clone of this MIDI event. - - - - - The associated Note off event - - - - - Get or set the Note Number, updating the off event at the same time - - - - - Get or set the channel, updating the off event at the same time - - - - - The duration of this note - - - There must be a note off event - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI patch change event - - - - - Gets the default MIDI instrument names - - - - - Reads a new patch change event from a MIDI stream - - Binary reader for the MIDI stream - - - - Creates a new patch change event - - Time of the event - Channel number - Patch number - - - - The Patch Number - - - - - Describes this patch change event - - String describing the patch change event - - - - Gets as a short message for sending with the midiOutShortMsg API - - short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI pitch wheel change event - - - - - Reads a pitch wheel change event from a MIDI stream - - The MIDI stream to read from - - - - Creates a new pitch wheel change event - - Absolute event time - Channel - Pitch wheel value - - - - Describes this pitch wheel change event - - String describing this pitch wheel change event - - - - Pitch Wheel Value 0 is minimum, 0x2000 (8192) is default, 0x3FFF (16383) is maximum - - - - - Gets a short message - - Integer to sent as short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event with raw data - - - - - Raw data contained in the meta event - - - - - Creates a meta event with raw data - - - - - Creates a deep clone of this MIDI event. - - - - - Describes this meta event - - - - - - - - - - Represents a Sequencer Specific event - - - - - Reads a new sequencer specific event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new Sequencer Specific event - - The sequencer specific data - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this sequencer specific - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - SMPTE Offset Event - - - - - Creates a new time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a deep clone of this MIDI event. - - - - - Hours - - - - - Minutes - - - - - Seconds - - - - - Frames - - - - - SubFrames - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI sysex message - - - - - Reads a sysex message from a MIDI stream - - Stream of MIDI data - a new sysex message - - - - Creates a deep clone of this MIDI event. - - - - - Describes this sysex message - - A string describing the sysex message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI tempo event - - - - - Reads a new tempo event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new tempo event with specified settings - - Microseconds per quarter note - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Describes this tempo event - - String describing the tempo event - - - - Microseconds per quarter note - - - - - Tempo - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI text event - - - - - Reads a new text event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TextEvent - - The text in this type - MetaEvent type (must be one that is - associated with text data) - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this text event - - - - - The raw contents of this text event - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TimeSignatureEvent - - Time at which to create this event - Numerator - Denominator - Ticks in Metronome Click - No of 32nd Notes in Quarter Click - - - - Creates a deep clone of this MIDI event. - - - - - Numerator (number of beats in a bar) - - - - - Denominator (Beat unit), - 1 means 2, 2 means 4 (crochet), 3 means 8 (quaver), 4 means 16 and 5 means 32 - - - - - Ticks in a metronome click - - - - - Number of 32nd notes in a quarter note - - - - - The time signature - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI track sequence number event event - - - - - Creates a new track sequence number event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a deep clone of this MIDI event. - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Boolean mixer control - - - - - Gets the details for this control - - memory pointer - - - - The current value of the control - - - - - Custom Mixer control - - - - - Get the data for this custom control - - pointer to memory to receive data - - - - List text mixer control - - - - - Get the details for this control - - Memory location to read to - - - Represents a Windows mixer device - - - The number of mixer devices available - - - Connects to the specified mixer - The index of the mixer to use. - This should be between zero and NumberOfDevices - 1 - - - The number of destinations this mixer supports - - - The name of this mixer device - - - The manufacturer code for this mixer device - - - The product identifier code for this mixer device - - - Retrieve the specified MixerDestination object - The ID of the destination to use. - Should be between 0 and DestinationCount - 1 - - - - A way to enumerate the destinations - - - - - A way to enumerate all available devices - - - - - Represents a mixer control - - - - - Mixer Handle - - - - - Number of Channels - - - - - Mixer Handle Type - - - - - Gets all the mixer controls - - Mixer Handle - Mixer Line - Mixer Handle Type - - - - - Gets a specified Mixer Control - - Mixer Handle - Line ID - Control ID - Number of Channels - Flags to use (indicates the meaning of mixerHandle) - - - - - Gets the control details - - - - - Gets the control details - - - - - - Mixer control name - - - - - Mixer control type - - - - - Returns true if this is a boolean control - - Control type - - - - Is this a boolean control - - - - - Determines whether a specified mixer control type is a list text control - - - - - True if this is a list text control - - - - - True if this is a signed control - - - - - True if this is an unsigned control - - - - - True if this is a custom control - - - - - String representation for debug purposes - - - - - Mixer control types - - - - Custom - - - Boolean meter - - - Signed meter - - - Peak meter - - - Unsigned meter - - - Boolean - - - On Off - - - Mute - - - Mono - - - Loudness - - - Stereo Enhance - - - Button - - - Decibels - - - Signed - - - Unsigned - - - Percent - - - Slider - - - Pan - - - Q-sound pan - - - Fader - - - Volume - - - Bass - - - Treble - - - Equaliser - - - Single Select - - - Mux - - - Multiple select - - - Mixer - - - Micro time - - - Milli time - - - - Mixer Interop Flags - - - - - MIXER_OBJECTF_HANDLE = 0x80000000; - - - - - MIXER_OBJECTF_MIXER = 0x00000000; - - - - - MIXER_OBJECTF_HMIXER - - - - - MIXER_OBJECTF_WAVEOUT - - - - - MIXER_OBJECTF_HWAVEOUT - - - - - MIXER_OBJECTF_WAVEIN - - - - - MIXER_OBJECTF_HWAVEIN - - - - - MIXER_OBJECTF_MIDIOUT - - - - - MIXER_OBJECTF_HMIDIOUT - - - - - MIXER_OBJECTF_MIDIIN - - - - - MIXER_OBJECTF_HMIDIIN - - - - - MIXER_OBJECTF_AUX - - - - - MIXER_GETCONTROLDETAILSF_VALUE = 0x00000000; - MIXER_SETCONTROLDETAILSF_VALUE = 0x00000000; - - - - - MIXER_GETCONTROLDETAILSF_LISTTEXT = 0x00000001; - MIXER_SETCONTROLDETAILSF_LISTTEXT = 0x00000001; - - - - - MIXER_GETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_SETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_GETLINECONTROLSF_QUERYMASK = 0x0000000F; - - - - - MIXER_GETLINECONTROLSF_ALL = 0x00000000; - - - - - MIXER_GETLINECONTROLSF_ONEBYID = 0x00000001; - - - - - MIXER_GETLINECONTROLSF_ONEBYTYPE = 0x00000002; - - - - - MIXER_GETLINEINFOF_DESTINATION = 0x00000000; - - - - - MIXER_GETLINEINFOF_SOURCE = 0x00000001; - - - - - MIXER_GETLINEINFOF_LINEID = 0x00000002; - - - - - MIXER_GETLINEINFOF_COMPONENTTYPE = 0x00000003; - - - - - MIXER_GETLINEINFOF_TARGETTYPE = 0x00000004; - - - - - MIXER_GETLINEINFOF_QUERYMASK = 0x0000000F; - - - - - Mixer Line Flags - - - - - Audio line is active. An active line indicates that a signal is probably passing - through the line. - - - - - Audio line is disconnected. A disconnected line's associated controls can still be - modified, but the changes have no effect until the line is connected. - - - - - Audio line is an audio source line associated with a single audio destination line. - If this flag is not set, this line is an audio destination line associated with zero - or more audio source lines. - - - - - BOUNDS structure - - - - - dwMinimum / lMinimum / reserved 0 - - - - - dwMaximum / lMaximum / reserved 1 - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - METRICS structure - - - - - cSteps / reserved[0] - - - - - cbCustomData / reserved[1], number of bytes for control details - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - MIXERCONTROL struct - http://msdn.microsoft.com/en-us/library/dd757293%28VS.85%29.aspx - - - - - Represents a mixer line (source or destination) - - - - - Creates a new mixer destination - - Mixer Handle - Destination Index - Mixer Handle Type - - - - Creates a new Mixer Source For a Specified Source - - Mixer Handle - Destination Index - Source Index - Flag indicating the meaning of mixerHandle - - - - Creates a new Mixer Source - - Wave In Device - - - - Mixer Line Name - - - - - Mixer Line short name - - - - - The line ID - - - - - Component Type - - - - - Mixer destination type description - - - - - Number of channels - - - - - Number of sources - - - - - Number of controls - - - - - Is this destination active - - - - - Is this destination disconnected - - - - - Is this destination a source - - - - - Gets the specified source - - - - - Enumerator for the controls on this Mixer Limne - - - - - Enumerator for the sources on this Mixer Line - - - - - The name of the target output device - - - - - Describes this Mixer Line (for diagnostic purposes) - - - - - Mixer Line Component type enumeration - - - - - Audio line is a destination that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_DST_UNDEFINED - - - - - Audio line is a digital destination (for example, digital input to a DAT or CD audio device). - MIXERLINE_COMPONENTTYPE_DST_DIGITAL - - - - - Audio line is a line level destination (for example, line level input from a CD audio device) that will be the final recording source for the analog-to-digital converter (ADC). Because most audio cards for personal computers provide some sort of gain for the recording audio source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_DST_WAVEIN type. - MIXERLINE_COMPONENTTYPE_DST_LINE - - - - - Audio line is a destination used for a monitor. - MIXERLINE_COMPONENTTYPE_DST_MONITOR - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive speakers. This is the typical component type for the audio output of audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_SPEAKERS - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive headphones. Most audio cards use the same audio destination line for speakers and headphones, in which case the mixer device simply uses the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS type. - MIXERLINE_COMPONENTTYPE_DST_HEADPHONES - - - - - Audio line is a destination that will be routed to a telephone line. - MIXERLINE_COMPONENTTYPE_DST_TELEPHONE - - - - - Audio line is a destination that will be the final recording source for the waveform-audio input (ADC). This line typically provides some sort of gain or attenuation. This is the typical component type for the recording line of most audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_WAVEIN - - - - - Audio line is a destination that will be the final recording source for voice input. This component type is exactly like MIXERLINE_COMPONENTTYPE_DST_WAVEIN but is intended specifically for settings used during voice recording/recognition. Support for this line is optional for a mixer device. Many mixer devices provide only MIXERLINE_COMPONENTTYPE_DST_WAVEIN. - MIXERLINE_COMPONENTTYPE_DST_VOICEIN - - - - - Audio line is a source that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_SRC_UNDEFINED - - - - - Audio line is a digital source (for example, digital output from a DAT or audio CD). - MIXERLINE_COMPONENTTYPE_SRC_DIGITAL - - - - - Audio line is a line-level source (for example, line-level input from an external stereo) that can be used as an optional recording source. Because most audio cards for personal computers provide some sort of gain for the recording source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY type. - MIXERLINE_COMPONENTTYPE_SRC_LINE - - - - - Audio line is a microphone recording source. Most audio cards for personal computers provide at least two types of recording sources: an auxiliary audio line and microphone input. A microphone audio line typically provides some sort of gain. Audio cards that use a single input for use with a microphone or auxiliary audio line should use the MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE component type. - MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE - - - - - Audio line is a source originating from the output of an internal synthesizer. Most audio cards for personal computers provide some sort of MIDI synthesizer (for example, an Adlib®-compatible or OPL/3 FM synthesizer). - MIXERLINE_COMPONENTTYPE_SRC_SYNTHESIZER - - - - - Audio line is a source originating from the output of an internal audio CD. This component type is provided for audio cards that provide an audio source line intended to be connected to an audio CD (or CD-ROM playing an audio CD). - MIXERLINE_COMPONENTTYPE_SRC_COMPACTDISC - - - - - Audio line is a source originating from an incoming telephone line. - MIXERLINE_COMPONENTTYPE_SRC_TELEPHONE - - - - - Audio line is a source originating from personal computer speaker. Several audio cards for personal computers provide the ability to mix what would typically be played on the internal speaker with the output of an audio card. Some audio cards support the ability to use this output as a recording source. - MIXERLINE_COMPONENTTYPE_SRC_PCSPEAKER - - - - - Audio line is a source originating from the waveform-audio output digital-to-analog converter (DAC). Most audio cards for personal computers provide this component type as a source to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination. Some cards also allow this source to be routed to the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_WAVEOUT - - - - - Audio line is a source originating from the auxiliary audio line. This line type is intended as a source with gain or attenuation that can be routed to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination and/or recorded from the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY - - - - - Audio line is an analog source (for example, analog output from a video-cassette tape). - MIXERLINE_COMPONENTTYPE_SRC_ANALOG - - - - - Represents a signed mixer control - - - - - Gets details for this contrl - - - - - The value of the control - - - - - Minimum value for this control - - - - - Maximum value for this control - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - - Represents an unsigned mixer control - - - - - Gets the details for this control - - - - - The control value - - - - - The control's minimum value - - - - - The control's maximum value - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - Helper methods for working with audio buffers - - - - - Ensures the buffer is big enough - - - - - - - - Ensures the buffer is big enough - - - - - - - - these will become extension methods once we move to .NET 3.5 - - - - - Checks if the buffer passed in is entirely full of nulls - - - - - Converts to a string containing the buffer described in hex - - - - - Decodes the buffer using the specified encoding, stopping at the first null - - - - - Concatenates the given arrays into a single array. - - The arrays to concatenate - The concatenated resulting array. - - - - An encoding for use with file types that have one byte per character - - - - - The one and only instance of this class - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Chunk Identifier helpers - - - - - Chunk identifier to Int32 (replaces mmioStringToFOURCC) - - four character chunk identifier - Chunk identifier as int 32 - - - - A very basic circular buffer implementation - - - - - Create a new circular buffer - - Max buffer size in bytes - - - - Write data to the buffer - - Data to write - Offset into data - Number of bytes to write - number of bytes written - - - - Read from the buffer - - Buffer to read into - Offset into read buffer - Bytes to read - Number of bytes actually read - - - - Maximum length of this circular buffer - - - - - Number of bytes currently stored in the circular buffer - - - - - Resets the buffer - - - - - Advances the buffer, discarding bytes - - Bytes to advance - - - - A util class for conversions - - - - - linear to dB conversion - - linear value - decibel value - - - - dB to linear conversion - - decibel value - linear value - - - - Allows us to add descriptions to interop members - - - - - The description - - - - - Field description - - - - - String representation - - - - - - Helper to get descriptions - - - - - Describes the Guid by looking for a FieldDescription attribute on the specified class - - - - - HResult - - - - - S_OK - - - - - S_FALSE - - - - - E_INVALIDARG (from winerror.h) - - - - - MAKE_HRESULT macro - - - - - Helper to deal with the fact that in Win Store apps, - the HResult property name has changed - - COM Exception - The HResult - - - - Methods for converting between IEEE 80-bit extended double precision - and standard C# double precision. - - - - - Converts a C# double precision number to an 80-bit - IEEE extended double precision number (occupying 10 bytes). - - The double precision number to convert to IEEE extended. - An array of 10 bytes containing the IEEE extended number. - - - - Converts an IEEE 80-bit extended precision number to a - C# double precision number. - - The 80-bit IEEE extended number (as an array of 10 bytes). - A C# double precision number that is a close representation of the IEEE extended number. - - - - Pass-through stream that ignores Dispose - Useful for dealing with MemoryStreams that you want to re-use - - - - - The source stream all other methods fall through to - - - - - If true the Dispose will be ignored, if false, will pass through to the SourceStream - Set to true by default - - - - - Creates a new IgnoreDisposeStream - - The source stream - - - - Can Read - - - - - Can Seek - - - - - Can write to the underlying stream - - - - - Flushes the underlying stream - - - - - Gets the length of the underlying stream - - - - - Gets or sets the position of the underlying stream - - - - - Reads from the underlying stream - - - - - Seeks on the underlying stream - - - - - Sets the length of the underlying stream - - - - - Writes to the underlying stream - - - - - Dispose - by default (IgnoreDispose = true) will do nothing, - leaving the underlying stream undisposed - - - - - Support for Marshal Methods in both UWP and .NET 3.5 - - - - - SizeOf a structure - - - - - Offset of a field in a structure - - - - - Pointer to Structure - - - - - In-place and stable implementation of MergeSort - - - - - MergeSort a list of comparable items - - - - - MergeSort a list - - - - - General purpose native methods for internal NAudio use - - - - - A thread-safe Progress Log Control - - - - - Creates a new progress log control - - - - - The contents of the log as text - - - - - Log a message - - - - - Clear the log - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - WavePosition extension methods - - - - - Get Position as timespan - - - - - Manufacturer codes from mmreg.h - - - - Microsoft Corporation - - - Creative Labs, Inc - - - Media Vision, Inc. - - - Fujitsu Corp. - - - Artisoft, Inc. - - - Turtle Beach, Inc. - - - IBM Corporation - - - Vocaltec LTD. - - - Roland - - - DSP Solutions, Inc. - - - NEC - - - ATI - - - Wang Laboratories, Inc - - - Tandy Corporation - - - Voyetra - - - Antex Electronics Corporation - - - ICL Personal Systems - - - Intel Corporation - - - Advanced Gravis - - - Video Associates Labs, Inc. - - - InterActive Inc - - - Yamaha Corporation of America - - - Everex Systems, Inc - - - Echo Speech Corporation - - - Sierra Semiconductor Corp - - - Computer Aided Technologies - - - APPS Software International - - - DSP Group, Inc - - - microEngineering Labs - - - Computer Friends, Inc. - - - ESS Technology - - - Audio, Inc. - - - Motorola, Inc. - - - Canopus, co., Ltd. - - - Seiko Epson Corporation - - - Truevision - - - Aztech Labs, Inc. - - - Videologic - - - SCALACS - - - Korg Inc. - - - Audio Processing Technology - - - Integrated Circuit Systems, Inc. - - - Iterated Systems, Inc. - - - Metheus - - - Logitech, Inc. - - - Winnov, Inc. - - - NCR Corporation - - - EXAN - - - AST Research Inc. - - - Willow Pond Corporation - - - Sonic Foundry - - - Vitec Multimedia - - - MOSCOM Corporation - - - Silicon Soft, Inc. - - - Supermac - - - Audio Processing Technology - - - Speech Compression - - - Ahead, Inc. - - - Dolby Laboratories - - - OKI - - - AuraVision Corporation - - - Ing C. Olivetti & C., S.p.A. - - - I/O Magic Corporation - - - Matsushita Electric Industrial Co., LTD. - - - Control Resources Limited - - - Xebec Multimedia Solutions Limited - - - New Media Corporation - - - Natural MicroSystems - - - Lyrrus Inc. - - - Compusic - - - OPTi Computers Inc. - - - Adlib Accessories Inc. - - - Compaq Computer Corp. - - - Dialogic Corporation - - - InSoft, Inc. - - - M.P. Technologies, Inc. - - - Weitek - - - Lernout & Hauspie - - - Quanta Computer Inc. - - - Apple Computer, Inc. - - - Digital Equipment Corporation - - - Mark of the Unicorn - - - Workbit Corporation - - - Ositech Communications Inc. - - - miro Computer Products AG - - - Cirrus Logic - - - ISOLUTION B.V. - - - Horizons Technology, Inc - - - Computer Concepts Ltd - - - Voice Technologies Group, Inc. - - - Radius - - - Rockwell International - - - Co. XYZ for testing - - - Opcode Systems - - - Voxware Inc - - - Northern Telecom Limited - - - APICOM - - - Grande Software - - - ADDX - - - Wildcat Canyon Software - - - Rhetorex Inc - - - Brooktree Corporation - - - ENSONIQ Corporation - - - FAST Multimedia AG - - - NVidia Corporation - - - OKSORI Co., Ltd. - - - DiAcoustics, Inc. - - - Gulbransen, Inc. - - - Kay Elemetrics, Inc. - - - Crystal Semiconductor Corporation - - - Splash Studios - - - Quarterdeck Corporation - - - TDK Corporation - - - Digital Audio Labs, Inc. - - - Seer Systems, Inc. - - - PictureTel Corporation - - - AT&T Microelectronics - - - Osprey Technologies, Inc. - - - Mediatrix Peripherals - - - SounDesignS M.C.S. Ltd. - - - A.L. Digital Ltd. - - - Spectrum Signal Processing, Inc. - - - Electronic Courseware Systems, Inc. - - - AMD - - - Core Dynamics - - - CANAM Computers - - - Softsound, Ltd. - - - Norris Communications, Inc. - - - Danka Data Devices - - - EuPhonics - - - Precept Software, Inc. - - - Crystal Net Corporation - - - Chromatic Research, Inc - - - Voice Information Systems, Inc - - - Vienna Systems - - - Connectix Corporation - - - Gadget Labs LLC - - - Frontier Design Group LLC - - - Viona Development GmbH - - - Casio Computer Co., LTD - - - Diamond Multimedia - - - S3 - - - Fraunhofer - - - - Summary description for MmException. - - - - - Creates a new MmException - - The result returned by the Windows API call - The name of the Windows API that failed - - - - Helper function to automatically raise an exception on failure - - The result of the API call - The API function name - - - - Returns the Windows API result - - - - - Windows multimedia error codes from mmsystem.h. - - - - no error, MMSYSERR_NOERROR - - - unspecified error, MMSYSERR_ERROR - - - device ID out of range, MMSYSERR_BADDEVICEID - - - driver failed enable, MMSYSERR_NOTENABLED - - - device already allocated, MMSYSERR_ALLOCATED - - - device handle is invalid, MMSYSERR_INVALHANDLE - - - no device driver present, MMSYSERR_NODRIVER - - - memory allocation error, MMSYSERR_NOMEM - - - function isn't supported, MMSYSERR_NOTSUPPORTED - - - error value out of range, MMSYSERR_BADERRNUM - - - invalid flag passed, MMSYSERR_INVALFLAG - - - invalid parameter passed, MMSYSERR_INVALPARAM - - - handle being used simultaneously on another thread (eg callback),MMSYSERR_HANDLEBUSY - - - specified alias not found, MMSYSERR_INVALIDALIAS - - - bad registry database, MMSYSERR_BADDB - - - registry key not found, MMSYSERR_KEYNOTFOUND - - - registry read error, MMSYSERR_READERROR - - - registry write error, MMSYSERR_WRITEERROR - - - registry delete error, MMSYSERR_DELETEERROR - - - registry value not found, MMSYSERR_VALNOTFOUND - - - driver does not call DriverCallback, MMSYSERR_NODRIVERCB - - - more data to be returned, MMSYSERR_MOREDATA - - - unsupported wave format, WAVERR_BADFORMAT - - - still something playing, WAVERR_STILLPLAYING - - - header not prepared, WAVERR_UNPREPARED - - - device is synchronous, WAVERR_SYNC - - - Conversion not possible (ACMERR_NOTPOSSIBLE) - - - Busy (ACMERR_BUSY) - - - Header Unprepared (ACMERR_UNPREPARED) - - - Cancelled (ACMERR_CANCELED) - - - invalid line (MIXERR_INVALLINE) - - - invalid control (MIXERR_INVALCONTROL) - - - invalid value (MIXERR_INVALVALUE) - - - diff --git a/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.dll b/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.dll deleted file mode 100644 index 38dcd81..0000000 Binary files a/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.dll and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.xml b/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.xml deleted file mode 100644 index d068719..0000000 --- a/packages/NAudio.1.10.0/lib/netcoreapp3.0/NAudio.xml +++ /dev/null @@ -1,24652 +0,0 @@ - - - - NAudio - - - - - a-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts an a-law encoded byte to a 16 bit linear sample - - a-law encoded byte - Linear sample - - - - A-law encoder - - - - - Encodes a single 16 bit sample to a-law - - 16 bit PCM sample - a-law encoded byte - - - - SpanDSP - a series of DSP components for telephony - - g722_decode.c - The ITU G.722 codec, decode part. - - Written by Steve Underwood <steveu@coppice.org> - - Copyright (C) 2005 Steve Underwood - Ported to C# by Mark Heath 2011 - - Despite my general liking of the GPL, I place my own contributions - to this code in the public domain for the benefit of all mankind - - even the slimy ones who might try to proprietize my work and use it - to my detriment. - - Based in part on a single channel G.722 codec which is: - Copyright (c) CMU 1993 - Computer Science, Speech Group - Chengxiang Lu and Alex Hauptmann - - - - - hard limits to 16 bit samples - - - - - Decodes a buffer of G722 - - Codec state - Output buffer (to contain decompressed PCM samples) - - Number of bytes in input G722 data to decode - Number of samples written into output buffer - - - - Encodes a buffer of G722 - - Codec state - Output buffer (to contain encoded G722) - PCM 16 bit samples to encode - Number of samples in the input buffer to encode - Number of encoded bytes written into output buffer - - - - Stores state to be used between calls to Encode or Decode - - - - - ITU Test Mode - TRUE if the operating in the special ITU test mode, with the band split filters disabled. - - - - - TRUE if the G.722 data is packed - - - - - 8kHz Sampling - TRUE if encode from 8k samples/second - - - - - Bits Per Sample - 6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps. - - - - - Signal history for the QMF (x) - - - - - Band - - - - - In bit buffer - - - - - Number of bits in InBuffer - - - - - Out bit buffer - - - - - Number of bits in OutBuffer - - - - - Creates a new instance of G722 Codec State for a - new encode or decode session - - Bitrate (typically 64000) - Special options - - - - Band data for G722 Codec - - - - s - - - sp - - - sz - - - r - - - a - - - ap - - - p - - - d - - - b - - - bp - - - sg - - - nb - - - det - - - - G722 Flags - - - - - None - - - - - Using a G722 sample rate of 8000 - - - - - Packed - - - - - mu-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts a mu-law encoded byte to a 16 bit linear sample - - mu-law encoded byte - Linear sample - - - - mu-law encoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - Encodes a single 16 bit sample to mu-law - - 16 bit PCM sample - mu-law encoded byte - - - - Audio Capture Client - - - - - Gets a pointer to the buffer - - Pointer to the buffer - - - - Gets a pointer to the buffer - - Number of frames to read - Buffer flags - Pointer to the buffer - - - - Gets the size of the next packet - - - - - Release buffer - - Number of frames written - - - - Release the COM object - - - - - Windows CoreAudio AudioClient - - - - - Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams. - Can be called before initialize - - - - - Initializes the Audio Client - - Share Mode - Stream Flags - Buffer Duration - Periodicity - Wave Format - Audio Session GUID (can be null) - - - - Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first) - - - - - Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized. - - - - - Retrieves the number of frames of padding in the endpoint buffer (must initialize first) - - - - - Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer. - (can be called before initialize) - - - - - Gets the minimum device period - (can be called before initialize) - - - - - Returns the AudioStreamVolume service for this AudioClient. - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Gets the AudioClockClient service - - - - - Gets the AudioRenderClient service - - - - - Gets the AudioCaptureClient service - - - - - Determines whether if the specified output format is supported - - The share mode. - The desired format. - True if the format is supported - - - - Determines if the specified output format is supported in shared mode - - Share Mode - Desired Format - Output The closest match format. - True if the format is supported - - - - Starts the audio stream - - - - - Stops the audio stream. - - - - - Set the Event Handle for buffer synchro. - - The Wait Handle to setup - - - - Resets the audio stream - Reset is a control method that the client calls to reset a stopped audio stream. - Resetting the stream flushes all pending data and resets the audio clock stream - position to 0. This method fails if it is called on a stream that is not stopped - - - - - Dispose - - - - - Audio Client Buffer Flags - - - - - None - - - - - AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY - - - - - AUDCLNT_BUFFERFLAGS_SILENT - - - - - AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR - - - - - The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream. - - http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx - - - - The size of the buffer for the audio stream. - - - - - Boolean value to indicate whether or not the audio stream is hardware-offloaded - - - - - An enumeration that is used to specify the category of the audio stream. - - - - - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - - AUDCLNT_SHAREMODE - - - - - AUDCLNT_SHAREMODE_SHARED, - - - - - AUDCLNT_SHAREMODE_EXCLUSIVE - - - - - AUDCLNT_STREAMFLAGS - - - - - None - - - - - AUDCLNT_STREAMFLAGS_CROSSPROCESS - - - - - AUDCLNT_STREAMFLAGS_LOOPBACK - - - - - AUDCLNT_STREAMFLAGS_EVENTCALLBACK - - - - - AUDCLNT_STREAMFLAGS_NOPERSIST - - - - - Defines values that describe the characteristics of an audio stream. - - - - - No stream options. - - - - - The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware. - - - - - Audio Clock Client - - - - - Characteristics - - - - - Frequency - - - - - Get Position - - - - - Adjusted Position - - - - - Can Adjust Position - - - - - Dispose - - - - - Audio Endpoint Volume - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - On Volume Notification - - - - - Volume Range - - - - - Hardware Support - - - - - Step Information - - - - - Channels - - - - - Master Volume Level - - - - - Master Volume Level Scalar - - - - - Mute - - - - - Volume Step Up - - - - - Volume Step Down - - - - - Creates a new Audio endpoint volume - - IAudioEndpointVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Audio Endpoint Volume Channel - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - Volume Level - - - - - Volume Level Scalar - - - - - Audio Endpoint Volume Channels - - - - - Channel Count - - - - - Indexer - get a specific channel - - - - - Audio Endpoint Volume Notifiaction Delegate - - Audio Volume Notification Data - - - - Audio Endpoint Volume Step Information - - - - - Step - - - - - StepCount - - - - - Audio Endpoint Volume Volume Range - - - - - Minimum Decibels - - - - - Maximum Decibels - - - - - Increment Decibels - - - - - Audio Meter Information - - - - - Peak Values - - - - - Hardware Support - - - - - Master Peak Value - - - - - Audio Meter Information Channels - - - - - Metering Channel Count - - - - - Get Peak value - - Channel index - Peak value - - - - Audio Render Client - - - - - Gets a pointer to the buffer - - Number of frames requested - Pointer to the buffer - - - - Release buffer - - Number of frames written - Buffer flags - - - - Release the COM object - - - - - AudioSessionControl object for information - regarding an audio session - - - - - Constructor. - - - - - - Dispose - - - - - Finalizer - - - - - Audio meter information of the audio session. - - - - - Simple audio volume of the audio session (for volume and mute status). - - - - - The current state of the audio session. - - - - - The name of the audio session. - - - - - the path to the icon shown in the mixer. - - - - - The session identifier of the audio session. - - - - - The session instance identifier of the audio session. - - - - - The process identifier of the audio session. - - - - - Is the session a system sounds session. - - - - - the grouping param for an audio session grouping - - - - - - For chanigng the grouping param and supplying the context of said change - - - - - - - Registers an even client for callbacks - - - - - - Unregisters an event client from receiving callbacks - - - - - - AudioSessionEvents callback implementation - - - - - Constructor. - - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - AudioSessionManager - - Designed to manage audio sessions and in particuar the - SimpleAudioVolume interface to adjust a session volume - - - - - Session created delegate - - - - - Occurs when audio session has been added (for example run another program that use audio playback). - - - - - SimpleAudioVolume object - for adjusting the volume for the user session - - - - - AudioSessionControl object - for registring for callbacks and other session information - - - - - Refresh session of current device. - - - - - Returns list of sessions of current device. - - - - - Dispose. - - - - - Finalizer. - - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Manages the AudioStreamVolume for the . - - - - - Verify that the channel index is valid. - - - - - - - Return the current stream volumes for all channels - - An array of volume levels between 0.0 and 1.0 for each channel in the audio stream. - - - - Returns the current number of channels in this audio stream. - - - - - Return the current volume for the requested channel. - - The 0 based index into the channels. - The volume level for the channel between 0.0 and 1.0. - - - - Set the volume level for each channel of the audio stream. - - An array of volume levels (between 0.0 and 1.0) one for each channel. - - A volume level MUST be supplied for reach channel in the audio stream. - - - Thrown when does not contain elements. - - - - - Sets the volume level for one channel in the audio stream. - - The 0-based index into the channels to adjust the volume of. - The volume level between 0.0 and 1.0 for this channel of the audio stream. - - - - Dispose - - - - - Release/cleanup objects during Dispose/finalization. - - True if disposing and false if being finalized. - - - - Audio Volume Notification Data - - - - - Event Context - - - - - Muted - - - - - Guid that raised the event - - - - - Master Volume - - - - - Channels - - - - - Channel Volume - - - - - Audio Volume Notification Data - - - - - - - - - - Connector - - - - - Connects this connector to a connector in another device-topology object - - - - - Retreives the type of this connector - - - - - Retreives the data flow of this connector - - - - - Disconnects this connector from it's connected connector (if connected) - - - - - Indicates whether this connector is connected to another connector - - - - - Retreives the connector this connector is connected to (if connected) - - - - - Retreives the global ID of the connector this connector is connected to (if connected) - - - - - Retreives the device ID of the audio device this connector is connected to (if connected) - - - - - Connector Type - - - - - The connector is part of a connection of unknown type. - - - - - The connector is part of a physical connection to an auxiliary device that is installed inside the system chassis - - - - - The connector is part of a physical connection to an external device. - - - - - The connector is part of a software-configured I/O connection (typically a DMA channel) between system memory and an audio hardware device on an audio adapter. - - - - - The connector is part of a permanent connection that is fixed and cannot be configured under software control. - - - - - The connector is part of a connection to a network. - - - - - The EDataFlow enumeration defines constants that indicate the direction - in which audio data flows between an audio endpoint device and an application - - - - - Audio rendering stream. - Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, - to the application - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio - endpoint device, or from the audio endpoint device to the application. - - - - - Device State - - - - - DEVICE_STATE_ACTIVE - - - - - DEVICE_STATE_DISABLED - - - - - DEVICE_STATE_NOTPRESENT - - - - - DEVICE_STATE_UNPLUGGED - - - - - DEVICE_STATEMASK_ALL - - - - - Windows CoreAudio DeviceTopology - - - - - Retrieves the number of connections associated with this device-topology object - - - - - Retrieves the connector at the supplied index - - - - - Retrieves the device id of the device represented by this device-topology object - - - - - Endpoint Hardware Support - - - - - Volume - - - - - Mute - - - - - Meter - - - - - Representation of binary large object container. - - - - - Length of binary object. - - - - - Pointer to buffer storing data. - - - - - is defined in WTypes.h - - - - - Audio Client WASAPI Error Codes (HResult) - - - - - AUDCLNT_E_NOT_INITIALIZED - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_IN_USE - - - - - AUDCLNT_E_RESOURCES_INVALIDATED - - - - - Windows CoreAudio IAudioClient interface - Defined in AudioClient.h - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - Defined in AudioClient.h - - - - - Defined in AudioClient.h - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier for the audio session. - - Receives the session identifier. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier of the audio session instance. - - Receives the identifier of a particular instance. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the process identifier of the audio session. - - Receives the process identifier of the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Indicates whether the session is a system sounds session. - - An HRESULT code indicating whether the operation succeeded of failed. - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Defines constants that indicate the current state of an audio session. - - - MSDN Reference: http://msdn.microsoft.com/en-us/library/dd370792.aspx - - - - - The audio session is inactive. - - - - - The audio session is active. - - - - - The audio session has expired. - - - - - Defines constants that indicate a reason for an audio session being disconnected. - - - MSDN Reference: Unknown - - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the WTS session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - interface to receive session related events - - - - - notification of volume changes including muting of audio session - - the current volume - the current mute state, true muted, false otherwise - - - - notification of display name changed - - the current display name - - - - notification of icon path changed - - the current icon path - - - - notification of the client that the volume level of an audio channel in the session submix has changed - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - - - - notification of the client that the grouping parameter for the session has changed - - >The new grouping parameter for the session. - - - - notification of the client that the stream-activity state of the session has changed - - The new session state. - - - - notification of the client that the session has been disconnected - - The reason that the audio session was disconnected. - - - - Windows CoreAudio IAudioSessionManager interface - Defined in AudioPolicy.h - - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionNotification interface - Defined in AudioPolicy.h - - - - - - - session being added - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IConnector interface - Defined in devicetopology.h - - - - - Windows CoreAudio IDeviceTopology interface - Defined in devicetopology.h - - - - - defined in MMDeviceAPI.h - - - - - IMMNotificationClient - - - - - Device State Changed - - - - - Device Added - - - - - Device Removed - - - - - Default Device Changed - - - - - Property Value Changed - - - - - - - Windows CoreAudio IPart interface - Defined in devicetopology.h - - - - - Windows CoreAudio IPartsList interface - Defined in devicetopology.h - - - - - is defined in propsys.h - - - - - Windows CoreAudio ISimpleAudioVolume interface - Defined in AudioClient.h - - - - - Sets the master volume level for the audio session. - - The new volume level expressed as a normalized value between 0.0 and 1.0. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the client volume level for the audio session. - - Receives the volume level expressed as a normalized value between 0.0 and 1.0. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Sets the muting state for the audio session. - - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the current muting state for the audio session. - - Receives the muting state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - implements IMMDeviceEnumerator - - - - - MMDevice STGM enumeration - - - - - Read-only access mode. - - - - - Write-only access mode. - - - - - Read-write access mode. - - - - - from Propidl.h. - http://msdn.microsoft.com/en-us/library/aa380072(VS.85).aspx - contains a union so we have to do an explicit layout - - - - - Value type tag. - - - - - Reserved1. - - - - - Reserved2. - - - - - Reserved3. - - - - - cVal. - - - - - bVal. - - - - - iVal. - - - - - uiVal. - - - - - lVal. - - - - - ulVal. - - - - - intVal. - - - - - uintVal. - - - - - hVal. - - - - - uhVal. - - - - - fltVal. - - - - - dblVal. - - - - - boolVal. - - - - - scode. - - - - - Date time. - - - - - Binary large object. - - - - - Pointer value. - - - - - Creates a new PropVariant containing a long value - - - - - Helper method to gets blob data - - - - - Interprets a blob as an array of structs - - - - - Gets the type of data in this PropVariant - - - - - Property value - - - - - allows freeing up memory, might turn this into a Dispose method? - - - - - Clears with a known pointer - - - - - MM Device - - - - - Initializes the device's property store. - - The storage-access mode to open store for. - Administrative client is required for Write and ReadWrite modes. - - - - Audio Client - Makes a new one each call to allow caller to manage when to dispose - n.b. should probably not be a property anymore - - - - - Audio Meter Information - - - - - Audio Endpoint Volume - - - - - AudioSessionManager instance - - - - - DeviceTopology instance - - - - - Properties - - - - - Friendly name for the endpoint - - - - - Friendly name of device - - - - - Icon path of device - - - - - Device Instance Id of Device - - - - - Device ID - - - - - Data Flow - - - - - Device State - - - - - To string - - - - - Dispose - - - - - Finalizer - - - - - Multimedia Device Collection - - - - - Device count - - - - - Get device by index - - Device index - Device at the specified index - - - - Get Enumerator - - Device enumerator - - - - MM Device Enumerator - - - - - Creates a new MM Device Enumerator - - - - - Enumerate Audio Endpoints - - Desired DataFlow - State Mask - Device Collection - - - - Get Default Endpoint - - Data Flow - Role - Device - - - - Check to see if a default audio end point exists without needing an exception. - - Data Flow - Role - True if one exists, and false if one does not exist. - - - - Get device by ID - - Device ID - Device - - - - Registers a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - Unregisters a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - - - - Called to dispose/finalize contained objects. - - True if disposing, false if called from a finalizer. - - - - PROPERTYKEY is defined in wtypes.h - - - - - Format ID - - - - - Property ID - - - - - - - - - - - Property Keys - - - - - PKEY_DeviceInterface_FriendlyName - - - - - PKEY_AudioEndpoint_FormFactor - - - - - PKEY_AudioEndpoint_ControlPanelPageProvider - - - - - PKEY_AudioEndpoint_Association - - - - - PKEY_AudioEndpoint_PhysicalSpeakers - - - - - PKEY_AudioEndpoint_GUID - - - - - PKEY_AudioEndpoint_Disable_SysFx - - - - - PKEY_AudioEndpoint_FullRangeSpeakers - - - - - PKEY_AudioEndpoint_Supports_EventDriven_Mode - - - - - PKEY_AudioEndpoint_JackSubType - - - - - PKEY_AudioEngine_DeviceFormat - - - - - PKEY_AudioEngine_OEMFormat - - - - - PKEY _Devie_FriendlyName - - - - - PKEY _Device_IconPath - - - - - Device description property. - - - - - Id of controller device for endpoint device property. - - - - - Device interface key property. - - - - - System-supplied device instance identification string, assigned by PnP manager, persistent across system restarts. - - - - - Property Store class, only supports reading properties at the moment. - - - - - Property Count - - - - - Gets property by index - - Property index - The property - - - - Contains property guid - - Looks for a specific key - True if found - - - - Indexer by guid - - Property Key - Property or null if not found - - - - Gets property key at sepecified index - - Index - Property key - - - - Gets property value at specified index - - Index - Property value - - - - Sets property value at specified key. - - Key of property to set. - Value to write. - - - - Saves a property change. - - - - - Creates a new property store - - IPropertyStore COM interface - - - - Property Store Property - - - - - Property Key - - - - - Property Value - - - - - The ERole enumeration defines constants that indicate the role - that the system has assigned to an audio endpoint device - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording - - - - - Voice communications (talking to another person). - - - - - Collection of sessions. - - - - - Returns session at index. - - - - - - - Number of current sessions. - - - - - Windows CoreAudio SimpleAudioVolume - - - - - Creates a new Audio endpoint volume - - ISimpleAudioVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Allows the user to adjust the volume from - 0.0 to 1.0 - - - - - Mute - - - - - Represents state of a capture device - - - - - Not recording - - - - - Beginning to record - - - - - Recording in progress - - - - - Requesting stop - - - - - Audio Capture using Wasapi - See http://msdn.microsoft.com/en-us/library/dd370800%28VS.85%29.aspx - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - Length of the audio buffer in milliseconds. A lower value means lower latency but increased CPU usage. - - - - Share Mode - set before calling StartRecording - - - - - Current Capturing State - - - - - Capturing wave format - - - - - Gets the default audio capture device - - The default audio capture device - - - - To allow overrides to specify different flags (e.g. loopback) - - - - - Start Capturing - - - - - Stop Capturing (requests a stop, wait for RecordingStopped event to know it has finished) - - - - - Dispose - - - - - Contains the name and CLSID of a DirectX Media Object - - - - - Name - - - - - CLSID - - - - - Initializes a new instance of DmoDescriptor - - - - - DirectX Media Object Enumerator - - - - - Get audio effect names - - Audio effect names - - - - Get audio encoder names - - Audio encoder names - - - - Get audio decoder names - - Audio decoder names - - - - DMO Guids for use with DMOEnum - dmoreg.h - - - - - MediaErr.h - - - - - DMO Inplace Process Flags - - - - - DMO_INPLACE_NORMAL - - - - - DMO_INPLACE_ZERO - - - - - Return value when Process is executed with IMediaObjectInPlace - - - - - Success. There is no remaining data to process. - - - - - Success. There is still data to process. - - - - - DMO Input Data Buffer Flags - - - - - None - - - - - DMO_INPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_INPUT_DATA_BUFFERF_TIME - - - - - DMO_INPUT_DATA_BUFFERF_TIMELENGTH - - - - - http://msdn.microsoft.com/en-us/library/aa929922.aspx - DMO_MEDIA_TYPE - - - - - Major type - - - - - Major type name - - - - - Subtype - - - - - Subtype name - - - - - Fixed size samples - - - - - Sample size - - - - - Format type - - - - - Format type name - - - - - Gets the structure as a Wave format (if it is one) - - - - - Sets this object up to point to a wave format - - Wave format structure - - - - DMO Output Data Buffer - - - - - Creates a new DMO Output Data Buffer structure - - Maximum buffer size - - - - Dispose - - - - - Media Buffer - - - - - Length of data in buffer - - - - - Status Flags - - - - - Timestamp - - - - - Duration - - - - - Retrives the data in this buffer - - Buffer to receive data - Offset into buffer - - - - Is more data available - If true, ProcessOuput should be called again - - - - - DMO Output Data Buffer Flags - - - - - None - - - - - DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_OUTPUT_DATA_BUFFERF_TIME - - - - - DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH - - - - - DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE - - - - - DMO_PARTIAL_MEDIATYPE - - - - - DMO Process Output Flags - - - - - None - - - - - DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER - - - - - Chorus Phase - - - - - DSFXCHORUS_PHASE_NEG_180 - - - - - DSFXCHORUS_PHASE_NEG_90 - - - - - DSFXCHORUS_PHASE_ZERO - - - - - DSFXCHORUS_PHASE_90 - - - - - DSFXCHORUS_PHASE_180 - - - - - Chorus Wave Form - - - - - DSFXCHORUS_WAVE_TRIANGLE - - - - - DSFXCHORUS_WAVE_SIN - - - - - DMO Chorus Effect - - - - - DMO Chorus Params - - - - - DSFXCHORUS_WETDRYMIX_MIN - - - - - DSFXCHORUS_WETDRYMIX_MAX - - - - - DSFXCHORUS_WETDRYMIX_DEFAULT - - - - - DSFXCHORUS_DEPTH_MIN - - - - - DSFXCHORUS_DEPTH_MAX - - - - - DSFXCHORUS_DEPTH_DEFAULT - - - - - DSFXCHORUS_FEEDBACK_MIN - - - - - DSFXCHORUS_FEEDBACK_MAX - - - - - DSFXCHORUS_FEEDBACK_DEFAULT - - - - - DSFXCHORUS_FREQUENCY_MIN - - - - - DSFXCHORUS_FREQUENCY_MAX - - - - - DSFXCHORUS_FREQUENCY_DEFAULT - - - - - DSFXCHORUS_WAVE_DEFAULT - - - - - DSFXCHORUS_DELAY_MIN - - - - - DSFXCHORUS_DELAY_MAX - - - - - DSFXCHORUS_DELAY_DEFAULT - - - - - DSFXCHORUS_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Chorus - - - - - Dispose code - - - - - DMO Compressor Effect - - - - - DMO Compressor Params - - - - - DSFXCOMPRESSOR_GAIN_MIN - - - - - DSFXCOMPRESSOR_GAIN_MAX - - - - - DSFXCOMPRESSOR_GAIN_DEFAULT - - - - - DSFXCOMPRESSOR_ATTACK_MIN - - - - - DSFXCOMPRESSOR_ATTACK_MAX - - - - - DSFXCOMPRESSOR_ATTACK_DEFAULT - - - - - DSFXCOMPRESSOR_RELEASE_MIN - - - - - DSFXCOMPRESSOR_RELEASE_MAX - - - - - DSFXCOMPRESSOR_RELEASE_DEFAULT - - - - - DSFXCOMPRESSOR_THRESHOLD_MIN - - - - - DSFXCOMPRESSOR_THRESHOLD_MAX - - - - - DSFXCOMPRESSOR_THRESHOLD_DEFAULT - - - - - DSFXCOMPRESSOR_RATIO_MIN - - - - - DSFXCOMPRESSOR_RATIO_MAX - - - - - DSFXCOMPRESSOR_RATIO_DEFAULT - - - - - DSFXCOMPRESSOR_PREDELAY_MIN - - - - - DSFXCOMPRESSOR_PREDELAY_MAX - - - - - DSFXCOMPRESSOR_PREDELAY_DEFAULT - - - - - Output gain of signal after compression. - - - - - Time before compression reaches its full value. - - - - - Speed at which compression is stopped after input drops below Threshold. - - - - - Point at which compression begins, in decibels. - - - - - Compression ratio - - - - - Time after Threshold is reached before attack phase is started, in milliseconds. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Compressor - - - - - Dispose code - - - - - DMO Distortion Effect - - - - - DMO Distortion Params - - - - - DSFXDISTORTION_GAIN_MIN - - - - - DSFXDISTORTION_GAIN_MAX - - - - - DSFXDISTORTION_GAIN_DEFAULT - - - - - DSFXDISTORTION_EDGE_MIN - - - - - DSFXDISTORTION_EDGE_MAX - - - - - DSFXDISTORTION_EDGE_DEFAULT - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MIN - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MAX - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_DEFAULT - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MIN - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MAX - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_DEFAULT - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MIN - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MAX - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_DEFAULT - - - - - Amount of signal change after distortion. - - - - - Percentage of distortion intensity. - - - - - Center frequency of harmonic content addition. - - - - - Width of frequency band that determines range of harmonic content addition. - - - - - Filter cutoff for high-frequency harmonics attenuation. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Distortion - - - - - Dispose code - - - - - Dmo Echo Effect - - - - - DMO Echo Params - - - - - DSFXECHO_WETDRYMIX_MIN - - - - - DSFXECHO_WETDRYMIX_MAX - - - - - DSFXECHO_WETDRYMIX_DEFAULT - - - - - DSFXECHO_FEEDBACK_MIN - - - - - DSFXECHO_FEEDBACK_MAX - - - - - DSFXECHO_FEEDBACK_DEFAULT - - - - - DSFXECHO_LEFTDELAY_MIN - - - - - DSFXECHO_LEFTDELAY_MAX - - - - - DSFXECHO_LEFTDELAY_DEFAULT - - - - - DSFXECHO_RIGHTDELAY_MIN - - - - - DSFXECHO_RIGHTDELAY_MAX - - - - - DSFXECHO_RIGHTDELAY_DEFAULT - - - - - DSFXECHO_PANDELAY_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage of output fed back into input. - - - - - Delay for left channel, in milliseconds. - - - - - Delay for right channel, in milliseconds. - - - - - Value that specifies whether to swap left and right delays with each successive echo. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Echo - - - - - Dispose code - - - - - DMO Flanger Effect - - - - - DMO Flanger Params - - - - - DSFXFLANGER_WETDRYMIX_MIN - - - - - DSFXFLANGER_WETDRYMIX_MAX - - - - - DSFXFLANGER_WETDRYMIX_DEFAULT - - - - - DSFXFLANGER_DEPTH_MIN - - - - - DSFXFLANGER_DEPTH_MAX - - - - - DSFXFLANGER_DEPTH_DEFAULT - - - - - DSFXFLANGER_FEEDBACK_MIN - - - - - DSFXFLANGER_FEEDBACK_MAX - - - - - DSFXFLANGER_FEEDBACK_DEFAULT - - - - - DSFXFLANGER_FREQUENCY_MIN - - - - - DSFXFLANGER_FREQUENCY_MAX - - - - - DSFXFLANGER_FREQUENCY_DEFAULT - - - - - DSFXFLANGER_WAVE_DEFAULT - - - - - DSFXFLANGER_DELAY_MIN - - - - - DSFXFLANGER_DELAY_MAX - - - - - DSFXFLANGER_DELAY_DEFAULT - - - - - DSFXFLANGER_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Flanger - - - - - Dispose code - - - - - DMO Gargle Effect - - - - - DMO Gargle Params - - - - - DSFXGARGLE_RATEHZ_MIN - - - - - DSFXGARGLE_RATEHZ_MAX - - - - - DSFXGARGLE_RATEHZ_DEFAULT - - - - - DSFXGARGLE_WAVE_DEFAULT - - - - - Rate of modulation in hz - - - - - Gargle Wave Shape - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Gargle - - - - - Dispose code - - - - - DMO I3DL2Reverb Effect - - - - - DMO I3DL2Reverb Params - - - - - DSFX_I3DL2REVERB_ROOM_MIN - - - - - DSFX_I3DL2REVERB_ROOM_MAX - - - - - DSFX_I3DL2REVERB_ROOM_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMHF_MIN - - - - - DSFX_I3DL2REVERB_ROOMHF_MAX - - - - - DSFX_I3DL2REVERB_ROOMHF_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MIN - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MAX - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYTIME_MIN - - - - - DSFX_I3DL2REVERB_DECAYTIME_MAX - - - - - DSFX_I3DL2REVERB_DECAYTIME_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MIN - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MAX - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONS_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERB_MIN - - - - - DSFX_I3DL2REVERB_REVERB_MAX - - - - - DSFX_I3DL2REVERB_REVERB_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MIN - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MAX - - - - - DSFX_I3DL2REVERB_REVERBDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_DIFFUSION_MIN - - - - - DSFX_I3DL2REVERB_DIFFUSION_MAX - - - - - DSFX_I3DL2REVERB_DIFFUSION_DEFAULT - - - - - DSFX_I3DL2REVERB_DENSITY_MIN - - - - - DSFX_I3DL2REVERB_DENSITY_MAX - - - - - DSFX_I3DL2REVERB_DENSITY_DEFAULT - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MIN - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MAX - - - - - DSFX_I3DL2REVERB_HFREFERENCE_DEFAULT - - - - - DSFX_I3DL2REVERB_QUALITY_MIN - - - - - DSFX_I3DL2REVERB_QUALITY_MAX - - - - - DSFX_I3DL2REVERB_QUALITY_DEFAULT - - - - - Attenuation of the room effect, in millibels (mB) - - - - - Attenuation of the room high-frequency effect, in mB. - - - - - Rolloff factor for the reflected signals. - - - - - Decay time, in seconds. - - - - - Ratio of the decay time at high frequencies to the decay time at low frequencies. - - - - - Attenuation of early reflections relative to lRoom, in mB. - - - - - Delay time of the first reflection relative to the direct path, in seconds. - - - - - Attenuation of late reverberation relative to lRoom, in mB. - - - - - Time limit between the early reflections and the late reverberation relative to the time of the first reflection. - - - - - Echo density in the late reverberation decay, in percent. - - - - - Modal density in the late reverberation decay, in percent. - - - - - Reference high frequency, in hertz. - - - - - the quality of the environmental reverberation effect. Higher values produce better quality at the expense of processing time. - - - - - Sets standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - retrieves an identifier for standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO I3DL2Reverb - - - - - Dispose code - - - - - DMO Parametric Equalizer Effect - - - - - DMO ParamEq Params - - - - - DSFXPARAMEQ_CENTER_MIN - - - - - DSFXPARAMEQ_CENTER_MAX - - - - - DSFXPARAMEQ_CENTER_DEFAULT - - - - - DSFXPARAMEQ_BANDWIDTH_MIN - - - - - DSFXPARAMEQ_BANDWIDTH_MAX - - - - - DSFXPARAMEQ_BANDWIDTH_DEFAULT - - - - - DSFXPARAMEQ_GAIN_MIN - - - - - DSFXPARAMEQ_GAIN_MAX - - - - - DSFXPARAMEQ_GAIN_DEFAULT - - - - - Center frequency, in hertz - - - - - Bandwidth, in semitones. - - - - - Gain - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO ParamEq - - - - - Dispose code - - - - - DMO Reverb Effect - - - - - DMO Reverb Params - - - - - DSFX_WAVESREVERB_INGAIN_MIN - - - - - DSFX_WAVESREVERB_INGAIN_MAX - - - - - DSFX_WAVESREVERB_INGAIN_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBMIX_MIN - - - - - DSFX_WAVESREVERB_REVERBMIX_MAX - - - - - DSFX_WAVESREVERB_REVERBMIX_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBTIME_MIN - - - - - DSFX_WAVESREVERB_REVERBTIME_MAX - - - - - DSFX_WAVESREVERB_REVERBTIME_DEFAULT - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MIN - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MAX - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_DEFAULT - - - - - Input gain of signal, in decibels (dB). - - - - - Reverb mix, in dB. - - - - - Reverb time, in milliseconds. - - - - - High-frequency reverb time ratio. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO WavesReverb - - - - - Dispose code - - - - - DSFXECHO_PANDELAY - - - - - DSFXECHO_PANDELAY_MIN - - - - - DSFXECHO_PANDELAY_MAX - - - - - Flanger Phase - - - - - DSFXFLANGER_PHASE_NEG_180 - - - - - DSFXFLANGER_PHASE_NEG_90 - - - - - DSFXFLANGER_PHASE_ZERO - - - - - DSFXFLANGER_PHASE_90 - - - - - DSFXFLANGER_PHASE_180 - - - - - Flanger Wave Form - - - - - DSFXFLANGER_WAVE_TRIANGLE - - - - - DSFXFLANGER_WAVE_SIN - - - - - Gargle Wave Shape - - - - - DSFXGARGLE_WAVE_TRIANGLE - - - - - DSFXGARGLE_WAVE_SQUARE - - - - - I3DL2 Reverberation Presets - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CITY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE - - - - - Interface of DMO Effectors - - Parameters of the effect to be used - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - IMediaBuffer Interface - - - - - Set Length - - Length - HRESULT - - - - Get Max Length - - Max Length - HRESULT - - - - Get Buffer and Length - - Pointer to variable into which to write the Buffer Pointer - Pointer to variable into which to write the Valid Data Length - HRESULT - - - - defined in mediaobj.h - - - - - defined in mediaobj.h - - - - - defined in Medparam.h - - - - - Windows Media Resampler Props - wmcodecdsp.h - - - - - Range is 1 to 60 - - - - - Specifies the channel matrix. - - - - - Attempting to implement the COM IMediaBuffer interface as a .NET object - Not sure what will happen when I pass this to an unmanaged object - - - - - Creates a new Media Buffer - - Maximum length in bytes - - - - Dispose and free memory for buffer - - - - - Finalizer - - - - - Set length of valid data in the buffer - - length - HRESULT - - - - Gets the maximum length of the buffer - - Max length (output parameter) - HRESULT - - - - Gets buffer and / or length - - Pointer to variable into which buffer pointer should be written - Pointer to variable into which valid data length should be written - HRESULT - - - - Length of data in the media buffer - - - - - Loads data into this buffer - - Data to load - Number of bytes to load - - - - Retrieves the data in the output buffer - - buffer to retrieve into - offset within that buffer - - - - Media Object - - - - - Creates a new Media Object - - Media Object COM interface - - - - Number of input streams - - - - - Number of output streams - - - - - Gets the input media type for the specified input stream - - Input stream index - Input type index - DMO Media Type or null if there are no more input types - - - - Gets the DMO Media Output type - - The output stream - Output type index - DMO Media Type or null if no more available - - - - retrieves the media type that was set for an output stream, if any - - Output stream index - DMO Media Type or null if no more available - - - - Enumerates the supported input types - - Input stream index - Enumeration of input types - - - - Enumerates the output types - - Output stream index - Enumeration of supported output types - - - - Querys whether a specified input type is supported - - Input stream index - Media type to check - true if supports - - - - Sets the input type helper method - - Input stream index - Media type - Flags (can be used to test rather than set) - - - - Sets the input type - - Input stream index - Media Type - - - - Sets the input type to the specified Wave format - - Input stream index - Wave format - - - - Requests whether the specified Wave format is supported as an input - - Input stream index - Wave format - true if supported - - - - Helper function to make a DMO Media Type to represent a particular WaveFormat - - - - - Checks if a specified output type is supported - n.b. you may need to set the input type first - - Output stream index - Media type - True if supported - - - - Tests if the specified Wave Format is supported for output - n.b. may need to set the input type first - - Output stream index - Wave format - True if supported - - - - Helper method to call SetOutputType - - - - - Sets the output type - n.b. may need to set the input type first - - Output stream index - Media type to set - - - - Set output type to the specified wave format - n.b. may need to set input type first - - Output stream index - Wave format - - - - Get Input Size Info - - Input Stream Index - Input Size Info - - - - Get Output Size Info - - Output Stream Index - Output Size Info - - - - Process Input - - Input Stream index - Media Buffer - Flags - Timestamp - Duration - - - - Process Output - - Flags - Output buffer count - Output buffers - - - - Gives the DMO a chance to allocate any resources needed for streaming - - - - - Tells the DMO to free any resources needed for streaming - - - - - Gets maximum input latency - - input stream index - Maximum input latency as a ref-time - - - - Flushes all buffered data - - - - - Report a discontinuity on the specified input stream - - Input Stream index - - - - Is this input stream accepting data? - - Input Stream index - true if accepting data - - - - Experimental code, not currently being called - Not sure if it is necessary anyway - - - - - Media Object InPlace - - - - - Creates a new Media Object InPlace - - Media Object InPlace COM Interface - - - - Processes a block of data. - The application supplies a pointer to a block of input data. The DMO processes the data in place. - - Size of the data, in bytes. - offset into buffer - In/Out Data Buffer - Start time of the data. - DmoInplaceProcessFlags - Return value when Process is executed with IMediaObjectInPlace - - - - Creates a copy of the DMO in its current state. - - Copyed MediaObjectInPlace - - - - Retrieves the latency introduced by this DMO. - - The latency, in 100-nanosecond units - - - - Get Media Object - - Media Object - - - - Dispose code - - - - - Media Object Size Info - - - - - Minimum Buffer Size, in bytes - - - - - Max Lookahead - - - - - Alignment - - - - - Media Object Size Info - - - - - ToString - - - - - MP_PARAMINFO - - - - - MP_TYPE - - - - - MPT_INT - - - - - MPT_FLOAT - - - - - MPT_BOOL - - - - - MPT_ENUM - - - - - MPT_MAX - - - - - MP_CURVE_TYPE - - - - - uuids.h, ksuuids.h - - - - - From wmcodecsdp.h - Implements: - - IMediaObject - - IMFTransform (Media foundation - we will leave this for now as there is loads of MF stuff) - - IPropertyStore - - IWMResamplerProps - Can resample PCM or IEEE - - - - - DMO Resampler - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - implements IMediaObject (DirectX Media Object) - implements IMFTransform (Media Foundation Transform) - On Windows XP, it is always an MM (if present at all) - - - - - Windows Media MP3 Decoder (as a DMO) - WORK IN PROGRESS - DO NOT USE! - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - BiQuad filter - - - - - Passes a single sample through the filter - - Input sample - Output sample - - - - Set this up as a low pass filter - - Sample Rate - Cut-off Frequency - Bandwidth - - - - Set this up as a peaking EQ - - Sample Rate - Centre Frequency - Bandwidth (Q) - Gain in decibels - - - - Set this as a high pass filter - - - - - Create a low pass filter - - - - - Create a High pass filter - - - - - Create a bandpass filter with constant skirt gain - - - - - Create a bandpass filter with constant peak gain - - - - - Creates a notch filter - - - - - Creaes an all pass filter - - - - - Create a Peaking EQ - - - - - H(s) = A * (s^2 + (sqrt(A)/Q)*s + A)/(A*s^2 + (sqrt(A)/Q)*s + 1) - - - - a "shelf slope" parameter (for shelving EQ only). - When S = 1, the shelf slope is as steep as it can be and remain monotonically - increasing or decreasing gain with frequency. The shelf slope, in dB/octave, - remains proportional to S for all other values for a fixed f0/Fs and dBgain. - Gain in decibels - - - - H(s) = A * (A*s^2 + (sqrt(A)/Q)*s + 1)/(s^2 + (sqrt(A)/Q)*s + A) - - - - - - - - - - Type to represent complex number - - - - - Real Part - - - - - Imaginary Part - - - - - Envelope generator (ADSR) - - - - - Envelope State - - - - - Idle - - - - - Attack - - - - - Decay - - - - - Sustain - - - - - Release - - - - - Creates and Initializes an Envelope Generator - - - - - Attack Rate (seconds * SamplesPerSecond) - - - - - Decay Rate (seconds * SamplesPerSecond) - - - - - Release Rate (seconds * SamplesPerSecond) - - - - - Sustain Level (1 = 100%) - - - - - Sets the attack curve - - - - - Sets the decay release curve - - - - - Read the next volume multiplier from the envelope generator - - A volume multiplier - - - - Trigger the gate - - If true, enter attack phase, if false enter release phase (unless already idle) - - - - Current envelope state - - - - - Reset to idle state - - - - - Get the current output level - - - - - Summary description for FastFourierTransform. - - - - - This computes an in-place complex-to-complex FFT - x and y are the real and imaginary arrays of 2^m points. - - - - - Applies a Hamming Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hamming window - - - - Applies a Hann Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hann window - - - - Applies a Blackman-Harris Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Blackmann-Harris window - - - - Summary description for ImpulseResponseConvolution. - - - - - A very simple mono convolution algorithm - - - This will be very slow - - - - - This is actually a downwards normalize for data that will clip - - - - - SMB Pitch Shifter - - - - - Pitch Shift - - - - - Pitch Shift - - - - - Short Time Fourier Transform - - - - - Fully managed resampler, based on Cockos WDL Resampler - - - - - Creates a new Resampler - - - - - sets the mode - if sinc set, it overrides interp or filtercnt - - - - - Sets the filter parameters - used for filtercnt>0 but not sinc - - - - - Set feed mode - - if true, that means the first parameter to ResamplePrepare will specify however much input you have, not how much you want - - - - Reset - - - - - Prepare - note that it is safe to call ResamplePrepare without calling ResampleOut (the next call of ResamplePrepare will function as normal) - nb inbuffer was WDL_ResampleSample **, returning a place to put the in buffer, so we return a buffer and offset - - req_samples is output samples desired if !wantInputDriven, or if wantInputDriven is input samples that we have - - - - returns number of samples desired (put these into *inbuffer) - - - - Channel Mode - - - - - Stereo - - - - - Joint Stereo - - - - - Dual Channel - - - - - Mono - - - - - An ID3v2 Tag - - - - - Reads an ID3v2 tag from a stream - - - - - Creates a new ID3v2 tag from a collection of key-value pairs. - - A collection of key-value pairs containing the tags to include in the ID3v2 tag. - A new ID3v2 tag - - - - Convert the frame size to a byte array. - - The frame body size. - - - - - Creates an ID3v2 frame for the given key-value pair. - - - - - - - - Gets the Id3v2 Header size. The size is encoded so that only 7 bits per byte are actually used. - - - - - - - Creates the Id3v2 tag header and returns is as a byte array. - - The Id3v2 frames that will be included in the file. This is used to calculate the ID3v2 tag size. - - - - - Creates the Id3v2 tag for the given key-value pairs and returns it in the a stream. - - - - - - - Raw data from this tag - - - - - Interface for MP3 frame by frame decoder - - - - - Decompress a single MP3 frame - - Frame to decompress - Output buffer - Offset within output buffer - Bytes written to output buffer - - - - Tell the decoder that we have repositioned - - - - - PCM format that we are converting into - - - - - Represents an MP3 Frame - - - - - Reads an MP3 frame from a stream - - input stream - A valid MP3 frame, or null if none found - - - Reads an MP3Frame from a stream - http://mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm has some good info - also see http://www.codeproject.com/KB/audio-video/mpegaudioinfo.aspx - - A valid MP3 frame, or null if none found - - - - Constructs an MP3 frame - - - - - checks if the four bytes represent a valid header, - if they are, will parse the values into Mp3Frame - - - - - Sample rate of this frame - - - - - Frame length in bytes - - - - - Bit Rate - - - - - Raw frame data (includes header bytes) - - - - - MPEG Version - - - - - MPEG Layer - - - - - Channel Mode - - - - - The number of samples in this frame - - - - - The channel extension bits - - - - - The bitrate index (directly from the header) - - - - - Whether the Copyright bit is set - - - - - Whether a CRC is present - - - - - Not part of the MP3 frame itself - indicates where in the stream we found this header - - - - - MP3 Frame Decompressor using ACM - - - - - Creates a new ACM frame decompressor - - The MP3 source format - - - - Output format (PCM) - - - - - Decompresses a frame - - The MP3 frame - destination buffer - Offset within destination buffer - Bytes written into destination buffer - - - - Resets the MP3 Frame Decompressor after a reposition operation - - - - - Disposes of this MP3 frame decompressor - - - - - Finalizer ensuring that resources get released properly - - - - - MPEG Layer flags - - - - - Reserved - - - - - Layer 3 - - - - - Layer 2 - - - - - Layer 1 - - - - - MPEG Version Flags - - - - - Version 2.5 - - - - - Reserved - - - - - Version 2 - - - - - Version 1 - - - - - Represents a Xing VBR header - - - - - Load Xing Header - - Frame - Xing Header - - - - Sees if a frame contains a Xing header - - - - - Number of frames - - - - - Number of bytes - - - - - VBR Scale property - - - - - The MP3 frame - - - - - ASIO 64 bit value - Unfortunately the ASIO API was implemented it before compiler supported consistently 64 bit - integer types. By using the structure the data layout on a little-endian system like the - Intel x86 architecture will result in a "non native" storage of the 64 bit data. The most - significant 32 bit are stored first in memory, the least significant bits are stored in the - higher memory space. However each 32 bit is stored in the native little-endian fashion - - - - - most significant bits (Bits 32..63) - - - - - least significant bits (Bits 0..31) - - - - - ASIO Callbacks - - - - - ASIO Buffer Switch Callback - - - - - ASIO Sample Rate Did Change Callback - - - - - ASIO Message Callback - - - - - ASIO Buffer Switch Time Info Callback - - - - - Buffer switch callback - void (*bufferSwitch) (long doubleBufferIndex, AsioBool directProcess); - - - - - Sample Rate Changed callback - void (*sampleRateDidChange) (AsioSampleRate sRate); - - - - - ASIO Message callback - long (*asioMessage) (long selector, long value, void* message, double* opt); - - - - - ASIO Buffer Switch Time Info Callback - AsioTime* (*bufferSwitchTimeInfo) (AsioTime* params, long doubleBufferIndex, AsioBool directProcess); - - - - - ASIO Channel Info - - - - - on input, channel index - - - - - Is Input - - - - - Is Active - - - - - Channel Info - - - - - ASIO Sample Type - - - - - Name - - - - - Main AsioDriver Class. To use this class, you need to query first the GetAsioDriverNames() and - then use the GetAsioDriverByName to instantiate the correct AsioDriver. - This is the first AsioDriver binding fully implemented in C#! - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Gets the ASIO driver names installed. - - a list of driver names. Use this name to GetAsioDriverByName - - - - Instantiate a AsioDriver given its name. - - The name of the driver - an AsioDriver instance - - - - Instantiate the ASIO driver by GUID. - - The GUID. - an AsioDriver instance - - - - Inits the AsioDriver.. - - The sys handle. - - - - - Gets the name of the driver. - - - - - - Gets the driver version. - - - - - - Gets the error message. - - - - - - Starts this instance. - - - - - Stops this instance. - - - - - Gets the number of channels. - - The num input channels. - The num output channels. - - - - Gets the latencies (n.b. does not throw an exception) - - The input latency. - The output latency. - - - - Gets the size of the buffer. - - Size of the min. - Size of the max. - Size of the preferred. - The granularity. - - - - Determines whether this instance can use the specified sample rate. - - The sample rate. - - true if this instance [can sample rate] the specified sample rate; otherwise, false. - - - - - Gets the sample rate. - - - - - - Sets the sample rate. - - The sample rate. - - - - Gets the clock sources. - - The clocks. - The num sources. - - - - Sets the clock source. - - The reference. - - - - Gets the sample position. - - The sample pos. - The time stamp. - - - - Gets the channel info. - - The channel number. - if set to true [true for input info]. - Channel Info - - - - Creates the buffers. - - The buffer infos. - The num channels. - Size of the buffer. - The callbacks. - - - - Disposes the buffers. - - - - - Controls the panel. - - - - - Futures the specified selector. - - The selector. - The opt. - - - - Notifies OutputReady to the AsioDriver. - - - - - - Releases this instance. - - - - - Handles the exception. Throws an exception based on the error. - - The error to check. - Method name - - - - Inits the vTable method from GUID. This is a tricky part of this class. - - The ASIO GUID. - - - - Internal VTable structure to store all the delegates to the C++ COM method. - - - - - ASIODriverCapability holds all the information from the AsioDriver. - Use ASIODriverExt to get the Capabilities - - - - - Drive Name - - - - - Number of Input Channels - - - - - Number of Output Channels - - - - - Input Latency - - - - - Output Latency - - - - - Buffer Minimum Size - - - - - Buffer Maximum Size - - - - - Buffer Preferred Size - - - - - Buffer Granularity - - - - - Sample Rate - - - - - Input Channel Info - - - - - Output Channel Info - - - - - Callback used by the AsioDriverExt to get wave data - - - - - AsioDriverExt is a simplified version of the AsioDriver. It provides an easier - way to access the capabilities of the Driver and implement the callbacks necessary - for feeding the driver. - Implementation inspired from Rob Philpot's with a managed C++ ASIO wrapper BlueWave.Interop.Asio - http://www.codeproject.com/KB/mcpp/Asio.Net.aspx - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Initializes a new instance of the class based on an already - instantiated AsioDriver instance. - - A AsioDriver already instantiated. - - - - Allows adjustment of which is the first output channel we write to - - Output Channel offset - Input Channel offset - - - - Gets the driver used. - - The ASIOdriver. - - - - Starts playing the buffers. - - - - - Stops playing the buffers. - - - - - Shows the control panel. - - - - - Releases this instance. - - - - - Determines whether the specified sample rate is supported. - - The sample rate. - - true if [is sample rate supported]; otherwise, false. - - - - - Sets the sample rate. - - The sample rate. - - - - Gets or sets the fill buffer callback. - - The fill buffer callback. - - - - Gets the capabilities of the AsioDriver. - - The capabilities. - - - - Creates the buffers for playing. - - The number of outputs channels. - The number of input channel. - if set to true [use max buffer size] else use Prefered size - - - - Builds the capabilities internally. - - - - - Callback called by the AsioDriver on fill buffer demand. Redirect call to external callback. - - Index of the double buffer. - if set to true [direct process]. - - - - Callback called by the AsioDriver on event "Samples rate changed". - - The sample rate. - - - - Asio message call back. - - The selector. - The value. - The message. - The opt. - - - - - Buffers switch time info call back. - - The asio time param. - Index of the double buffer. - if set to true [direct process]. - - - - - ASIO Error Codes - - - - - This value will be returned whenever the call succeeded - - - - - unique success return value for ASIOFuture calls - - - - - hardware input or output is not present or available - - - - - hardware is malfunctioning (can be returned by any ASIO function) - - - - - input parameter invalid - - - - - hardware is in a bad mode or used in a bad mode - - - - - hardware is not running when sample position is inquired - - - - - sample clock or rate cannot be determined or is not present - - - - - not enough memory for completing the request - - - - - ASIO Message Selector - - - - - selector in <value>, returns 1L if supported, - - - - - returns engine (host) asio implementation version, - - - - - request driver reset. if accepted, this - - - - - not yet supported, will currently always return 0L. - - - - - the driver went out of sync, such that - - - - - the drivers latencies have changed. The engine - - - - - if host returns true here, it will expect the - - - - - supports timecode - - - - - unused - value: number of commands, message points to mmc commands - - - - - kAsioSupportsXXX return 1 if host supports this - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - driver detected an overload - - - - - This class stores convertors for different interleaved WaveFormat to ASIOSampleType separate channel - format. - - - - - Selects the sample convertor based on the input WaveFormat and the output ASIOSampleTtype. - - The wave format. - The type. - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor Float to INT - - - - - Optimized convertor for 2 channels INT to INT - - - - - Generic convertor INT to INT - - - - - Optimized convertor for 2 channels INT to SHORT - - - - - Generic convertor INT to SHORT - - - - - Generic convertor INT to FLOAT - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor SHORT - - - - - Generic converter 24 LSB - - - - - Generic convertor for float - - - - - ASIO Sample Type - - - - - Int 16 MSB - - - - - Int 24 MSB (used for 20 bits as well) - - - - - Int 32 MSB - - - - - IEEE 754 32 bit float - - - - - IEEE 754 64 bit double float - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - Int 16 LSB - - - - - Int 24 LSB - used for 20 bits as well - - - - - Int 32 LSB - - - - - IEEE 754 32 bit float, as found on Intel x86 architecture - - - - - IEEE 754 64 bit double float, as found on Intel x86 architecture - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - DSD 1 bit data, 8 samples per byte. First sample in Least significant bit. - - - - - DSD 1 bit data, 8 samples per byte. First sample in Most significant bit. - - - - - DSD 8 bit data, 1 sample per byte. No Endianness required. - - - - - ASIO common Exception. - - - - - Gets the name of the error. - - The error. - the name of the error - - - - Represents an installed ACM Driver - - - - - Helper function to determine whether a particular codec is installed - - The short name of the function - Whether the codec is installed - - - - Attempts to add a new ACM driver from a file - - Full path of the .acm or dll file containing the driver - Handle to the driver - - - - Removes a driver previously added using AddLocalDriver - - Local driver to remove - - - - Show Format Choose Dialog - - Owner window handle, can be null - Window title - Enumeration flags. None to get everything - Enumeration format. Only needed with certain enumeration flags - The selected format - Textual description of the selected format - Textual description of the selected format tag - True if a format was selected - - - - Gets the maximum size needed to store a WaveFormat for ACM interop functions - - - - - Finds a Driver by its short name - - Short Name - The driver, or null if not found - - - - Gets a list of the ACM Drivers installed - - - - - The callback for acmDriverEnum - - - - - Creates a new ACM Driver object - - Driver handle - - - - The short name of this driver - - - - - The full name of this driver - - - - - The driver ID - - - - - ToString - - - - - The list of FormatTags for this ACM Driver - - - - - Gets all the supported formats for a given format tag - - Format tag - Supported formats - - - - Opens this driver - - - - - Closes this driver - - - - - Dispose - - - - - Flags for use with acmDriverAdd - - - - - ACM_DRIVERADDF_LOCAL - - - - - ACM_DRIVERADDF_GLOBAL - - - - - ACM_DRIVERADDF_FUNCTION - - - - - ACM_DRIVERADDF_NOTIFYHWND - - - - - Interop structure for ACM driver details (ACMDRIVERDETAILS) - http://msdn.microsoft.com/en-us/library/dd742889%28VS.85%29.aspx - - - - - DWORD cbStruct - - - - - FOURCC fccType - - - - - FOURCC fccComp - - - - - WORD wMid; - - - - - WORD wPid - - - - - DWORD vdwACM - - - - - DWORD vdwDriver - - - - - DWORD fdwSupport; - - - - - DWORD cFormatTags - - - - - DWORD cFilterTags - - - - - HICON hicon - - - - - TCHAR szShortName[ACMDRIVERDETAILS_SHORTNAME_CHARS]; - - - - - TCHAR szLongName[ACMDRIVERDETAILS_LONGNAME_CHARS]; - - - - - TCHAR szCopyright[ACMDRIVERDETAILS_COPYRIGHT_CHARS]; - - - - - TCHAR szLicensing[ACMDRIVERDETAILS_LICENSING_CHARS]; - - - - - TCHAR szFeatures[ACMDRIVERDETAILS_FEATURES_CHARS]; - - - - - ACMDRIVERDETAILS_SHORTNAME_CHARS - - - - - ACMDRIVERDETAILS_LONGNAME_CHARS - - - - - ACMDRIVERDETAILS_COPYRIGHT_CHARS - - - - - ACMDRIVERDETAILS_LICENSING_CHARS - - - - - ACMDRIVERDETAILS_FEATURES_CHARS - - - - - Flags indicating what support a particular ACM driver has - - - - ACMDRIVERDETAILS_SUPPORTF_CODEC - Codec - - - ACMDRIVERDETAILS_SUPPORTF_CONVERTER - Converter - - - ACMDRIVERDETAILS_SUPPORTF_FILTER - Filter - - - ACMDRIVERDETAILS_SUPPORTF_HARDWARE - Hardware - - - ACMDRIVERDETAILS_SUPPORTF_ASYNC - Async - - - ACMDRIVERDETAILS_SUPPORTF_LOCAL - Local - - - ACMDRIVERDETAILS_SUPPORTF_DISABLED - Disabled - - - - ACM_DRIVERENUMF_NOLOCAL, Only global drivers should be included in the enumeration - - - - - ACM_DRIVERENUMF_DISABLED, Disabled ACM drivers should be included in the enumeration - - - - - ACM Format - - - - - Format Index - - - - - Format Tag - - - - - Support Flags - - - - - WaveFormat - - - - - WaveFormat Size - - - - - Format Description - - - - - ACMFORMATCHOOSE - http://msdn.microsoft.com/en-us/library/dd742911%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD fdwStyle; - - - - - HWND hwndOwner; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - LPCTSTR pszTitle; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - LPTSTR pszName; - n.b. can be written into - - - - - DWORD cchName - Should be at least 128 unless name is zero - - - - - DWORD fdwEnum; - - - - - LPWAVEFORMATEX pwfxEnum; - - - - - HINSTANCE hInstance; - - - - - LPCTSTR pszTemplateName; - - - - - LPARAM lCustData; - - - - - ACMFORMATCHOOSEHOOKPROC pfnHook; - - - - - None - - - - - ACMFORMATCHOOSE_STYLEF_SHOWHELP - - - - - ACMFORMATCHOOSE_STYLEF_ENABLEHOOK - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATE - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATEHANDLE - - - - - ACMFORMATCHOOSE_STYLEF_INITTOWFXSTRUCT - - - - - ACMFORMATCHOOSE_STYLEF_CONTEXTHELP - - - - - ACMFORMATDETAILS - http://msdn.microsoft.com/en-us/library/dd742913%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD dwFormatIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD fdwSupport; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - ACMFORMATDETAILS_FORMAT_CHARS - - - - - Format Enumeration Flags - - - - - None - - - - - ACM_FORMATENUMF_CONVERT - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will only enumerate destination formats that can be converted from the given pwfx format. - - - - - ACM_FORMATENUMF_HARDWARE - The enumerator should only enumerate formats that are supported as native input or output formats on one or more of the installed waveform-audio devices. This flag provides a way for an application to choose only formats native to an installed waveform-audio device. This flag must be used with one or both of the ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT flags. Specifying both ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT will enumerate only formats that can be opened for input or output. This is true regardless of whether this flag is specified. - - - - - ACM_FORMATENUMF_INPUT - Enumerator should enumerate only formats that are supported for input (recording). - - - - - ACM_FORMATENUMF_NCHANNELS - The nChannels member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_NSAMPLESPERSEC - The nSamplesPerSec member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_OUTPUT - Enumerator should enumerate only formats that are supported for output (playback). - - - - - ACM_FORMATENUMF_SUGGEST - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate all suggested destination formats for the given pwfx format. This mechanism can be used instead of the acmFormatSuggest function to allow an application to choose the best suggested format for conversion. The dwFormatIndex member will always be set to zero on return. - - - - - ACM_FORMATENUMF_WBITSPERSAMPLE - The wBitsPerSample member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_WFORMATTAG - The wFormatTag member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. The dwFormatTag member of the ACMFORMATDETAILS structure must be equal to the wFormatTag member. - - - - - ACM_FORMATSUGGESTF_WFORMATTAG - - - - - ACM_FORMATSUGGESTF_NCHANNELS - - - - - ACM_FORMATSUGGESTF_NSAMPLESPERSEC - - - - - ACM_FORMATSUGGESTF_WBITSPERSAMPLE - - - - - ACM_FORMATSUGGESTF_TYPEMASK - - - - - ACM Format Tag - - - - - Format Tag Index - - - - - Format Tag - - - - - Format Size - - - - - Support Flags - - - - - Standard Formats Count - - - - - Format Description - - - - - DWORD cbStruct; - - - - - DWORD dwFormatTagIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD cbFormatSize; - - - - - DWORD fdwSupport; - - - - - DWORD cStandardFormats; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - ACMFORMATTAGDETAILS_FORMATTAG_CHARS - - - - - Interop definitions for Windows ACM (Audio Compression Manager) API - - - - - http://msdn.microsoft.com/en-us/library/dd742910%28VS.85%29.aspx - UINT ACMFORMATCHOOSEHOOKPROC acmFormatChooseHookProc( - HWND hwnd, - UINT uMsg, - WPARAM wParam, - LPARAM lParam - - - - - A version with pointers for troubleshooting - - - - - AcmStream encapsulates an Audio Compression Manager Stream - used to convert audio from one format to another - - - - - Creates a new ACM stream to convert one format to another. Note that - not all conversions can be done in one step - - The source audio format - The destination audio format - - - - Creates a new ACM stream to convert one format to another, using a - specified driver identifier and wave filter - - the driver identifier - the source format - the wave filter - - - - Returns the number of output bytes for a given number of input bytes - - Number of input bytes - Number of output bytes - - - - Returns the number of source bytes for a given number of destination bytes - - Number of destination bytes - Number of source bytes - - - - Suggests an appropriate PCM format that the compressed format can be converted - to in one step - - The compressed format - The PCM format - - - - Returns the Source Buffer. Fill this with data prior to calling convert - - - - - Returns the Destination buffer. This will contain the converted data - after a successful call to Convert - - - - - Report that we have repositioned in the source stream - - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of source bytes actually converted - The number of converted bytes in the DestinationBuffer - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of converted bytes in the DestinationBuffer - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - ACMSTREAMHEADER_STATUSF_DONE - - - - - ACMSTREAMHEADER_STATUSF_PREPARED - - - - - ACMSTREAMHEADER_STATUSF_INQUEUE - - - - - Interop structure for ACM stream headers. - ACMSTREAMHEADER - http://msdn.microsoft.com/en-us/library/dd742926%28VS.85%29.aspx - - - - - ACM_STREAMOPENF_QUERY, ACM will be queried to determine whether it supports the given conversion. A conversion stream will not be opened, and no handle will be returned in the phas parameter. - - - - - ACM_STREAMOPENF_ASYNC, Stream conversion should be performed asynchronously. If this flag is specified, the application can use a callback function to be notified when the conversion stream is opened and closed and after each buffer is converted. In addition to using a callback function, an application can examine the fdwStatus member of the ACMSTREAMHEADER structure for the ACMSTREAMHEADER_STATUSF_DONE flag. - - - - - ACM_STREAMOPENF_NONREALTIME, ACM will not consider time constraints when converting the data. By default, the driver will attempt to convert the data in real time. For some formats, specifying this flag might improve the audio quality or other characteristics. - - - - - CALLBACK_TYPEMASK, callback type mask - - - - - CALLBACK_NULL, no callback - - - - - CALLBACK_WINDOW, dwCallback is a HWND - - - - - CALLBACK_TASK, dwCallback is a HTASK - - - - - CALLBACK_FUNCTION, dwCallback is a FARPROC - - - - - CALLBACK_THREAD, thread ID replaces 16 bit task - - - - - CALLBACK_EVENT, dwCallback is an EVENT Handle - - - - - ACM_STREAMSIZEF_SOURCE - - - - - ACM_STREAMSIZEF_DESTINATION - - - - - Summary description for WaveFilter. - - - - - cbStruct - - - - - dwFilterTag - - - - - fdwFilter - - - - - reserved - - - - ACM_METRIC_COUNT_DRIVERS - - - ACM_METRIC_COUNT_CODECS - - - ACM_METRIC_COUNT_CONVERTERS - - - ACM_METRIC_COUNT_FILTERS - - - ACM_METRIC_COUNT_DISABLED - - - ACM_METRIC_COUNT_HARDWARE - - - ACM_METRIC_COUNT_LOCAL_DRIVERS - - - ACM_METRIC_COUNT_LOCAL_CODECS - - - ACM_METRIC_COUNT_LOCAL_CONVERTERS - - - ACM_METRIC_COUNT_LOCAL_FILTERS - - - ACM_METRIC_COUNT_LOCAL_DISABLED - - - ACM_METRIC_HARDWARE_WAVE_INPUT - - - ACM_METRIC_HARDWARE_WAVE_OUTPUT - - - ACM_METRIC_MAX_SIZE_FORMAT - - - ACM_METRIC_MAX_SIZE_FILTER - - - ACM_METRIC_DRIVER_SUPPORT - - - ACM_METRIC_DRIVER_PRIORITY - - - - ACM_STREAMCONVERTF_BLOCKALIGN - - - - - ACM_STREAMCONVERTF_START - - - - - ACM_STREAMCONVERTF_END - - - - - Wave Callback Info - - - - - Callback Strategy - - - - - Window Handle (if applicable) - - - - - Sets up a new WaveCallbackInfo for function callbacks - - - - - Sets up a new WaveCallbackInfo to use a New Window - IMPORTANT: only use this on the GUI thread - - - - - Sets up a new WaveCallbackInfo to use an existing window - IMPORTANT: only use this on the GUI thread - - - - - Wave Callback Strategy - - - - - Use a function - - - - - Create a new window (should only be done if on GUI thread) - - - - - Use an existing window handle - - - - - Use an event handle - - - - - WaveHeader interop structure (WAVEHDR) - http://msdn.microsoft.com/en-us/library/dd743837%28VS.85%29.aspx - - - - pointer to locked data buffer (lpData) - - - length of data buffer (dwBufferLength) - - - used for input only (dwBytesRecorded) - - - for client's use (dwUser) - - - assorted flags (dwFlags) - - - loop control counter (dwLoops) - - - PWaveHdr, reserved for driver (lpNext) - - - reserved for driver - - - - Wave Header Flags enumeration - - - - - WHDR_BEGINLOOP - This buffer is the first buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_DONE - Set by the device driver to indicate that it is finished with the buffer and is returning it to the application. - - - - - WHDR_ENDLOOP - This buffer is the last buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_INQUEUE - Set by Windows to indicate that the buffer is queued for playback. - - - - - WHDR_PREPARED - Set by Windows to indicate that the buffer has been prepared with the waveInPrepareHeader or waveOutPrepareHeader function. - - - - - WaveInCapabilities structure (based on WAVEINCAPS2 from mmsystem.h) - http://msdn.microsoft.com/en-us/library/ms713726(VS.85).aspx - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Number of channels supported - - - - - The product name - - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - Event Args for WaveInStream event - - - - - Creates new WaveInEventArgs - - - - - Buffer containing recorded data. Note that it might not be completely - full. - - - - - The number of recorded bytes in Buffer. - - - - - MME Wave function interop - - - - - CALLBACK_NULL - No callback - - - - - CALLBACK_FUNCTION - dwCallback is a FARPROC - - - - - CALLBACK_EVENT - dwCallback is an EVENT handle - - - - - CALLBACK_WINDOW - dwCallback is a HWND - - - - - CALLBACK_THREAD - callback is a thread ID - - - - - WIM_OPEN - - - - - WIM_CLOSE - - - - - WIM_DATA - - - - - WOM_CLOSE - - - - - WOM_DONE - - - - - WOM_OPEN - - - - - WaveOutCapabilities structure (based on WAVEOUTCAPS2 from mmsystem.h) - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/multimed/htm/_win32_waveoutcaps_str.asp - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Optional functionality supported by the device - - - - - Number of channels supported - - - - - Whether playback control is supported - - - - - The product name - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Supported wave formats for WaveOutCapabilities - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Flags indicating what features this WaveOut device supports - - - - supports pitch control (WAVECAPS_PITCH) - - - supports playback rate control (WAVECAPS_PLAYBACKRATE) - - - supports volume control (WAVECAPS_VOLUME) - - - supports separate left-right volume control (WAVECAPS_LRVOLUME) - - - (WAVECAPS_SYNC) - - - (WAVECAPS_SAMPLEACCURATE) - - - - Sample provider interface to make WaveChannel32 extensible - Still a bit ugly, hence internal at the moment - and might even make these into - bit depth converting WaveProviders - - - - - ADSR sample provider allowing you to specify attack, decay, sustain and release values - - - - - Creates a new AdsrSampleProvider with default values - - - - - Attack time in seconds - - - - - Release time in seconds - - - - - Reads audio from this sample provider - - - - - Enters the Release phase - - - - - The output WaveFormat - - - - - Sample Provider to concatenate multiple sample providers together - - - - - Creates a new ConcatenatingSampleProvider - - The source providers to play one after the other. Must all share the same sample rate and channel count - - - - The WaveFormat of this Sample Provider - - - - - Read Samples from this sample provider - - - - - Sample Provider to allow fading in and out - - - - - Creates a new FadeInOutSampleProvider - - The source stream with the audio to be faded in or out - If true, we start faded out - - - - Requests that a fade-in begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Requests that a fade-out begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Reads samples from this sample provider - - Buffer to read into - Offset within buffer to write to - Number of samples desired - Number of samples read - - - - WaveFormat of this SampleProvider - - - - - Simple SampleProvider that passes through audio unchanged and raises - an event every n samples with the maximum sample value from the period - for metering purposes - - - - - Number of Samples per notification - - - - - Raised periodically to inform the user of the max volume - - - - - Initialises a new instance of MeteringSampleProvider that raises 10 stream volume - events per second - - Source sample provider - - - - Initialises a new instance of MeteringSampleProvider - - source sampler provider - Number of samples between notifications - - - - The WaveFormat of this sample provider - - - - - Reads samples from this Sample Provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Event args for aggregated stream volume - - - - - Max sample values array (one for each channel) - - - - - A sample provider mixer, allowing inputs to be added and removed - - - - - Creates a new MixingSampleProvider, with no inputs, but a specified WaveFormat - - The WaveFormat of this mixer. All inputs must be in this format - - - - Creates a new MixingSampleProvider, based on the given inputs - - Mixer inputs - must all have the same waveformat, and must - all be of the same WaveFormat. There must be at least one input - - - - Returns the mixer inputs (read-only - use AddMixerInput to add an input - - - - - When set to true, the Read method always returns the number - of samples requested, even if there are no inputs, or if the - current inputs reach their end. Setting this to true effectively - makes this a never-ending sample provider, so take care if you plan - to write it out to a file. - - - - - Adds a WaveProvider as a Mixer input. - Must be PCM or IEEE float already - - IWaveProvider mixer input - - - - Adds a new mixer input - - Mixer input - - - - Raised when a mixer input has been removed because it has ended - - - - - Removes a mixer input - - Mixer input to remove - - - - Removes all mixer inputs - - - - - The output WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - SampleProvider event args - - - - - Constructs a new SampleProviderEventArgs - - - - - The Sample Provider - - - - - No nonsense mono to stereo provider, no volume adjustment, - just copies input to left and right. - - - - - Initializes a new instance of MonoToStereoSampleProvider - - Source sample provider - - - - WaveFormat of this provider - - - - - Reads samples from this provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Multiplier for left channel (default is 1.0) - - - - - Multiplier for right channel (default is 1.0) - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing sample provider, allowing re-patching of input channels to different - output channels - - Input sample providers. Must all be of the same sample rate, but can have any number of channels - Desired number of output channels. - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads samples from this sample provider - - Buffer to be filled with sample data - Offset into buffer to start writing to, usually 0 - Number of samples required - Number of samples read - - - - The output WaveFormat for this SampleProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Simple class that raises an event on every sample - - - - - Initializes a new instance of NotifyingSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Sample notifier - - - - - Allows you to: - 1. insert a pre-delay of silence before the source begins - 2. skip over a certain amount of the beginning of the source - 3. only play a set amount from the source - 4. insert silence at the end after the source is complete - - - - - Number of samples of silence to insert before playing source - - - - - Amount of silence to insert before playing - - - - - Number of samples in source to discard - - - - - Amount of audio to skip over from the source before beginning playback - - - - - Number of samples to read from source (if 0, then read it all) - - - - - Amount of audio to take from the source (TimeSpan.Zero means play to end) - - - - - Number of samples of silence to insert after playing source - - - - - Amount of silence to insert after playing source - - - - - Creates a new instance of offsetSampleProvider - - The Source Sample Provider to read from - - - - The WaveFormat of this SampleProvider - - - - - Reads from this sample provider - - Sample buffer - Offset within sample buffer to read to - Number of samples required - Number of samples read - - - - Converts a mono sample provider to stereo, with a customisable pan strategy - - - - - Initialises a new instance of the PanningSampleProvider - - Source sample provider, must be mono - - - - Pan value, must be between -1 (left) and 1 (right) - - - - - The pan strategy currently in use - - - - - The WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Pair of floating point values, representing samples or multipliers - - - - - Left value - - - - - Right value - - - - - Required Interface for a Panning Strategy - - - - - Gets the left and right multipliers for a given pan value - - Pan value from -1 to 1 - Left and right multipliers in a stereo sample pair - - - - Simplistic "balance" control - treating the mono input as if it was stereo - In the centre, both channels full volume. Opposite channel decays linearly - as balance is turned to to one side - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Square Root Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Sinus Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Linear Pan - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Converts an IWaveProvider containing 16 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm16BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Samples required - Number of samples read - - - - Converts an IWaveProvider containing 24 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm24BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 32 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm32BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 8 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm8BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples to read - Number of samples read - - - - Utility class that takes an IWaveProvider input at any bit depth - and exposes it as an ISampleProvider. Can turn mono inputs into stereo, - and allows adjusting of volume - (The eventual successor to WaveChannel32) - This class also serves as an example of how you can link together several simple - Sample Providers to form a more useful class. - - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - force mono inputs to become stereo - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - The WaveFormat of this Sample Provider - - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Raised periodically to inform the user of the max volume - (before the volume meter) - - - - - Helper base class for classes converting to ISampleProvider - - - - - Source Wave Provider - - - - - Source buffer (to avoid constantly creating small buffers during playback) - - - - - Initialises a new instance of SampleProviderConverterBase - - Source Wave provider - - - - Wave format of this wave provider - - - - - Reads samples from the source wave provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Ensure the source buffer exists and is big enough - - Bytes required - - - - Utility class for converting to SampleProvider - - - - - Helper function to go from IWaveProvider to a SampleProvider - Must already be PCM or IEEE float - - The WaveProvider to convert - A sample provider - - - - Helper class for when you need to convert back to an IWaveProvider from - an ISampleProvider. Keeps it as IEEE float - - - - - Initializes a new instance of the WaveProviderFloatToWaveProvider class - - Source wave provider - - - - Reads from this provider - - - - - The waveformat of this WaveProvider (same as the source) - - - - - Converts a sample provider to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts a sample provider to 24 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream, clipping if necessary - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - The Format of this IWaveProvider - - - - - - Volume of this channel. 1.0 = full scale, 0.0 to mute - - - - - Signal Generator - Sin, Square, Triangle, SawTooth, White Noise, Pink Noise, Sweep. - - - Posibility to change ISampleProvider - Example : - --------- - WaveOut _waveOutGene = new WaveOut(); - WaveGenerator wg = new SignalGenerator(); - wg.Type = ... - wg.Frequency = ... - wg ... - _waveOutGene.Init(wg); - _waveOutGene.Play(); - - - - - Initializes a new instance for the Generator (Default :: 44.1Khz, 2 channels, Sinus, Frequency = 440, Gain = 1) - - - - - Initializes a new instance for the Generator (UserDef SampleRate & Channels) - - Desired sample rate - Number of channels - - - - The waveformat of this WaveProvider (same as the source) - - - - - Frequency for the Generator. (20.0 - 20000.0 Hz) - Sin, Square, Triangle, SawTooth, Sweep (Start Frequency). - - - - - Return Log of Frequency Start (Read only) - - - - - End Frequency for the Sweep Generator. (Start Frequency in Frequency) - - - - - Return Log of Frequency End (Read only) - - - - - Gain for the Generator. (0.0 to 1.0) - - - - - Channel PhaseReverse - - - - - Type of Generator. - - - - - Length Seconds for the Sweep Generator. - - - - - Reads from this provider. - - - - - Private :: Random for WhiteNoise & Pink Noise (Value form -1 to 1) - - Random value from -1 to +1 - - - - Signal Generator type - - - - - Pink noise - - - - - White noise - - - - - Sweep - - - - - Sine wave - - - - - Square wave - - - - - Triangle Wave - - - - - Sawtooth wave - - - - - Author: Freefall - Date: 05.08.16 - Based on: the port of Stephan M. Bernsee´s pitch shifting class - Port site: https://sites.google.com/site/mikescoderama/pitch-shifting - Test application and github site: https://github.com/Freefall63/NAudio-Pitchshifter - - NOTE: I strongly advice to add a Limiter for post-processing. - For my needs the FastAttackCompressor1175 provides acceptable results: - https://github.com/Jiyuu/SkypeFX/blob/master/JSNet/FastAttackCompressor1175.cs - - UPDATE: Added a simple Limiter based on the pydirac implementation. - https://github.com/echonest/remix/blob/master/external/pydirac225/source/Dirac_LE.cpp - - - - - - Creates a new SMB Pitch Shifting Sample Provider with default settings - - Source provider - - - - Creates a new SMB Pitch Shifting Sample Provider with custom settings - - Source provider - FFT Size (any power of two <= 4096: 4096, 2048, 1024, 512, ...) - Oversampling (number of overlapping windows) - Initial pitch (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - Read from this sample provider - - - - - WaveFormat - - - - - Pitch Factor (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - - Takes a stereo input and turns it to mono - - - - - Creates a new mono ISampleProvider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this SampleProvider - - - - - Very simple sample provider supporting adjustable gain - - - - - Initializes a new instance of VolumeSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Helper class turning an already 32 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Helper class turning an already 64 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Fully managed resampling sample provider, based on the WDL Resampler - - - - - Constructs a new resampler - - Source to resample - Desired output sample rate - - - - Reads from this sample provider - - - - - Output WaveFormat - - - - - Useful extension methods to make switching between WaveAndSampleProvider easier - - - - - Converts a WaveProvider into a SampleProvider (only works for PCM) - - WaveProvider to convert - - - - - Allows sending a SampleProvider directly to an IWavePlayer without needing to convert - back to an IWaveProvider - - The WavePlayer - - - - - - Turns WaveFormatExtensible into a standard waveformat if possible - - Input wave format - A standard PCM or IEEE waveformat, or the original waveformat - - - - Converts a ISampleProvider to a IWaveProvider but still 32 bit float - - SampleProvider to convert - An IWaveProvider - - - - Converts a ISampleProvider to a IWaveProvider but and convert to 16 bit - - SampleProvider to convert - A 16 bit IWaveProvider - - - - Concatenates one Sample Provider on the end of another - - The sample provider to play first - The sample provider to play next - A single sampleprovider to play one after the other - - - - Concatenates one Sample Provider on the end of another with silence inserted - - The sample provider to play first - Silence duration to insert between the two - The sample provider to play next - A single sample provider - - - - Skips over a specified amount of time (by consuming source stream) - - Source sample provider - Duration to skip over - A sample provider that skips over the specified amount of time - - - - Takes a specified amount of time from the source stream - - Source sample provider - Duration to take - A sample provider that reads up to the specified amount of time - - - - Converts a Stereo Sample Provider to mono, allowing mixing of channel volume - - Stereo Source Provider - Amount of left channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - Amount of right channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - A mono SampleProvider - - - - Converts a Mono ISampleProvider to stereo - - Mono Source Provider - Amount to mix to left channel (1.0 is full volume) - Amount to mix to right channel (1.0 is full volume) - - - - - Microsoft ADPCM - See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm - - - - - Empty constructor needed for marshalling from a pointer - - - - - Samples per block - - - - - Number of coefficients - - - - - Coefficients - - - - - Microsoft ADPCM - - Sample Rate - Channels - - - - Serializes this wave format - - Binary writer - - - - String Description of this WaveFormat - - - - - GSM 610 - - - - - Creates a GSM 610 WaveFormat - For now hardcoded to 13kbps - - - - - Samples per block - - - - - Writes this structure to a BinaryWriter - - - - - IMA/DVI ADPCM Wave Format - Work in progress - - - - - parameterless constructor for Marshalling - - - - - Creates a new IMA / DVI ADPCM Wave Format - - Sample Rate - Number of channels - Bits Per Sample - - - - MP3 WaveFormat, MPEGLAYER3WAVEFORMAT from mmreg.h - - - - - Wave format ID (wID) - - - - - Padding flags (fdwFlags) - - - - - Block Size (nBlockSize) - - - - - Frames per block (nFramesPerBlock) - - - - - Codec Delay (nCodecDelay) - - - - - Creates a new MP3 WaveFormat - - - - - Wave Format Padding Flags - - - - - MPEGLAYER3_FLAG_PADDING_ISO - - - - - MPEGLAYER3_FLAG_PADDING_ON - - - - - MPEGLAYER3_FLAG_PADDING_OFF - - - - - Wave Format ID - - - - MPEGLAYER3_ID_UNKNOWN - - - MPEGLAYER3_ID_MPEG - - - MPEGLAYER3_ID_CONSTANTFRAMESIZE - - - - DSP Group TrueSpeech - - - - - DSP Group TrueSpeech WaveFormat - - - - - Writes this structure to a BinaryWriter - - - - - Represents a Wave file format - - - - format type - - - number of channels - - - sample rate - - - for buffer estimation - - - block size of data - - - number of bits per sample of mono data - - - number of following bytes - - - - Creates a new PCM 44.1Khz stereo 16 bit format - - - - - Creates a new 16 bit wave format with the specified sample - rate and channel count - - Sample Rate - Number of channels - - - - Gets the size of a wave buffer equivalent to the latency in milliseconds. - - The milliseconds. - - - - - Creates a WaveFormat with custom members - - The encoding - Sample Rate - Number of channels - Average Bytes Per Second - Block Align - Bits Per Sample - - - - - Creates an A-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a Mu-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a new PCM format with the specified sample rate, bit depth and channels - - - - - Creates a new 32 bit IEEE floating point wave format - - sample rate - number of channels - - - - Helper function to retrieve a WaveFormat structure from a pointer - - WaveFormat structure - - - - - Helper function to marshal WaveFormat to an IntPtr - - WaveFormat - IntPtr to WaveFormat structure (needs to be freed by callee) - - - - Reads in a WaveFormat (with extra data) from a fmt chunk (chunk identifier and - length should already have been read) - - Binary reader - Format chunk length - A WaveFormatExtraData - - - - Reads a new WaveFormat object from a stream - - A binary reader that wraps the stream - - - - Reports this WaveFormat as a string - - String describing the wave format - - - - Compares with another WaveFormat object - - Object to compare to - True if the objects are the same - - - - Provides a Hashcode for this WaveFormat - - A hashcode - - - - Returns the encoding type used - - - - - Writes this WaveFormat object to a stream - - the output stream - - - - Returns the number of channels (1=mono,2=stereo etc) - - - - - Returns the sample rate (samples per second) - - - - - Returns the average number of bytes used per second - - - - - Returns the block alignment - - - - - Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) - Can be 0 for some codecs - - - - - Returns the number of extra bytes used by this waveformat. Often 0, - except for compressed formats which store extra data after the WAVEFORMATEX header - - - - - Summary description for WaveFormatEncoding. - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - - - - - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - WAVE_FORMAT_EXTENSIBLE - - - - - - - WaveFormatExtensible - http://www.microsoft.com/whdc/device/audio/multichaud.mspx - - - - - Parameterless constructor for marshalling - - - - - Creates a new WaveFormatExtensible for PCM or IEEE - - - - - WaveFormatExtensible for PCM or floating point can be awkward to work with - This creates a regular WaveFormat structure representing the same audio format - Returns the WaveFormat unchanged for non PCM or IEEE float - - - - - - SubFormat (may be one of AudioMediaSubtypes) - - - - - Serialize - - - - - - String representation - - - - - This class used for marshalling from unmanaged code - - - - - Allows the extra data to be read - - - - - parameterless constructor for marshalling - - - - - Reads this structure from a BinaryReader - - - - - Writes this structure to a BinaryWriter - - - - - The WMA wave format. - May not be much use because WMA codec is a DirectShow DMO not an ACM - - - - - Generic interface for wave recording - - - - - Recording WaveFormat - - - - - Start Recording - - - - - Stop Recording - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - WASAPI Loopback Capture - based on a contribution from "Pygmy" - http://naudio.codeplex.com/discussions/203605 - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Gets the default audio loopback capture device - - The default audio loopback capture device - - - - Capturing wave format - - - - - Specify loopback - - - - - Allows recording using the Windows waveIn APIs - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Creates a WaveIn device using the specified window handle for callbacks - - A valid window handle - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Called when we get a new buffer of recorded data - - - - - Start recording - - - - - Stop recording - - - - - Gets the current position in bytes from the wave input device. - it calls directly into waveInGetPosition) - - Position in bytes - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - Recording using waveIn api with event callbacks. - Use this for recording in non-gui applications - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Start recording - - - - - Stop recording - - - - - Gets the current position in bytes from the wave input device. - it calls directly into waveInGetPosition) - - Position in bytes - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - This class writes audio data to a .aif file on disk - - - - - Creates an Aiff file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Aiff File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - AiffFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new AiffFileWriter - - The filename to write to - The Wave Format of the output data - - - - The aiff file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this aiff file - - - - - Returns false: Cannot read from a AiffFileWriter - - - - - Returns true: Can write to a AiffFileWriter - - - - - Returns false: Cannot seek within a AiffFileWriter - - - - - Read is not supported for a AiffFileWriter - - - - - Seek is not supported for a AiffFileWriter - - - - - SetLength is not supported for AiffFileWriter - - - - - - Gets the Position in the AiffFile (i.e. number of bytes written so far) - - - - - Appends bytes to the AiffFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Aiff file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Aiff file - They will be converted to the appropriate bit depth depending on the WaveFormat of the AIF file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Aiff file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this AiffFileWriter - - - - - Raised when ASIO data has been recorded. - It is important to handle this as quickly as possible as it is in the buffer callback - - - - - Initialises a new instance of AsioAudioAvailableEventArgs - - Pointers to the ASIO buffers for each channel - Pointers to the ASIO buffers for each channel - Number of samples in each buffer - Audio format within each buffer - - - - Pointer to a buffer per input channel - - - - - Pointer to a buffer per output channel - Allows you to write directly to the output buffers - If you do so, set SamplesPerBuffer = true, - and make sure all buffers are written to with valid data - - - - - Set to true if you have written to the output buffers - If so, AsioOut will not read from its source - - - - - Number of samples in each buffer - - - - - Converts all the recorded audio into a buffer of 32 bit floating point samples, interleaved by channel - - The samples as 32 bit floating point, interleaved - - - - Audio format within each buffer - Most commonly this will be one of, Int32LSB, Int16LSB, Int24LSB or Float32LSB - - - - - Gets as interleaved samples, allocating a float array - - The samples as 32 bit floating point values - - - - ASIO Out Player. New implementation using an internal C# binding. - - This implementation is only supporting Short16Bit and Float32Bit formats and is optimized - for 2 outputs channels . - SampleRate is supported only if AsioDriver is supporting it - - This implementation is probably the first AsioDriver binding fully implemented in C#! - - Original Contributor: Mark Heath - New Contributor to C# binding : Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Playback Stopped - - - - - When recording, fires whenever recorded audio is available - - - - - Initializes a new instance of the class with the first - available ASIO Driver. - - - - - Initializes a new instance of the class with the driver name. - - Name of the device. - - - - Opens an ASIO output device - - Device number (zero based) - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Dispose - - - - - Gets the names of the installed ASIO Driver. - - an array of driver names - - - - Determines whether ASIO is supported. - - - true if ASIO is supported; otherwise, false. - - - - - Inits the driver from the asio driver name. - - Name of the driver. - - - - Shows the control panel - - - - - Starts playback - - - - - Stops playback - - - - - Pauses playback - - - - - Initialises to play - - Source wave provider - - - - Initialises to play, with optional recording - - Source wave provider - set to null for record only - Number of channels to record - Specify sample rate here if only recording, ignored otherwise - - - - driver buffer update callback to fill the wave buffer. - - The input channels. - The output channels. - - - - Gets the latency (in ms) of the playback driver - - - - - Automatically stop when the end of the input stream is reached - Disable this if auto-stop is causing hanging issues - - - - - A flag to let you know that we have reached the end of the input file - Useful if AutoStop is set to false - You can monitor this yourself and call Stop when it is true - - - - - Playback State - - - - - Driver Name - - - - - The number of output channels we are currently using for playback - (Must be less than or equal to DriverOutputChannelCount) - - - - - The number of input channels we are currently recording from - (Must be less than or equal to DriverInputChannelCount) - - - - - The maximum number of input channels this ASIO driver supports - - - - - The maximum number of output channels this ASIO driver supports - - - - - The number of samples per channel, per buffer. - - - - - By default the first channel on the input WaveProvider is sent to the first ASIO output. - This option sends it to the specified channel number. - Warning: make sure you don't set it higher than the number of available output channels - - the number of source channels. - n.b. Future NAudio may modify this - - - - - Input channel offset (used when recording), allowing you to choose to record from just one - specific input rather than them all - - - - - Sets the volume (1.0 is unity gain) - Not supported for ASIO Out. Set the volume on the input stream instead - - - - - Get the input channel name - - channel index (zero based) - channel name - - - - Get the output channel name - - channel index (zero based) - channel name - - - - https://tech.ebu.ch/docs/tech/tech3285.pdf - - - - - Constructs a new BextChunkInfo - - - - - Description (max 256 chars) - - - - - Originator (max 32 chars) - - - - - Originator Reference (max 32 chars) - - - - - Originator Date Time - - - - - Origination Date as string - - - - - Origination as time - - - - - Time reference (first sample count since midnight) - - - - - version 2 has loudness stuff which we don't know so using version 1 - - - - - 64 bytes http://en.wikipedia.org/wiki/UMID - - - - - for version 2 = 180 bytes (10 before are loudness values), using version 1 = 190 bytes - - - - - Coding history arbitrary length string at end of structure - http://www.ebu.ch/CMSimages/fr/tec_text_r98-1999_tcm7-4709.pdf - A=PCM,F=48000,W=16,M=stereo,T=original,CR/LF - - - - - Broadcast WAVE File Writer - - - - - Createa a new BwfWriter - - Rarget filename - WaveFormat - Chunk information - - - - Write audio data to this BWF - - - - - Flush writer, and fix up header sizes - - - - - Disposes this writer - - - - - A wave file writer that adds cue support - - - - - Writes a wave file, including a cues chunk - - - - - Adds a cue to the Wave file - - Sample position - Label text - - - - Updates the header, and writes the cues out - - - - - NativeDirectSoundOut using DirectSound COM interop. - Contact author: Alexandre Mutel - alexandre_mutel at yahoo.fr - Modified by: Graham "Gee" Plumb - - - - - Playback Stopped - - - - - Gets the DirectSound output devices in the system - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - (40ms seems to work under Vista). - - The latency. - Selected device - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets the current position from the wave output device. - - - - - Initialise playback - - The waveprovider to be played - - - - Current playback state - - - - - - The volume 1.0 is full scale - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Determines whether the SecondaryBuffer is lost. - - - true if [is buffer lost]; otherwise, false. - - - - - Convert ms to bytes size according to WaveFormat - - The ms - number of byttes - - - - Processes the samples in a separate thread. - - - - - Stop playback - - - - - Clean up the SecondaryBuffer - - - - In DirectSound, when playback is started, - the rest of the sound that was played last time is played back as noise. - This happens even if the secondary buffer is completely silenced, - so it seems that the buffer in the primary buffer or higher is not cleared. - - - To solve this problem fill the secondary buffer with silence data when stop playback. - - - - - - Feeds the SecondaryBuffer with the WaveStream - - number of bytes to feed - - - - IDirectSound interface - - - - - IDirectSoundBuffer interface - - - - - IDirectSoundNotify interface - - - - - Instanciate DirectSound from the DLL - - The GUID. - The direct sound. - The p unk outer. - - - - DirectSound default playback device GUID - - - - - DirectSound default capture device GUID - - - - - DirectSound default device for voice playback - - - - - DirectSound default device for voice capture - - - - - The DSEnumCallback function is an application-defined callback function that enumerates the DirectSound drivers. - The system calls this function in response to the application's call to the DirectSoundEnumerate or DirectSoundCaptureEnumerate function. - - Address of the GUID that identifies the device being enumerated, or NULL for the primary device. This value can be passed to the DirectSoundCreate8 or DirectSoundCaptureCreate8 function to create a device object for that driver. - Address of a null-terminated string that provides a textual description of the DirectSound device. - Address of a null-terminated string that specifies the module name of the DirectSound driver corresponding to this device. - Address of application-defined data. This is the pointer passed to DirectSoundEnumerate or DirectSoundCaptureEnumerate as the lpContext parameter. - Returns TRUE to continue enumerating drivers, or FALSE to stop. - - - - The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system. - - callback function - User context - - - - Gets the HANDLE of the desktop window. - - HANDLE of the Desktop window - - - - Class for enumerating DirectSound devices - - - - - The device identifier - - - - - Device description - - - - - Device module name - - - - - IWaveBuffer interface use to store wave datas. - Data can be manipulated with arrays (,, - , ) that are pointing to the same memory buffer. - This is a requirement for all subclasses. - - Use the associated Count property based on the type of buffer to get the number of data in the - buffer. - - for the standard implementation using C# unions. - - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets the byte buffer count. - - The byte buffer count. - - - - Gets the float buffer count. - - The float buffer count. - - - - Gets the short buffer count. - - The short buffer count. - - - - Gets the int buffer count. - - The int buffer count. - - - - Represents the interface to a device that can play a WaveFile - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Initialise playback - - The waveprovider to be played - - - - The volume - 1.0f is full scale - Note that not all implementations necessarily support volume changes - - - - - Current playback state - - - - - Indicates that playback has gone into a stopped state due to - reaching the end of the input stream or an error has been encountered during playback - - - - - Interface for IWavePlayers that can report position - - - - - Position (in terms of bytes played - does not necessarily translate directly to the position within the source audio file) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Generic interface for all WaveProviders. - - - - - Gets the WaveFormat of this WaveProvider. - - The wave format. - - - - Fill the specified buffer with wave data. - - The buffer to fill of wave data. - Offset into buffer - The number of bytes to read - the number of bytes written to the buffer. - - - - Like IWaveProvider, but makes it much simpler to put together a 32 bit floating - point mixing engine - - - - - Gets the WaveFormat of this Sample Provider. - - The wave format. - - - - Fill the specified buffer with 32 bit floating point samples - - The buffer to fill with samples. - Offset into buffer - The number of samples to read - the number of samples written to the buffer. - - - - Media Foundation Encoder class allows you to use Media Foundation to encode an IWaveProvider - to any supported encoding format - - - - - Queries the available bitrates for a given encoding output type, sample rate and number of channels - - Audio subtype - a value from the AudioSubtypes class - The sample rate of the PCM to encode - The number of channels of the PCM to encode - An array of available bitrates in average bits per second - - - - Gets all the available media types for a particular - - Audio subtype - a value from the AudioSubtypes class - An array of available media types that can be encoded with this subtype - - - - Helper function to simplify encoding Window Media Audio - Should be supported on Vista and above (not tested) - - Input provider, must be PCM - Output file path, should end with .wma - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to MP3 - By default, will only be available on Windows 8 and above - - Input provider, must be PCM - Output file path, should end with .mp3 - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to AAC - By default, will only be available on Windows 7 and above - - Input provider, must be PCM - Output file path, should end with .mp4 (or .aac on Windows 8) - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Tries to find the encoding media type with the closest bitrate to that specified - - Audio subtype, a value from AudioSubtypes - Your encoder input format (used to check sample rate and channel count) - Your desired bitrate - The closest media type, or null if none available - - - - Creates a new encoder that encodes to the specified output media type - - Desired output media type - - - - Encodes a file - - Output filename (container type is deduced from the filename) - Input provider (should be PCM, some encoders will also allow IEEE float) - - - - Disposes this instance - - - - - - Disposes this instance - - - - - Finalizer - - - - - Playback State - - - - - Stopped - - - - - Playing - - - - - Paused - - - - - Stopped Event Args - - - - - Initializes a new instance of StoppedEventArgs - - An exception to report (null if no exception) - - - - An exception. Will be null if the playback or record operation stopped due to - the user requesting stop or reached the end of the input audio - - - - - Support for playback using Wasapi - - - - - Playback Stopped - - - - - WASAPI Out shared mode, default - - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - Desired latency in milliseconds - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Creates a new WASAPI Output - - Device to use - - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Begin Playback - - - - - Stop playback and flush buffers - - - - - Stop playback without flushing buffers - - - - - Initialize for playing the specified wave stream - - IWaveProvider to play - - - - Playback State - - - - - Volume - - - - - Retrieve the AudioStreamVolume object for this audio stream - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Dispose - - - - - WaveBuffer class use to store wave datas. Data can be manipulated with arrays - (,,, ) that are pointing to the - same memory buffer. Use the associated Count property based on the type of buffer to get the number of - data in the buffer. - Implicit casting is now supported to float[], byte[], int[], short[]. - You must not use Length on returned arrays. - - n.b. FieldOffset is 8 now to allow it to work natively on 64 bit - - - - - Number of Bytes - - - - - Initializes a new instance of the class. - - The number of bytes. The size of the final buffer will be aligned on 4 Bytes (upper bound) - - - - Initializes a new instance of the class binded to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Binds this WaveBuffer instance to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets or sets the byte buffer count. - - The byte buffer count. - - - - Gets or sets the float buffer count. - - The float buffer count. - - - - Gets or sets the short buffer count. - - The short buffer count. - - - - Gets or sets the int buffer count. - - The int buffer count. - - - - Clears the associated buffer. - - - - - Copy this WaveBuffer to a destination buffer up to ByteBufferCount bytes. - - - - - Checks the validity of the count parameters. - - Name of the arg. - The value. - The size of value. - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - Writes to a stream by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The stream the method will output to - The source WaveProvider - - - - WaveFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new WaveFileWriter - - The filename to write to - The Wave Format of the output data - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - Total time (calculated from Length and average bytes per second) - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriter - - - - - Returns true: Can write to a WaveFileWriter - - - - - Returns false: Cannot seek within a WaveFileWriter - - - - - Read is not supported for a WaveFileWriter - - - - - Seek is not supported for a WaveFileWriter - - - - - SetLength is not supported for WaveFileWriter - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - Also updates header, so that WAV file will be valid up to the point currently written - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriter - - - - - Represents a wave out device - - - - - Indicates playback has stopped automatically - - - - - Retrieves the capabilities of a waveOut device - - Device to test - The WaveOut device capabilities - - - - Returns the number of Wave Out devices available in the system - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Creates a default WaveOut device - Will use window callbacks if called from a GUI thread, otherwise function - callbacks - - - - - Creates a WaveOut device using the specified window handle for callbacks - - A valid window handle - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Alternative WaveOut class, making use of the Event callback - - - - - Indicates playback has stopped automatically - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Provides a buffered store of samples - Read method will return queued samples or fill buffer with zeroes - Now backed by a circular buffer - - - - - Creates a new buffered WaveProvider - - WaveFormat - - - - If true, always read the amount of data requested, padding with zeroes if necessary - By default is set to true - - - - - Buffer length in bytes - - - - - Buffer duration - - - - - If true, when the buffer is full, start throwing away data - if false, AddSamples will throw an exception when buffer is full - - - - - The number of buffered bytes - - - - - Buffered Duration - - - - - Gets the WaveFormat - - - - - Adds samples. Takes a copy of buffer, so that buffer can be reused if necessary - - - - - Reads from this WaveProvider - Will always return count bytes, since we will zero-fill the buffer if not enough available - - - - - Discards all audio from the buffer - - - - - Provide WaveProvider that can apply effects in real time using DMO. - - If the audio thread is running on the STA thread, please generate and operate from the same thread. - If the audio thread is running on the MTA thread, please operate on any MTA thread. - - Types of DMO effectors to use - Parameters of the effect to be used - - - - Create a new DmoEffectWaveProvider - - Input Stream - - - - Stream Wave Format - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Get Effector Parameters - - - - - Dispose - - - - - The Media Foundation Resampler Transform - - - - - Creates the Media Foundation Resampler, allowing modifying of sample rate, bit depth and channel count - - Source provider, must be PCM - Output format, must also be PCM - - - - Creates a resampler with a specified target output sample rate - - Source provider - Output sample rate - - - - Creates and configures the actual Resampler transform - - A newly created and configured resampler MFT - - - - Gets or sets the Resampler quality. n.b. set the quality before starting to resample. - 1 is lowest quality (linear interpolation) and 60 is best quality - - - - - Disposes this resampler - - - - - WaveProvider that can mix together multiple 32 bit floating point input provider - All channels must have the same number of inputs and same sample rate - n.b. Work in Progress - not tested yet - - - - - Creates a new MixingWaveProvider32 - - - - - Creates a new 32 bit MixingWaveProvider32 - - inputs - must all have the same format. - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove an input from the mixer - - waveProvider to remove - - - - The number of inputs to this mixer - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Converts from mono to stereo, allowing freedom to route all, some, or none of the incoming signal to left or right channels - - - - - Creates a new stereo waveprovider based on a mono input - - Mono 16 bit PCM input - - - - 1.0 to copy the mono stream to the left channel without adjusting volume - - - - - 1.0 to copy the mono stream to the right channel without adjusting volume - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels. Number of outputs is equal to total number of channels in inputs - - Input wave providers. Must all be of the same format, but can have any number of channels - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels - - Input wave providers. Must all be of the same format, but can have any number of channels - Desired number of output channels. (-1 means use total number of input channels) - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads data from this WaveProvider - - Buffer to be filled with sample data - Offset to write to within buffer, usually 0 - Number of bytes required - Number of bytes read - - - - The WaveFormat of this WaveProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Silence producing wave provider - Useful for playing silence when doing a WASAPI Loopback Capture - - - - - Creates a new silence producing wave provider - - Desired WaveFormat (should be PCM / IEE float - - - - Read silence from into the buffer - - - - - WaveFormat of this silence producing wave provider - - - - - Takes a stereo 16 bit input and turns it mono, allowing you to select left or right channel only or mix them together - - - - - Creates a new mono waveprovider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Helper class allowing us to modify the volume of a 16 bit stream without converting to IEEE float - - - - - Constructs a new VolumeWaveProvider16 - - Source provider, must be 16 bit PCM - - - - Gets or sets volume. - 1.0 is full scale, 0.0 is silence, anything over 1.0 will amplify but potentially clip - - - - - WaveFormat of this WaveProvider - - - - - Read bytes from this WaveProvider - - Buffer to read into - Offset within buffer to read to - Bytes desired - Bytes read - - - - Converts 16 bit PCM to IEEE float, optionally adjusting volume along the way - - - - - Creates a new Wave16toFloatProvider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts IEEE float to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Creates a new WaveFloatTo16Provider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Buffered WaveProvider taking source data from WaveIn - - - - - Creates a new WaveInProvider - n.b. Should make sure the WaveFormat is set correctly on IWaveIn before calling - - The source of wave data - - - - Reads data from the WaveInProvider - - - - - The WaveFormat - - - - - Base class for creating a 16 bit wave provider - - - - - Initializes a new instance of the WaveProvider16 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider16 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a short array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Base class for creating a 32 bit floating point wave provider - Can also be used as a base class for an ISampleProvider that can - be plugged straight into anything requiring an IWaveProvider - - - - - Initializes a new instance of the WaveProvider32 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider32 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a float array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Utility class to intercept audio from an IWaveProvider and - save it to disk - - - - - Constructs a new WaveRecorder - - The location to write the WAV file to - The Source Wave Provider - - - - Read simply returns what the source returns, but writes to disk along the way - - - - - The WaveFormat - - - - - Closes the WAV file - - - - A read-only stream of AIFF data based on an aiff file - with an associated WaveFormat - originally contributed to NAudio by Giawa - - - - Supports opening a AIF file - The AIF is of similar nastiness to the WAV format. - This supports basic reading of uncompressed PCM AIF files, - with 8, 16, 24 and 32 bit PCM data. - - - - - Creates an Aiff File Reader based on an input stream - - The input stream containing a AIF file including header - - - - Ensures valid AIFF header and then finds data offset. - - The stream, positioned at the start of audio data - The format found - The position of the data chunk - The length of the data chunk - Additional chunks found - - - - Cleans up the resources associated with this AiffFileReader - - - - - - - - - - - - - - - Number of Samples (if possible to calculate) - - - - - Position in the AIFF file - - - - - - Reads bytes from the AIFF File - - - - - - AIFF Chunk - - - - - Chunk Name - - - - - Chunk Length - - - - - Chunk start - - - - - Creates a new AIFF Chunk - - - - - AudioFileReader simplifies opening an audio file in NAudio - Simply pass in the filename, and it will attempt to open the - file and set up a conversion path that turns into PCM IEEE float. - ACM codecs will be used for conversion. - It provides a volume property and implements both WaveStream and - ISampleProvider, making it possibly the only stage in your audio - pipeline necessary for simple playback scenarios - - - - - Initializes a new instance of AudioFileReader - - The file to open - - - - Creates the reader stream, supporting all filetypes in the core NAudio library, - and ensuring we are in PCM format - - File Name - - - - File Name - - - - - WaveFormat of this stream - - - - - Length of this stream (in bytes) - - - - - Position of this stream (in bytes) - - - - - Reads from this wave stream - - Audio buffer - Offset into buffer - Number of bytes required - Number of bytes read - - - - Reads audio from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Gets or Sets the Volume of this AudioFileReader. 1.0f is full volume - - - - - Helper to convert source to dest bytes - - - - - Helper to convert dest to source bytes - - - - - Disposes this AudioFileReader - - True if called from Dispose - - - - Helper stream that lets us read from compressed audio files with large block alignment - as though we could read any amount and reposition anywhere - - - - - Creates a new BlockAlignReductionStream - - the input stream - - - - Block alignment of this stream - - - - - Wave Format - - - - - Length of this Stream - - - - - Current position within stream - - - - - Disposes this WaveStream - - - - - Reads data from this stream - - - - - - - - - Implementation of Com IStream - - - - - Holds information on a cue: a labeled position within a Wave file - - - - - Cue position in samples - - - - - Label of the cue - - - - - Creates a Cue based on a sample position and label - - - - - - - Holds a list of cues - - - The specs for reading and writing cues from the cue and list RIFF chunks - are from http://www.sonicspot.com/guide/wavefiles.html and http://www.wotsit.org/ - ------------------------------ - The cues are stored like this: - ------------------------------ - struct CuePoint - { - Int32 dwIdentifier; - Int32 dwPosition; - Int32 fccChunk; - Int32 dwChunkStart; - Int32 dwBlockStart; - Int32 dwSampleOffset; - } - - struct CueChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwCuePoints; - CuePoint[] points; - } - ------------------------------ - Labels look like this: - ------------------------------ - struct ListHeader - { - Int32 listID; /* 'list' */ - Int32 chunkSize; /* includes the Type ID below */ - Int32 typeID; /* 'adtl' */ - } - - struct LabelChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwIdentifier; - Char[] dwText; /* Encoded with extended ASCII */ - } LabelChunk; - - - - - Creates an empty cue list - - - - - Adds an item to the list - - Cue - - - - Gets sample positions for the embedded cues - - Array containing the cue positions - - - - Gets labels for the embedded cues - - Array containing the labels - - - - Creates a cue list from the cue RIFF chunk and the list RIFF chunk - - The data contained in the cue chunk - The data contained in the list chunk - - - - Gets the cues as the concatenated cue and list RIFF chunks. - - RIFF chunks containing the cue data - - - - Number of cues - - - - - Accesses the cue at the specified index - - - - - - - Checks if the cue and list chunks exist and if so, creates a cue list - - - - - A wave file reader supporting cue reading - - - - - Loads a wavefile and supports reading cues - - - - - - Loads a wave from a stream and supports reading cues - - - - - - Cue List (can be null if cues not present) - - - - - An interface for WaveStreams which can report notification of individual samples - - - - - A sample has been detected - - - - - Sample event arguments - - - - - Left sample - - - - - Right sample - - - - - Constructor - - - - - Class for reading any file that Media Foundation can play - Will only work in Windows Vista and above - Automatically converts to PCM - If it is a video file with multiple audio streams, it will pick out the first audio stream - - - - - Allows customisation of this reader class - - - - - Sets up the default settings for MediaFoundationReader - - - - - Allows us to request IEEE float output (n.b. no guarantee this will be accepted) - - - - - If true, the reader object created in the constructor is used in Read - Should only be set to true if you are working entirely on an STA thread, or - entirely with MTA threads. - - - - - If true, the reposition does not happen immediately, but waits until the - next call to read to be processed. - - - - - Default constructor - - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename (can also be a URL e.g. http:// mms:// file://) - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename - Advanced settings - - - - Initializes - - - - - Creates the reader (overridable by ) - - - - - Reads from this wave stream - - Buffer to read into - Offset in buffer - Bytes required - Number of bytes read; 0 indicates end of stream - - - - WaveFormat of this stream (n.b. this is after converting to PCM) - - - - - The bytesRequired of this stream in bytes (n.b may not be accurate) - - - - - Current position within this stream - - - - - Cleans up after finishing with this reader - - true if called from Dispose - - - - WaveFormat has changed - - - - - Class for reading from MP3 files - - - - - The MP3 wave format (n.b. NOT the output format of this stream - see the WaveFormat property) - - - - Supports opening a MP3 file - - - Supports opening a MP3 file - MP3 File name - Factory method to build a frame decompressor - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - Factory method to build a frame decompressor - - - - Function that can create an MP3 Frame decompressor - - A WaveFormat object describing the MP3 file format - An MP3 Frame decompressor - - - - Creates an ACM MP3 Frame decompressor. This is the default with NAudio - - A WaveFormat object based - - - - - Gets the total length of this file in milliseconds. - - - - - ID3v2 tag if present - - - - - ID3v1 tag if present - - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - This is the length in bytes of data available to be read out from the Read method - (i.e. the decompressed MP3 length) - n.b. this may return 0 for files whose length is unknown - - - - - - - - - - - - - - - Reads decompressed PCM data from our MP3 file. - - - - - Xing header if present - - - - - Disposes this WaveStream - - - - - WaveStream that simply passes on data from its source stream - (e.g. a MemoryStream) - - - - - Initialises a new instance of RawSourceWaveStream - - The source stream containing raw audio - The waveformat of the audio in the source stream - - - - Initialises a new instance of RawSourceWaveStream - - The buffer containing raw audio - Offset in the source buffer to read from - Number of bytes to read in the buffer - The waveformat of the audio in the source stream - - - - The WaveFormat of this stream - - - - - The length in bytes of this stream (if supported) - - - - - The current position in this stream - - - - - Reads data from the stream - - - - - Wave Stream for converting between sample rates - - - - - WaveStream to resample using the DMO Resampler - - Input Stream - Desired Output Format - - - - Stream Wave Format - - - - - Stream length in bytes - - - - - Stream position in bytes - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Dispose - - True if disposing (not from finalizer) - - - - Holds information about a RIFF file chunk - - - - - Creates a RiffChunk object - - - - - The chunk identifier - - - - - The chunk identifier converted to a string - - - - - The chunk length - - - - - The stream position this chunk is located at - - - - - A simple compressor - - - - - Create a new simple compressor stream - - Source stream - - - - Make-up Gain - - - - - Threshold - - - - - Ratio - - - - - Attack time - - - - - Release time - - - - - Turns gain on or off - - - - - Gets the WaveFormat of this stream - - - - - Reads bytes from this stream - - Buffer to read into - Offset in array to read into - Number of bytes to read - Number of bytes read - - - - MediaFoundationReader supporting reading from a stream - - - - - Constructs a new media foundation reader from a stream - - - - - Creates the reader - - - - - WaveStream that converts 32 bit audio back down to 16 bit, clipping if necessary - - - - - The method reuses the same buffer to prevent - unnecessary allocations. - - - - - Creates a new Wave32To16Stream - - the source stream - - - - Sets the volume for this stream. 1.0f is full scale - - - - - - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - Destination buffer - Offset into destination buffer - - Number of bytes read. - - - - Conversion to 16 bit and clipping - - - - - - - - - - Clip indicator. Can be reset. - - - - - Disposes this WaveStream - - - - - Represents Channel for the WaveMixerStream - 32 bit output and 16 bit input - It's output is always stereo - The input stream can be panned - - - - - Creates a new WaveChannel32 - - the source stream - stream volume (1 is 0dB) - pan control (-1 to 1) - - - - Creates a WaveChannel32 with default settings - - The source stream - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - If true, Read always returns the number of bytes requested - - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Pan of this channel (from -1 to 1) - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - Sample - - - - - Raise the sample event (no check for null because it has already been done) - - - - This class supports the reading of WAV files, - providing a repositionable WaveStream that returns the raw data - contained in the WAV file - - - - Supports opening a WAV file - The WAV file format is a real mess, but we will only - support the basic WAV file format which actually covers the vast - majority of WAV files out there. For more WAV file format information - visit www.wotsit.org. If you have a WAV file that can't be read by - this class, email it to the NAudio project and we will probably - fix this reader to support it - - - - - Creates a Wave File Reader based on an input stream - - The input stream containing a WAV file including header - - - - Gets a list of the additional chunks found in this file - - - - - Gets the data for the specified chunk - - - - - Cleans up the resources associated with this WaveFileReader - - - - - - - - - - This is the length of audio data contained in this WAV file, in bytes - (i.e. the byte length of the data chunk, not the length of the WAV file itself) - - - - - - Number of Sample Frames (if possible to calculate) - This currently does not take into account number of channels - Multiply number of channels if you want the total number of samples - - - - - Position in the WAV data chunk. - - - - - - Reads bytes from the Wave File - - - - - - Attempts to read the next sample or group of samples as floating point normalised into the range -1.0f to 1.0f - - An array of samples, 1 for mono, 2 for stereo etc. Null indicates end of file reached - - - - - Attempts to read a sample into a float. n.b. only applicable for uncompressed formats - Will normalise the value read into the range -1.0f to 1.0f if it comes from a PCM encoding - - False if the end of the WAV data chunk was reached - - - - IWaveProvider that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source Provider - - - - Gets the WaveFormat of this stream - - - - - Indicates that a reposition has taken place, and internal buffers should be reset - - - - - Reads bytes from this stream - - Buffer to read into - Offset in buffer to read into - Number of bytes to read - Number of bytes read - - - - Disposes this stream - - true if the user called this - - - - Disposes this resource - - - - - Finalizer - - - - - WaveStream that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source stream - - - - Creates a stream that can convert to PCM - - The source stream - A PCM stream - - - - Gets or sets the current position in the stream - - - - - Converts source bytes to destination bytes - - - - - Converts destination bytes to source bytes - - - - - Returns the stream length - - - - - Gets the WaveFormat of this stream - - - - - - - Buffer to read into - Offset within buffer to write to - Number of bytes to read - Bytes read - - - - Disposes this stream - - true if the user called this - - - - A buffer of Wave samples - - - - - creates a new wavebuffer - - WaveIn device to write to - Buffer size in bytes - - - - Place this buffer back to record more audio - - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - - Provides access to the actual record buffer (for reading only) - - - - - Indicates whether the Done flag is set on this buffer - - - - - Indicates whether the InQueue flag is set on this buffer - - - - - Number of bytes recorded - - - - - The buffer size in bytes - - - - - WaveStream that can mix together multiple 32 bit input streams - (Normally used with stereo input channels) - All channels must have the same number of inputs - - - - - Creates a new 32 bit WaveMixerStream - - - - - Creates a new 32 bit WaveMixerStream - - An Array of WaveStreams - must all have the same format. - Use WaveChannel is designed for this purpose. - Automatically stop when all inputs have been read - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove a WaveStream from the mixer - - waveStream to remove - - - - The number of inputs to this mixer - - - - - Automatically stop when all inputs have been read - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Length of this Wave Stream (in bytes) - - - - - - Position within this Wave Stream (in bytes) - - - - - - - - - - - Disposes this WaveStream - - - - - Simply shifts the input stream in time, optionally - clipping its start and end. - (n.b. may include looping in the future) - - - - - Creates a new WaveOffsetStream - - the source stream - the time at which we should start reading from the source stream - amount to trim off the front of the source stream - length of time to play from source stream - - - - Creates a WaveOffsetStream with default settings (no offset or pre-delay, - and whole length of source stream) - - The source stream - - - - The length of time before which no audio will be played - - - - - An offset into the source stream from which to start playing - - - - - Length of time to read from the source stream - - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - A buffer of Wave samples for streaming to a Wave Output device - - - - - creates a new wavebuffer - - WaveOut device to write to - Buffer size in bytes - Stream to provide more data - Lock to protect WaveOut API's from being called on >1 thread - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - this is called by the WAVE callback and should be used to refill the buffer - - - - Whether the header's in queue flag is set - - - - - The buffer size in bytes - - - - - Base class for all WaveStream classes. Derives from stream. - - - - - Retrieves the WaveFormat for this stream - - - - - We can read from this stream - - - - - We can seek within this stream - - - - - We can't write to this stream - - - - - Flush does not need to do anything - See - - - - - An alternative way of repositioning. - See - - - - - Sets the length of the WaveStream. Not Supported. - - - - - - Writes to the WaveStream. Not Supported. - - - - - The block alignment for this wavestream. Do not modify the Position - to anything that is not a whole multiple of this value - - - - - Moves forward or backwards the specified number of seconds in the stream - - Number of seconds to move, can be negative - - - - The current position in the stream in Time format - - - - - Total length in real-time of the stream (may be an estimate for compressed files) - - - - - Whether the WaveStream has non-zero sample data at the current position for the - specified count - - Number of bytes to read - - - - MP3 Frame decompressor using the Windows Media MP3 Decoder DMO object - - - - - Initializes a new instance of the DMO MP3 Frame decompressor - - - - - - Converted PCM WaveFormat - - - - - Decompress a single frame of MP3 - - - - - Alerts us that a reposition has occured so the MP3 decoder needs to reset its state - - - - - Dispose of this obejct and clean up resources - - - - - http://tech.ebu.ch/docs/tech/tech3306-2009.pdf - - - - - WaveFormat - - - - - Data Chunk Position - - - - - Data Chunk Length - - - - - Riff Chunks - - - - - Soundfont generator - - - - - Gets the generator type - - - - - Generator amount as an unsigned short - - - - - Generator amount as a signed short - - - - - Low byte amount - - - - - High byte amount - - - - - Instrument - - - - - Sample Header - - - - - - - - - - Generator types - - - - Start address offset - - - End address offset - - - Start loop address offset - - - End loop address offset - - - Start address coarse offset - - - Modulation LFO to pitch - - - Vibrato LFO to pitch - - - Modulation envelope to pitch - - - Initial filter cutoff frequency - - - Initial filter Q - - - Modulation LFO to filter Cutoff frequency - - - Modulation envelope to filter cutoff frequency - - - End address coarse offset - - - Modulation LFO to volume - - - Unused - - - Chorus effects send - - - Reverb effects send - - - Pan - - - Unused - - - Unused - - - Unused - - - Delay modulation LFO - - - Frequency modulation LFO - - - Delay vibrato LFO - - - Frequency vibrato LFO - - - Delay modulation envelope - - - Attack modulation envelope - - - Hold modulation envelope - - - Decay modulation envelope - - - Sustain modulation envelop - - - Release modulation envelope - - - Key number to modulation envelope hold - - - Key number to modulation envelope decay - - - Delay volume envelope - - - Attack volume envelope - - - Hold volume envelope - - - Decay volume envelope - - - Sustain volume envelope - - - Release volume envelope - - - Key number to volume envelope hold - - - Key number to volume envelope decay - - - Instrument - - - Reserved - - - Key range - - - Velocity range - - - Start loop address coarse offset - - - Key number - - - Velocity - - - Initial attenuation - - - Reserved - - - End loop address coarse offset - - - Coarse tune - - - Fine tune - - - Sample ID - - - Sample modes - - - Reserved - - - Scale tuning - - - Exclusive class - - - Overriding root key - - - Unused - - - Unused - - - - A soundfont info chunk - - - - - SoundFont Version - - - - - WaveTable sound engine - - - - - Bank name - - - - - Data ROM - - - - - Creation Date - - - - - Author - - - - - Target Product - - - - - Copyright - - - - - Comments - - - - - Tools - - - - - ROM Version - - - - - - - - - - SoundFont instrument - - - - - instrument name - - - - - Zones - - - - - - - - - - Instrument Builder - - - - - Transform Types - - - - - Linear - - - - - Modulator - - - - - Source Modulation data type - - - - - Destination generator type - - - - - Amount - - - - - Source Modulation Amount Type - - - - - Source Transform Type - - - - - - - - - - Controller Sources - - - - - No Controller - - - - - Note On Velocity - - - - - Note On Key Number - - - - - Poly Pressure - - - - - Channel Pressure - - - - - Pitch Wheel - - - - - Pitch Wheel Sensitivity - - - - - Source Types - - - - - Linear - - - - - Concave - - - - - Convex - - - - - Switch - - - - - Modulator Type - - - - - - - - - - - A SoundFont Preset - - - - - Preset name - - - - - Patch Number - - - - - Bank number - 0 - 127, GM percussion bank is 128 - - - - - Zones - - - - - - - - - - Class to read the SoundFont file presets chunk - - - - - The Presets contained in this chunk - - - - - The instruments contained in this chunk - - - - - The sample headers contained in this chunk - - - - - - - - - - just reads a chunk ID at the current position - - chunk ID - - - - reads a chunk at the current position - - - - - creates a new riffchunk from current position checking that we're not - at the end of this chunk first - - the new chunk - - - - useful for chunks that just contain a string - - chunk as string - - - - A SoundFont Sample Header - - - - - The sample name - - - - - Start offset - - - - - End offset - - - - - Start loop point - - - - - End loop point - - - - - Sample Rate - - - - - Original pitch - - - - - Pitch correction - - - - - Sample Link - - - - - SoundFont Sample Link Type - - - - - - - - - - SoundFont sample modes - - - - - No loop - - - - - Loop Continuously - - - - - Reserved no loop - - - - - Loop and continue - - - - - Sample Link Type - - - - - Mono Sample - - - - - Right Sample - - - - - Left Sample - - - - - Linked Sample - - - - - ROM Mono Sample - - - - - ROM Right Sample - - - - - ROM Left Sample - - - - - ROM Linked Sample - - - - - SoundFont Version Structure - - - - - Major Version - - - - - Minor Version - - - - - Builds a SoundFont version - - - - - Reads a SoundFont Version structure - - - - - Writes a SoundFont Version structure - - - - - Gets the length of this structure - - - - - Represents a SoundFont - - - - - Loads a SoundFont from a file - - Filename of the SoundFont - - - - Loads a SoundFont from a stream - - stream - - - - The File Info Chunk - - - - - The Presets - - - - - The Instruments - - - - - The Sample Headers - - - - - The Sample Data - - - - - - - - - - base class for structures that can read themselves - - - - - A SoundFont zone - - - - - - - - - - Modulators for this Zone - - - - - Generators for this Zone - - - - - Summary description for Fader. - - - - - Required designer variable. - - - - - Creates a new Fader control - - - - - Clean up any resources being used. - - - - - - - - - - - - - - - - - - - - - - - - - Minimum value of this fader - - - - - Maximum value of this fader - - - - - Current value of this fader - - - - - Fader orientation - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Pan slider control - - - - - Required designer variable. - - - - - True when pan value changed - - - - - Creates a new PanSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - - The current Pan setting - - - - - Control that represents a potentiometer - TODO list: - Optional Log scale - Optional reverse scale - Keyboard control - Optional bitmap mode - Optional complete draw mode - Tooltip support - - - - - Value changed event - - - - - Creates a new pot control - - - - - Minimum Value of the Pot - - - - - Maximum Value of the Pot - - - - - The current value of the pot - - - - - Draws the control - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Handles the mouse up event to allow changing value by dragging - - - - - Handles the mouse down event to allow changing value by dragging - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Implements a rudimentary volume meter - - - - - Basic volume meter - - - - - On Fore Color Changed - - - - - Current Value - - - - - Minimum decibels - - - - - Maximum decibels - - - - - Meter orientation - - - - - Paints the volume meter - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - VolumeSlider control - - - - - Required designer variable. - - - - - Volume changed event - - - - - Creates a new VolumeSlider control - - - - - Clean up any resources being used. - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - - - - - - - - - - - - - - - - The volume for this control - - - - - Windows Forms control for painting audio waveforms - - - - - Constructs a new instance of the WaveFormPainter class - - - - - On Resize - - - - - On ForeColor Changed - - - - - - Add Max Value - - - - - - On Paint - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Control for viewing waveforms - - - - - Required designer variable. - - - - - Creates a new WaveViewer control - - - - - sets the associated wavestream - - - - - The zoom level, in samples per pixel - - - - - Start position (currently in bytes) - - - - - Clean up any resources being used. - - - - - - - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - Audio Subtype GUIDs - http://msdn.microsoft.com/en-us/library/windows/desktop/aa372553%28v=vs.85%29.aspx - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - μ-law coding - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Adaptive delta pulse code modulation (ADPCM) - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Dolby Digital Plus formatted for HDMI output. - http://msdn.microsoft.com/en-us/library/windows/hardware/ff538392(v=vs.85).aspx - Reference : internet - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - IMFActivate, defined in mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Creates the object associated with this activation object. - - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - - - Provides a generic way to store key/value pairs on an object. - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms704598%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - IMFByteStream - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms698720%28v=vs.85%29.aspx - - - - - Retrieves the characteristics of the byte stream. - virtual HRESULT STDMETHODCALLTYPE GetCapabilities(/*[out]*/ __RPC__out DWORD *pdwCapabilities) = 0; - - - - - Retrieves the length of the stream. - virtual HRESULT STDMETHODCALLTYPE GetLength(/*[out]*/ __RPC__out QWORD *pqwLength) = 0; - - - - - Sets the length of the stream. - virtual HRESULT STDMETHODCALLTYPE SetLength(/*[in]*/ QWORD qwLength) = 0; - - - - - Retrieves the current read or write position in the stream. - virtual HRESULT STDMETHODCALLTYPE GetCurrentPosition(/*[out]*/ __RPC__out QWORD *pqwPosition) = 0; - - - - - Sets the current read or write position. - virtual HRESULT STDMETHODCALLTYPE SetCurrentPosition(/*[in]*/ QWORD qwPosition) = 0; - - - - - Queries whether the current position has reached the end of the stream. - virtual HRESULT STDMETHODCALLTYPE IsEndOfStream(/*[out]*/ __RPC__out BOOL *pfEndOfStream) = 0; - - - - - Reads data from the stream. - virtual HRESULT STDMETHODCALLTYPE Read(/*[size_is][out]*/ __RPC__out_ecount_full(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbRead) = 0; - - - - - Begins an asynchronous read operation from the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginRead(/*[out]*/ _Out_writes_bytes_(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous read operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndRead(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbRead) = 0; - - - - - Writes data to the stream. - virtual HRESULT STDMETHODCALLTYPE Write(/*[size_is][in]*/ __RPC__in_ecount_full(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbWritten) = 0; - - - - - Begins an asynchronous write operation to the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginWrite(/*[in]*/ _In_reads_bytes_(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous write operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndWrite(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbWritten) = 0; - - - - - Moves the current position in the stream by a specified offset. - virtual HRESULT STDMETHODCALLTYPE Seek(/*[in]*/ MFBYTESTREAM_SEEK_ORIGIN SeekOrigin, /*[in]*/ LONGLONG llSeekOffset, /*[in]*/ DWORD dwSeekFlags, /*[out]*/ __RPC__out QWORD *pqwCurrentPosition) = 0; - - - - - Clears any internal buffers used by the stream. - virtual HRESULT STDMETHODCALLTYPE Flush( void) = 0; - - - - - Closes the stream and releases any resources associated with the stream. - virtual HRESULT STDMETHODCALLTYPE Close( void) = 0; - - - - - Represents a generic collection of IUnknown pointers. - - - - - Retrieves the number of objects in the collection. - - - - - Retrieves an object in the collection. - - - - - Adds an object to the collection. - - - - - Removes an object from the collection. - - - - - Removes an object from the collection. - - - - - Removes all items from the collection. - - - - - IMFMediaBuffer - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms696261%28v=vs.85%29.aspx - - - - - Gives the caller access to the memory in the buffer. - - - - - Unlocks a buffer that was previously locked. - - - - - Retrieves the length of the valid data in the buffer. - - - - - Sets the length of the valid data in the buffer. - - - - - Retrieves the allocated size of the buffer. - - - - - IMFMediaEvent - Represents an event generated by a Media Foundation object. Use this interface to get information about the event. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms702249%28v=vs.85%29.aspx - Mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the event type. - - - virtual HRESULT STDMETHODCALLTYPE GetType( - /* [out] */ __RPC__out MediaEventType *pmet) = 0; - - - - - Retrieves the extended type of the event. - - - virtual HRESULT STDMETHODCALLTYPE GetExtendedType( - /* [out] */ __RPC__out GUID *pguidExtendedType) = 0; - - - - - Retrieves an HRESULT that specifies the event status. - - - virtual HRESULT STDMETHODCALLTYPE GetStatus( - /* [out] */ __RPC__out HRESULT *phrStatus) = 0; - - - - - Retrieves the value associated with the event, if any. - - - virtual HRESULT STDMETHODCALLTYPE GetValue( - /* [out] */ __RPC__out PROPVARIANT *pvValue) = 0; - - - - - Represents a description of a media format. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms704850%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the major type of the format. - - - - - Queries whether the media type is a compressed format. - - - - - Compares two media types and determines whether they are identical. - - - - - Retrieves an alternative representation of the media type. - - - - - Frees memory that was allocated by the GetRepresentation method. - - - - - Creates an instance of either the sink writer or the source reader. - - - - - Creates an instance of the sink writer or source reader, given a URL. - - - - - Creates an instance of the sink writer or source reader, given an IUnknown pointer. - - - - - CLSID_MFReadWriteClassFactory - - - - - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms702192%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves flags associated with the sample. - - - - - Sets flags associated with the sample. - - - - - Retrieves the presentation time of the sample. - - - - - Sets the presentation time of the sample. - - - - - Retrieves the duration of the sample. - - - - - Sets the duration of the sample. - - - - - Retrieves the number of buffers in the sample. - - - - - Retrieves a buffer from the sample. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - - - - Adds a buffer to the end of the list of buffers in the sample. - - - - - Removes a buffer at a specified index from the sample. - - - - - Removes all buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. - - - - - Copies the sample data to a buffer. - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Adds a stream to the sink writer. - - - - - Sets the input format for a stream on the sink writer. - - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - - - Indicates a gap in an input stream. - - - - - Places a marker in the specified stream. - - - - - Notifies the media sink that a stream has reached the end of a segment. - - - - - Flushes one or more streams. - - - - - (Finalize) Completes all writing operations on the sink writer. - - - - - Queries the underlying media sink or encoder for an interface. - - - - - Gets statistics about the performance of the sink writer. - - - - - IMFSourceReader interface - http://msdn.microsoft.com/en-us/library/windows/desktop/dd374655%28v=vs.85%29.aspx - - - - - Queries whether a stream is selected. - - - - - Selects or deselects one or more streams. - - - - - Gets a format that is supported natively by the media source. - - - - - Gets the current media type for a stream. - - - - - Sets the media type for a stream. - - - - - Seeks to a new position in the media source. - - - - - Reads the next sample from the media source. - - - - - Flushes one or more streams. - - - - - Queries the underlying media source or decoder for an interface. - - - - - Gets an attribute from the underlying media source. - - - - - Contains flags that indicate the status of the IMFSourceReader::ReadSample method - http://msdn.microsoft.com/en-us/library/windows/desktop/dd375773(v=vs.85).aspx - - - - - No Error - - - - - An error occurred. If you receive this flag, do not make any further calls to IMFSourceReader methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the IMFSourceReader::GetCurrentMediaType method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. - - - - - IMFTransform, defined in mftransform.h - - - - - Retrieves the minimum and maximum number of input and output streams. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamLimits( - /* [out] */ __RPC__out DWORD *pdwInputMinimum, - /* [out] */ __RPC__out DWORD *pdwInputMaximum, - /* [out] */ __RPC__out DWORD *pdwOutputMinimum, - /* [out] */ __RPC__out DWORD *pdwOutputMaximum) = 0; - - - - - Retrieves the current number of input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamCount( - /* [out] */ __RPC__out DWORD *pcInputStreams, - /* [out] */ __RPC__out DWORD *pcOutputStreams) = 0; - - - - - Retrieves the stream identifiers for the input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamIDs( - DWORD dwInputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwInputIDArraySize) DWORD *pdwInputIDs, - DWORD dwOutputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwOutputIDArraySize) DWORD *pdwOutputIDs) = 0; - - - - - Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamInfo( - DWORD dwInputStreamID, - /* [out] */ __RPC__out MFT_INPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamInfo( - DWORD dwOutputStreamID, - /* [out] */ __RPC__out MFT_OUTPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the global attribute store for this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetAttributes( - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an input stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamAttributes( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamAttributes( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Removes an input stream from this MFT. - - - virtual HRESULT STDMETHODCALLTYPE DeleteInputStream( - DWORD dwStreamID) = 0; - - - - - Adds one or more new input streams to this MFT. - - - virtual HRESULT STDMETHODCALLTYPE AddInputStreams( - DWORD cStreams, - /* [in] */ __RPC__in DWORD *adwStreamIDs) = 0; - - - - - Gets an available media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputAvailableType( - DWORD dwInputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Retrieves an available media type for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputAvailableType( - DWORD dwOutputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetInputType( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetOutputType( - DWORD dwOutputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Gets the current media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputCurrentType( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Gets the current media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputCurrentType( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStatus( - DWORD dwInputStreamID, - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Queries whether the Media Foundation transform (MFT) is ready to produce output data. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStatus( - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Sets the range of time stamps the client needs for output. - - - virtual HRESULT STDMETHODCALLTYPE SetOutputBounds( - LONGLONG hnsLowerBound, - LONGLONG hnsUpperBound) = 0; - - - - - Sends an event to an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessEvent( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaEvent *pEvent) = 0; - - - - - Sends a message to the Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessMessage( - MFT_MESSAGE_TYPE eMessage, - ULONG_PTR ulParam) = 0; - - - - - Delivers data to an input stream on this Media Foundation transform (MFT). - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessInput( - DWORD dwInputStreamID, - IMFSample *pSample, - DWORD dwFlags) = 0; - - - - - Generates output from the current input data. - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessOutput( - DWORD dwFlags, - DWORD cOutputBufferCount, - /* [size_is][out][in] */ MFT_OUTPUT_DATA_BUFFER *pOutputSamples, - /* [out] */ DWORD *pdwStatus) = 0; - - - - - See mfobjects.h - - - - - Unknown event type. - - - - - Signals a serious error. - - - - - Custom event type. - - - - - A non-fatal error occurred during streaming. - - - - - Session Unknown - - - - - Raised after the IMFMediaSession::SetTopology method completes asynchronously - - - - - Raised by the Media Session when the IMFMediaSession::ClearTopologies method completes asynchronously. - - - - - Raised when the IMFMediaSession::Start method completes asynchronously. - - - - - Raised when the IMFMediaSession::Pause method completes asynchronously. - - - - - Raised when the IMFMediaSession::Stop method completes asynchronously. - - - - - Raised when the IMFMediaSession::Close method completes asynchronously. - - - - - Raised by the Media Session when it has finished playing the last presentation in the playback queue. - - - - - Raised by the Media Session when the playback rate changes. - - - - - Raised by the Media Session when it completes a scrubbing request. - - - - - Raised by the Media Session when the session capabilities change. - - - - - Raised by the Media Session when the status of a topology changes. - - - - - Raised by the Media Session when a new presentation starts. - - - - - Raised by a media source a new presentation is ready. - - - - - License acquisition is about to begin. - - - - - License acquisition is complete. - - - - - Individualization is about to begin. - - - - - Individualization is complete. - - - - - Signals the progress of a content enabler object. - - - - - A content enabler object's action is complete. - - - - - Raised by a trusted output if an error occurs while enforcing the output policy. - - - - - Contains status information about the enforcement of an output policy. - - - - - A media source started to buffer data. - - - - - A media source stopped buffering data. - - - - - The network source started opening a URL. - - - - - The network source finished opening a URL. - - - - - Raised by a media source at the start of a reconnection attempt. - - - - - Raised by a media source at the end of a reconnection attempt. - - - - - Raised by the enhanced video renderer (EVR) when it receives a user event from the presenter. - - - - - Raised by the Media Session when the format changes on a media sink. - - - - - Source Unknown - - - - - Raised when a media source starts without seeking. - - - - - Raised by a media stream when the source starts without seeking. - - - - - Raised when a media source seeks to a new position. - - - - - Raised by a media stream after a call to IMFMediaSource::Start causes a seek in the stream. - - - - - Raised by a media source when it starts a new stream. - - - - - Raised by a media source when it restarts or seeks a stream that is already active. - - - - - Raised by a media source when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media source when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media source when a presentation ends. - - - - - Raised by a media stream when the stream ends. - - - - - Raised when a media stream delivers a new sample. - - - - - Signals that a media stream does not have data available at a specified time. - - - - - Raised by a media stream when it starts or stops thinning the stream. - - - - - Raised by a media stream when the media type of the stream changes. - - - - - Raised by a media source when the playback rate changes. - - - - - Raised by the sequencer source when a segment is completed and is followed by another segment. - - - - - Raised by a media source when the source's characteristics change. - - - - - Raised by a media source to request a new playback rate. - - - - - Raised by a media source when it updates its metadata. - - - - - Raised by the sequencer source when the IMFSequencerSource::UpdateTopology method completes asynchronously. - - - - - Sink Unknown - - - - - Raised by a stream sink when it completes the transition to the running state. - - - - - Raised by a stream sink when it completes the transition to the stopped state. - - - - - Raised by a stream sink when it completes the transition to the paused state. - - - - - Raised by a stream sink when the rate has changed. - - - - - Raised by a stream sink to request a new media sample from the pipeline. - - - - - Raised by a stream sink after the IMFStreamSink::PlaceMarker method is called. - - - - - Raised by a stream sink when the stream has received enough preroll data to begin rendering. - - - - - Raised by a stream sink when it completes a scrubbing request. - - - - - Raised by a stream sink when the sink's media type is no longer valid. - - - - - Raised by the stream sinks of the EVR if the video device changes. - - - - - Provides feedback about playback quality to the quality manager. - - - - - Raised when a media sink becomes invalid. - - - - - The audio session display name changed. - - - - - The volume or mute state of the audio session changed - - - - - The audio device was removed. - - - - - The Windows audio server system was shut down. - - - - - The grouping parameters changed for the audio session. - - - - - The audio session icon changed. - - - - - The default audio format for the audio device changed. - - - - - The audio session was disconnected from a Windows Terminal Services session - - - - - The audio session was preempted by an exclusive-mode connection. - - - - - Trust Unknown - - - - - The output policy for a stream changed. - - - - - Content protection message - - - - - The IMFOutputTrustAuthority::SetPolicy method completed. - - - - - DRM License Backup Completed - - - - - DRM License Backup Progress - - - - - DRM License Restore Completed - - - - - DRM License Restore Progress - - - - - DRM License Acquisition Completed - - - - - DRM Individualization Completed - - - - - DRM Individualization Progress - - - - - DRM Proximity Completed - - - - - DRM License Store Cleaned - - - - - DRM Revocation Download Completed - - - - - Transform Unknown - - - - - Sent by an asynchronous MFT to request a new input sample. - - - - - Sent by an asynchronous MFT when new output data is available from the MFT. - - - - - Sent by an asynchronous Media Foundation transform (MFT) when a drain operation is complete. - - - - - Sent by an asynchronous MFT in response to an MFT_MESSAGE_COMMAND_MARKER message. - - - - - Media Foundation attribute guids - http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - Specifies whether an MFT performs asynchronous processing. - - - - - Enables the use of an asynchronous MFT. - - - - - Contains flags for an MFT activation object. - - - - - Specifies the category for an MFT. - - - - - Contains the class identifier (CLSID) of an MFT. - - - - - Contains the registered input types for a Media Foundation transform (MFT). - - - - - Contains the registered output types for a Media Foundation transform (MFT). - - - - - Contains the symbolic link for a hardware-based MFT. - - - - - Contains the display name for a hardware-based MFT. - - - - - Contains a pointer to the stream attributes of the connected stream on a hardware-based MFT. - - - - - Specifies whether a hardware-based MFT is connected to another hardware-based MFT. - - - - - Specifies the preferred output format for an encoder. - - - - - Specifies whether an MFT is registered only in the application's process. - - - - - Contains configuration properties for an encoder. - - - - - Specifies whether a hardware device source uses the system time for time stamps. - - - - - Contains an IMFFieldOfUseMFTUnlock pointer, which can be used to unlock the MFT. - - - - - Contains the merit value of a hardware codec. - - - - - Specifies whether a decoder is optimized for transcoding rather than for playback. - - - - - Contains a pointer to the proxy object for the application's presentation descriptor. - - - - - Contains a pointer to the presentation descriptor from the protected media path (PMP). - - - - - Specifies the duration of a presentation, in 100-nanosecond units. - - - - - Specifies the total size of the source file, in bytes. - - - - - Specifies the audio encoding bit rate for the presentation, in bits per second. - - - - - Specifies the video encoding bit rate for the presentation, in bits per second. - - - - - Specifies the MIME type of the content. - - - - - Specifies when a presentation was last modified. - - - - - The identifier of the playlist element in the presentation. - - - - - Contains the preferred RFC 1766 language of the media source. - - - - - The time at which the presentation must begin, relative to the start of the media source. - - - - - Specifies whether the audio streams in the presentation have a variable bit rate. - - - - - Media type Major Type - - - - - Media Type subtype - - - - - Audio block alignment - - - - - Audio average bytes per second - - - - - Audio number of channels - - - - - Audio samples per second - - - - - Audio bits per sample - - - - - Enables the source reader or sink writer to use hardware-based Media Foundation transforms (MFTs). - - - - - Contains additional format data for a media type. - - - - - Specifies for a media type whether each sample is independent of the other samples in the stream. - - - - - Specifies for a media type whether the samples have a fixed size. - - - - - Contains a DirectShow format GUID for a media type. - - - - - Specifies the preferred legacy format structure to use when converting an audio media type. - - - - - Specifies for a media type whether the media data is compressed. - - - - - Approximate data rate of the video stream, in bits per second, for a video media type. - - - - - Specifies the payload type of an Advanced Audio Coding (AAC) stream. - 0 - The stream contains raw_data_block elements only - 1 - Audio Data Transport Stream (ADTS). The stream contains an adts_sequence, as defined by MPEG-2. - 2 - Audio Data Interchange Format (ADIF). The stream contains an adif_sequence, as defined by MPEG-2. - 3 - The stream contains an MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream, as defined by ISO/IEC 14496-3. - - - - - Media Foundation Errors - - - - RANGES - 14000 - 14999 = General Media Foundation errors - 15000 - 15999 = ASF parsing errors - 16000 - 16999 = Media Source errors - 17000 - 17999 = MEDIAFOUNDATION Network Error Events - 18000 - 18999 = MEDIAFOUNDATION WMContainer Error Events - 19000 - 19999 = MEDIAFOUNDATION Media Sink Error Events - 20000 - 20999 = Renderer errors - 21000 - 21999 = Topology Errors - 25000 - 25999 = Timeline Errors - 26000 - 26999 = Unused - 28000 - 28999 = Transform errors - 29000 - 29999 = Content Protection errors - 40000 - 40999 = Clock errors - 41000 - 41999 = MF Quality Management Errors - 42000 - 42999 = MF Transcode API Errors - - - - - MessageId: MF_E_PLATFORM_NOT_INITIALIZED - - MessageText: - - Platform not initialized. Please call MFStartup().%0 - - - - - MessageId: MF_E_BUFFERTOOSMALL - - MessageText: - - The buffer was too small to carry out the requested action.%0 - - - - - MessageId: MF_E_INVALIDREQUEST - - MessageText: - - The request is invalid in the current state.%0 - - - - - MessageId: MF_E_INVALIDSTREAMNUMBER - - MessageText: - - The stream number provided was invalid.%0 - - - - - MessageId: MF_E_INVALIDMEDIATYPE - - MessageText: - - The data specified for the media type is invalid, inconsistent, or not supported by this object.%0 - - - - - MessageId: MF_E_NOTACCEPTING - - MessageText: - - The callee is currently not accepting further input.%0 - - - - - MessageId: MF_E_NOT_INITIALIZED - - MessageText: - - This object needs to be initialized before the requested operation can be carried out.%0 - - - - - MessageId: MF_E_UNSUPPORTED_REPRESENTATION - - MessageText: - - The requested representation is not supported by this object.%0 - - - - - MessageId: MF_E_NO_MORE_TYPES - - MessageText: - - An object ran out of media types to suggest therefore the requested chain of streaming objects cannot be completed.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SERVICE - - MessageText: - - The object does not support the specified service.%0 - - - - - MessageId: MF_E_UNEXPECTED - - MessageText: - - An unexpected error has occurred in the operation requested.%0 - - - - - MessageId: MF_E_INVALIDNAME - - MessageText: - - Invalid name.%0 - - - - - MessageId: MF_E_INVALIDTYPE - - MessageText: - - Invalid type.%0 - - - - - MessageId: MF_E_INVALID_FILE_FORMAT - - MessageText: - - The file does not conform to the relevant file format specification. - - - - - MessageId: MF_E_INVALIDINDEX - - MessageText: - - Invalid index.%0 - - - - - MessageId: MF_E_INVALID_TIMESTAMP - - MessageText: - - An invalid timestamp was given.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SCHEME - - MessageText: - - The scheme of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_BYTESTREAM_TYPE - - MessageText: - - The byte stream type of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_TIME_FORMAT - - MessageText: - - The given time format is unsupported.%0 - - - - - MessageId: MF_E_NO_SAMPLE_TIMESTAMP - - MessageText: - - The Media Sample does not have a timestamp.%0 - - - - - MessageId: MF_E_NO_SAMPLE_DURATION - - MessageText: - - The Media Sample does not have a duration.%0 - - - - - MessageId: MF_E_INVALID_STREAM_DATA - - MessageText: - - The request failed because the data in the stream is corrupt.%0\n. - - - - - MessageId: MF_E_RT_UNAVAILABLE - - MessageText: - - Real time services are not available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE - - MessageText: - - The specified rate is not supported.%0 - - - - - MessageId: MF_E_THINNING_UNSUPPORTED - - MessageText: - - This component does not support stream-thinning.%0 - - - - - MessageId: MF_E_REVERSE_UNSUPPORTED - - MessageText: - - The call failed because no reverse playback rates are available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE_TRANSITION - - MessageText: - - The requested rate transition cannot occur in the current state.%0 - - - - - MessageId: MF_E_RATE_CHANGE_PREEMPTED - - MessageText: - - The requested rate change has been pre-empted and will not occur.%0 - - - - - MessageId: MF_E_NOT_FOUND - - MessageText: - - The specified object or value does not exist.%0 - - - - - MessageId: MF_E_NOT_AVAILABLE - - MessageText: - - The requested value is not available.%0 - - - - - MessageId: MF_E_NO_CLOCK - - MessageText: - - The specified operation requires a clock and no clock is available.%0 - - - - - MessageId: MF_S_MULTIPLE_BEGIN - - MessageText: - - This callback and state had already been passed in to this event generator earlier.%0 - - - - - MessageId: MF_E_MULTIPLE_BEGIN - - MessageText: - - This callback has already been passed in to this event generator.%0 - - - - - MessageId: MF_E_MULTIPLE_SUBSCRIBERS - - MessageText: - - Some component is already listening to events on this event generator.%0 - - - - - MessageId: MF_E_TIMER_ORPHANED - - MessageText: - - This timer was orphaned before its callback time arrived.%0 - - - - - MessageId: MF_E_STATE_TRANSITION_PENDING - - MessageText: - - A state transition is already pending.%0 - - - - - MessageId: MF_E_UNSUPPORTED_STATE_TRANSITION - - MessageText: - - The requested state transition is unsupported.%0 - - - - - MessageId: MF_E_UNRECOVERABLE_ERROR_OCCURRED - - MessageText: - - An unrecoverable error has occurred.%0 - - - - - MessageId: MF_E_SAMPLE_HAS_TOO_MANY_BUFFERS - - MessageText: - - The provided sample has too many buffers.%0 - - - - - MessageId: MF_E_SAMPLE_NOT_WRITABLE - - MessageText: - - The provided sample is not writable.%0 - - - - - MessageId: MF_E_INVALID_KEY - - MessageText: - - The specified key is not valid. - - - - - MessageId: MF_E_BAD_STARTUP_VERSION - - MessageText: - - You are calling MFStartup with the wrong MF_VERSION. Mismatched bits? - - - - - MessageId: MF_E_UNSUPPORTED_CAPTION - - MessageText: - - The caption of the given URL is unsupported.%0 - - - - - MessageId: MF_E_INVALID_POSITION - - MessageText: - - The operation on the current offset is not permitted.%0 - - - - - MessageId: MF_E_ATTRIBUTENOTFOUND - - MessageText: - - The requested attribute was not found.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_ALLOWED - - MessageText: - - The specified property type is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_SUPPORTED - - MessageText: - - The specified property type is not supported.%0 - - - - - MessageId: MF_E_PROPERTY_EMPTY - - MessageText: - - The specified property is empty.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_EMPTY - - MessageText: - - The specified property is not empty.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_NOT_ALLOWED - - MessageText: - - The vector property specified is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_REQUIRED - - MessageText: - - A vector property is required in this context.%0 - - - - - MessageId: MF_E_OPERATION_CANCELLED - - MessageText: - - The operation is cancelled.%0 - - - - - MessageId: MF_E_BYTESTREAM_NOT_SEEKABLE - - MessageText: - - The provided bytestream was expected to be seekable and it is not.%0 - - - - - MessageId: MF_E_DISABLED_IN_SAFEMODE - - MessageText: - - The Media Foundation platform is disabled when the system is running in Safe Mode.%0 - - - - - MessageId: MF_E_CANNOT_PARSE_BYTESTREAM - - MessageText: - - The Media Source could not parse the byte stream.%0 - - - - - MessageId: MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS - - MessageText: - - Mutually exclusive flags have been specified to source resolver. This flag combination is invalid.%0 - - - - - MessageId: MF_E_MEDIAPROC_WRONGSTATE - - MessageText: - - MediaProc is in the wrong state%0 - - - - - MessageId: MF_E_RT_THROUGHPUT_NOT_AVAILABLE - - MessageText: - - Real time I/O service can not provide requested throughput.%0 - - - - - MessageId: MF_E_RT_TOO_MANY_CLASSES - - MessageText: - - The workqueue cannot be registered with more classes.%0 - - - - - MessageId: MF_E_RT_WOULDBLOCK - - MessageText: - - This operation cannot succeed because another thread owns this object.%0 - - - - - MessageId: MF_E_NO_BITPUMP - - MessageText: - - Internal. Bitpump not found.%0 - - - - - MessageId: MF_E_RT_OUTOFMEMORY - - MessageText: - - No more RT memory available.%0 - - - - - MessageId: MF_E_RT_WORKQUEUE_CLASS_NOT_SPECIFIED - - MessageText: - - An MMCSS class has not been set for this work queue.%0 - - - - - MessageId: MF_E_INSUFFICIENT_BUFFER - - MessageText: - - Insufficient memory for response.%0 - - - - - MessageId: MF_E_CANNOT_CREATE_SINK - - MessageText: - - Activate failed to create mediasink. Call OutputNode::GetUINT32(MF_TOPONODE_MAJORTYPE) for more information. %0 - - - - - MessageId: MF_E_BYTESTREAM_UNKNOWN_LENGTH - - MessageText: - - The length of the provided bytestream is unknown.%0 - - - - - MessageId: MF_E_SESSION_PAUSEWHILESTOPPED - - MessageText: - - The media session cannot pause from a stopped state.%0 - - - - - MessageId: MF_S_ACTIVATE_REPLACED - - MessageText: - - The activate could not be created in the remote process for some reason it was replaced with empty one.%0 - - - - - MessageId: MF_E_FORMAT_CHANGE_NOT_SUPPORTED - - MessageText: - - The data specified for the media type is supported, but would require a format change, which is not supported by this object.%0 - - - - - MessageId: MF_E_INVALID_WORKQUEUE - - MessageText: - - The operation failed because an invalid combination of workqueue ID and flags was specified.%0 - - - - - MessageId: MF_E_DRM_UNSUPPORTED - - MessageText: - - No DRM support is available.%0 - - - - - MessageId: MF_E_UNAUTHORIZED - - MessageText: - - This operation is not authorized.%0 - - - - - MessageId: MF_E_OUT_OF_RANGE - - MessageText: - - The value is not in the specified or valid range.%0 - - - - - MessageId: MF_E_INVALID_CODEC_MERIT - - MessageText: - - The registered codec merit is not valid.%0 - - - - - MessageId: MF_E_HW_MFT_FAILED_START_STREAMING - - MessageText: - - Hardware MFT failed to start streaming due to lack of hardware resources.%0 - - - - - MessageId: MF_S_ASF_PARSEINPROGRESS - - MessageText: - - Parsing is still in progress and is not yet complete.%0 - - - - - MessageId: MF_E_ASF_PARSINGINCOMPLETE - - MessageText: - - Not enough data have been parsed to carry out the requested action.%0 - - - - - MessageId: MF_E_ASF_MISSINGDATA - - MessageText: - - There is a gap in the ASF data provided.%0 - - - - - MessageId: MF_E_ASF_INVALIDDATA - - MessageText: - - The data provided are not valid ASF.%0 - - - - - MessageId: MF_E_ASF_OPAQUEPACKET - - MessageText: - - The packet is opaque, so the requested information cannot be returned.%0 - - - - - MessageId: MF_E_ASF_NOINDEX - - MessageText: - - The requested operation failed since there is no appropriate ASF index.%0 - - - - - MessageId: MF_E_ASF_OUTOFRANGE - - MessageText: - - The value supplied is out of range for this operation.%0 - - - - - MessageId: MF_E_ASF_INDEXNOTLOADED - - MessageText: - - The index entry requested needs to be loaded before it can be available.%0 - - - - - MessageId: MF_E_ASF_TOO_MANY_PAYLOADS - - MessageText: - - The packet has reached the maximum number of payloads.%0 - - - - - MessageId: MF_E_ASF_UNSUPPORTED_STREAM_TYPE - - MessageText: - - Stream type is not supported.%0 - - - - - MessageId: MF_E_ASF_DROPPED_PACKET - - MessageText: - - One or more ASF packets were dropped.%0 - - - - - MessageId: MF_E_NO_EVENTS_AVAILABLE - - MessageText: - - There are no events available in the queue.%0 - - - - - MessageId: MF_E_INVALID_STATE_TRANSITION - - MessageText: - - A media source cannot go from the stopped state to the paused state.%0 - - - - - MessageId: MF_E_END_OF_STREAM - - MessageText: - - The media stream cannot process any more samples because there are no more samples in the stream.%0 - - - - - MessageId: MF_E_SHUTDOWN - - MessageText: - - The request is invalid because Shutdown() has been called.%0 - - - - - MessageId: MF_E_MP3_NOTFOUND - - MessageText: - - The MP3 object was not found.%0 - - - - - MessageId: MF_E_MP3_OUTOFDATA - - MessageText: - - The MP3 parser ran out of data before finding the MP3 object.%0 - - - - - MessageId: MF_E_MP3_NOTMP3 - - MessageText: - - The file is not really a MP3 file.%0 - - - - - MessageId: MF_E_MP3_NOTSUPPORTED - - MessageText: - - The MP3 file is not supported.%0 - - - - - MessageId: MF_E_NO_DURATION - - MessageText: - - The Media stream has no duration.%0 - - - - - MessageId: MF_E_INVALID_FORMAT - - MessageText: - - The Media format is recognized but is invalid.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_FOUND - - MessageText: - - The property requested was not found.%0 - - - - - MessageId: MF_E_PROPERTY_READ_ONLY - - MessageText: - - The property is read only.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_ALLOWED - - MessageText: - - The specified property is not allowed in this context.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NOT_STARTED - - MessageText: - - The media source is not started.%0 - - - - - MessageId: MF_E_UNSUPPORTED_FORMAT - - MessageText: - - The Media format is recognized but not supported.%0 - - - - - MessageId: MF_E_MP3_BAD_CRC - - MessageText: - - The MPEG frame has bad CRC.%0 - - - - - MessageId: MF_E_NOT_PROTECTED - - MessageText: - - The file is not protected.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_WRONGSTATE - - MessageText: - - The media source is in the wrong state%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED - - MessageText: - - No streams are selected in source presentation descriptor.%0 - - - - - MessageId: MF_E_CANNOT_FIND_KEYFRAME_SAMPLE - - MessageText: - - No key frame sample was found.%0 - - - - - MessageId: MF_E_NETWORK_RESOURCE_FAILURE - - MessageText: - - An attempt to acquire a network resource failed.%0 - - - - - MessageId: MF_E_NET_WRITE - - MessageText: - - Error writing to the network.%0 - - - - - MessageId: MF_E_NET_READ - - MessageText: - - Error reading from the network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_NETWORK - - MessageText: - - Internal. Entry cannot complete operation without network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_ASYNC - - MessageText: - - Internal. Async op is required.%0 - - - - - MessageId: MF_E_NET_BWLEVEL_NOT_SUPPORTED - - MessageText: - - Internal. Bandwidth levels are not supported.%0 - - - - - MessageId: MF_E_NET_STREAMGROUPS_NOT_SUPPORTED - - MessageText: - - Internal. Stream groups are not supported.%0 - - - - - MessageId: MF_E_NET_MANUALSS_NOT_SUPPORTED - - MessageText: - - Manual stream selection is not supported.%0 - - - - - MessageId: MF_E_NET_INVALID_PRESENTATION_DESCRIPTOR - - MessageText: - - Invalid presentation descriptor.%0 - - - - - MessageId: MF_E_NET_CACHESTREAM_NOT_FOUND - - MessageText: - - Cannot find cache stream.%0 - - - - - MessageId: MF_I_MANUAL_PROXY - - MessageText: - - The proxy setting is manual.%0 - - - - duplicate removed - MessageId=17011 Severity=Informational Facility=MEDIAFOUNDATION SymbolicName=MF_E_INVALID_REQUEST - Language=English - The request is invalid in the current state.%0 - . - - MessageId: MF_E_NET_REQUIRE_INPUT - - MessageText: - - Internal. Entry cannot complete operation without input.%0 - - - - - MessageId: MF_E_NET_REDIRECT - - MessageText: - - The client redirected to another server.%0 - - - - - MessageId: MF_E_NET_REDIRECT_TO_PROXY - - MessageText: - - The client is redirected to a proxy server.%0 - - - - - MessageId: MF_E_NET_TOO_MANY_REDIRECTS - - MessageText: - - The client reached maximum redirection limit.%0 - - - - - MessageId: MF_E_NET_TIMEOUT - - MessageText: - - The server, a computer set up to offer multimedia content to other computers, could not handle your request for multimedia content in a timely manner. Please try again later.%0 - - - - - MessageId: MF_E_NET_CLIENT_CLOSE - - MessageText: - - The control socket is closed by the client.%0 - - - - - MessageId: MF_E_NET_BAD_CONTROL_DATA - - MessageText: - - The server received invalid data from the client on the control connection.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_SERVER - - MessageText: - - The server is not a compatible streaming media server.%0 - - - - - MessageId: MF_E_NET_UNSAFE_URL - - MessageText: - - Url.%0 - - - - - MessageId: MF_E_NET_CACHE_NO_DATA - - MessageText: - - Data is not available.%0 - - - - - MessageId: MF_E_NET_EOL - - MessageText: - - End of line.%0 - - - - - MessageId: MF_E_NET_BAD_REQUEST - - MessageText: - - The request could not be understood by the server.%0 - - - - - MessageId: MF_E_NET_INTERNAL_SERVER_ERROR - - MessageText: - - The server encountered an unexpected condition which prevented it from fulfilling the request.%0 - - - - - MessageId: MF_E_NET_SESSION_NOT_FOUND - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_NET_NOCONNECTION - - MessageText: - - There is no connection established with the Windows Media server. The operation failed.%0 - - - - - MessageId: MF_E_NET_CONNECTION_FAILURE - - MessageText: - - The network connection has failed.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_PUSHSERVER - - MessageText: - - The Server service that received the HTTP push request is not a compatible version of Windows Media Services (WMS). This error may indicate the push request was received by IIS instead of WMS. Ensure WMS is started and has the HTTP Server control protocol properly enabled and try again.%0 - - - - - MessageId: MF_E_NET_SERVER_ACCESSDENIED - - MessageText: - - The Windows Media server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_PROXY_ACCESSDENIED - - MessageText: - - The proxy server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_CANNOTCONNECT - - MessageText: - - Unable to establish a connection to the server.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_TEMPLATE - - MessageText: - - The specified push template is invalid.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_PUBLISHING_POINT - - MessageText: - - The specified push publishing point is invalid.%0 - - - - - MessageId: MF_E_NET_BUSY - - MessageText: - - The requested resource is in use.%0 - - - - - MessageId: MF_E_NET_RESOURCE_GONE - - MessageText: - - The Publishing Point or file on the Windows Media Server is no longer available.%0 - - - - - MessageId: MF_E_NET_ERROR_FROM_PROXY - - MessageText: - - The proxy experienced an error while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_PROXY_TIMEOUT - - MessageText: - - The proxy did not receive a timely response while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_SERVER_UNAVAILABLE - - MessageText: - - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.%0 - - - - - MessageId: MF_E_NET_TOO_MUCH_DATA - - MessageText: - - The encoding process was unable to keep up with the amount of supplied data.%0 - - - - - MessageId: MF_E_NET_SESSION_INVALID - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_OFFLINE_MODE - - MessageText: - - The requested URL is not available in offline mode.%0 - - - - - MessageId: MF_E_NET_UDP_BLOCKED - - MessageText: - - A device in the network is blocking UDP traffic.%0 - - - - - MessageId: MF_E_NET_UNSUPPORTED_CONFIGURATION - - MessageText: - - The specified configuration value is not supported.%0 - - - - - MessageId: MF_E_NET_PROTOCOL_DISABLED - - MessageText: - - The networking protocol is disabled.%0 - - - - - MessageId: MF_E_ALREADY_INITIALIZED - - MessageText: - - This object has already been initialized and cannot be re-initialized at this time.%0 - - - - - MessageId: MF_E_BANDWIDTH_OVERRUN - - MessageText: - - The amount of data passed in exceeds the given bitrate and buffer window.%0 - - - - - MessageId: MF_E_LATE_SAMPLE - - MessageText: - - The sample was passed in too late to be correctly processed.%0 - - - - - MessageId: MF_E_FLUSH_NEEDED - - MessageText: - - The requested action cannot be carried out until the object is flushed and the queue is emptied.%0 - - - - - MessageId: MF_E_INVALID_PROFILE - - MessageText: - - The profile is invalid.%0 - - - - - MessageId: MF_E_INDEX_NOT_COMMITTED - - MessageText: - - The index that is being generated needs to be committed before the requested action can be carried out.%0 - - - - - MessageId: MF_E_NO_INDEX - - MessageText: - - The index that is necessary for the requested action is not found.%0 - - - - - MessageId: MF_E_CANNOT_INDEX_IN_PLACE - - MessageText: - - The requested index cannot be added in-place to the specified ASF content.%0 - - - - - MessageId: MF_E_MISSING_ASF_LEAKYBUCKET - - MessageText: - - The ASF leaky bucket parameters must be specified in order to carry out this request.%0 - - - - - MessageId: MF_E_INVALID_ASF_STREAMID - - MessageText: - - The stream id is invalid. The valid range for ASF stream id is from 1 to 127.%0 - - - - - MessageId: MF_E_STREAMSINK_REMOVED - - MessageText: - - The requested Stream Sink has been removed and cannot be used.%0 - - - - - MessageId: MF_E_STREAMSINKS_OUT_OF_SYNC - - MessageText: - - The various Stream Sinks in this Media Sink are too far out of sync for the requested action to take place.%0 - - - - - MessageId: MF_E_STREAMSINKS_FIXED - - MessageText: - - Stream Sinks cannot be added to or removed from this Media Sink because its set of streams is fixed.%0 - - - - - MessageId: MF_E_STREAMSINK_EXISTS - - MessageText: - - The given Stream Sink already exists.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_CANCELED - - MessageText: - - Sample allocations have been canceled.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_EMPTY - - MessageText: - - The sample allocator is currently empty, due to outstanding requests.%0 - - - - - MessageId: MF_E_SINK_ALREADYSTOPPED - - MessageText: - - When we try to sopt a stream sink, it is already stopped %0 - - - - - MessageId: MF_E_ASF_FILESINK_BITRATE_UNKNOWN - - MessageText: - - The ASF file sink could not reserve AVIO because the bitrate is unknown.%0 - - - - - MessageId: MF_E_SINK_NO_STREAMS - - MessageText: - - No streams are selected in sink presentation descriptor.%0 - - - - - MessageId: MF_S_SINK_NOT_FINALIZED - - MessageText: - - The sink has not been finalized before shut down. This may cause sink generate a corrupted content.%0 - - - - - MessageId: MF_E_METADATA_TOO_LONG - - MessageText: - - A metadata item was too long to write to the output container.%0 - - - - - MessageId: MF_E_SINK_NO_SAMPLES_PROCESSED - - MessageText: - - The operation failed because no samples were processed by the sink.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_PROCAMP_HW - - MessageText: - - There is no available procamp hardware with which to perform color correction.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_DEINTERLACE_HW - - MessageText: - - There is no available deinterlacing hardware with which to deinterlace the video stream.%0 - - - - - MessageId: MF_E_VIDEO_REN_COPYPROT_FAILED - - MessageText: - - A video stream requires copy protection to be enabled, but there was a failure in attempting to enable copy protection.%0 - - - - - MessageId: MF_E_VIDEO_REN_SURFACE_NOT_SHARED - - MessageText: - - A component is attempting to access a surface for sharing that is not shared.%0 - - - - - MessageId: MF_E_VIDEO_DEVICE_LOCKED - - MessageText: - - A component is attempting to access a shared device that is already locked by another component.%0 - - - - - MessageId: MF_E_NEW_VIDEO_DEVICE - - MessageText: - - The device is no longer available. The handle should be closed and a new one opened.%0 - - - - - MessageId: MF_E_NO_VIDEO_SAMPLE_AVAILABLE - - MessageText: - - A video sample is not currently queued on a stream that is required for mixing.%0 - - - - - MessageId: MF_E_NO_AUDIO_PLAYBACK_DEVICE - - MessageText: - - No audio playback device was found.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_IN_USE - - MessageText: - - The requested audio playback device is currently in use.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_INVALIDATED - - MessageText: - - The audio playback device is no longer present.%0 - - - - - MessageId: MF_E_AUDIO_SERVICE_NOT_RUNNING - - MessageText: - - The audio service is not running.%0 - - - - - MessageId: MF_E_TOPO_INVALID_OPTIONAL_NODE - - MessageText: - - The topology contains an invalid optional node. Possible reasons are incorrect number of outputs and inputs or optional node is at the beginning or end of a segment. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_FIND_DECRYPTOR - - MessageText: - - No suitable transform was found to decrypt the content. %0 - - - - - MessageId: MF_E_TOPO_CODEC_NOT_FOUND - - MessageText: - - No suitable transform was found to encode or decode the content. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_CONNECT - - MessageText: - - Unable to find a way to connect nodes%0 - - - - - MessageId: MF_E_TOPO_UNSUPPORTED - - MessageText: - - Unsupported operations in topoloader%0 - - - - - MessageId: MF_E_TOPO_INVALID_TIME_ATTRIBUTES - - MessageText: - - The topology or its nodes contain incorrectly set time attributes%0 - - - - - MessageId: MF_E_TOPO_LOOPS_IN_TOPOLOGY - - MessageText: - - The topology contains loops, which are unsupported in media foundation topologies%0 - - - - - MessageId: MF_E_TOPO_MISSING_PRESENTATION_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_STREAM_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a stream descriptor%0 - - - - - MessageId: MF_E_TOPO_STREAM_DESCRIPTOR_NOT_SELECTED - - MessageText: - - A stream descriptor was set on a source stream node but it was not selected on the presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_SOURCE - - MessageText: - - A source stream node in the topology does not have a source%0 - - - - - MessageId: MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED - - MessageText: - - The topology loader does not support sink activates on output nodes.%0 - - - - - MessageId: MF_E_SEQUENCER_UNKNOWN_SEGMENT_ID - - MessageText: - - The sequencer cannot find a segment with the given ID.%0\n. - - - - - MessageId: MF_S_SEQUENCER_CONTEXT_CANCELED - - MessageText: - - The context was canceled.%0\n. - - - - - MessageId: MF_E_NO_SOURCE_IN_CACHE - - MessageText: - - Cannot find source in source cache.%0\n. - - - - - MessageId: MF_S_SEQUENCER_SEGMENT_AT_END_OF_STREAM - - MessageText: - - Cannot update topology flags.%0\n. - - - - - MessageId: MF_E_TRANSFORM_TYPE_NOT_SET - - MessageText: - - A valid type has not been set for this stream or a stream that it depends on.%0 - - - - - MessageId: MF_E_TRANSFORM_STREAM_CHANGE - - MessageText: - - A stream change has occurred. Output cannot be produced until the streams have been renegotiated.%0 - - - - - MessageId: MF_E_TRANSFORM_INPUT_REMAINING - - MessageText: - - The transform cannot take the requested action until all of the input data it currently holds is processed or flushed.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_MISSING - - MessageText: - - The transform requires a profile but no profile was supplied or found.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_INVALID_OR_CORRUPT - - MessageText: - - The transform requires a profile but the supplied profile was invalid or corrupt.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_TRUNCATED - - MessageText: - - The transform requires a profile but the supplied profile ended unexpectedly while parsing.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_PID_NOT_RECOGNIZED - - MessageText: - - The property ID does not match any property supported by the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VARIANT_TYPE_WRONG - - MessageText: - - The variant does not have the type expected for this property ID.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_NOT_WRITEABLE - - MessageText: - - An attempt was made to set the value on a read-only property.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_ARRAY_VALUE_WRONG_NUM_DIM - - MessageText: - - The array property value has an unexpected number of dimensions.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_SIZE_WRONG - - MessageText: - - The array or blob property value has an unexpected size.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_OUT_OF_RANGE - - MessageText: - - The property value is out of range for this transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_INCOMPATIBLE - - MessageText: - - The property value is incompatible with some other property or mediatype set on the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_OUTPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set output mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_INPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set input mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_MEDIATYPE_COMBINATION - - MessageText: - - The requested operation is not supported for the currently set combination of mediatypes.%0 - - - - - MessageId: MF_E_TRANSFORM_CONFLICTS_WITH_OTHER_CURRENTLY_ENABLED_FEATURES - - MessageText: - - The requested feature is not supported in combination with some other currently enabled feature.%0 - - - - - MessageId: MF_E_TRANSFORM_NEED_MORE_INPUT - - MessageText: - - The transform cannot produce output until it gets more input samples.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_SPKR_CONFIG - - MessageText: - - The requested operation is not supported for the current speaker configuration.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING - - MessageText: - - The transform cannot accept mediatype changes in the middle of processing.%0 - - - - - MessageId: MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT - - MessageText: - - The caller should not propagate this event to downstream components.%0 - - - - - MessageId: MF_E_UNSUPPORTED_D3D_TYPE - - MessageText: - - The input type is not supported for D3D device.%0 - - - - - MessageId: MF_E_TRANSFORM_ASYNC_LOCKED - - MessageText: - - The caller does not appear to support this transform's asynchronous capabilities.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_INITIALIZE_ACM_DRIVER - - MessageText: - - An audio compression manager driver could not be initialized by the transform.%0 - - - - - MessageId: MF_E_LICENSE_INCORRECT_RIGHTS - - MessageText: - - You are not allowed to open this file. Contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_OUTOFDATE - - MessageText: - - The license for this media file has expired. Get a new license or contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_REQUIRED - - MessageText: - - You need a license to perform the requested operation on this media file.%0 - - - - - MessageId: MF_E_DRM_HARDWARE_INCONSISTENT - - MessageText: - - The licenses for your media files are corrupted. Contact Microsoft product support.%0 - - - - - MessageId: MF_E_NO_CONTENT_PROTECTION_MANAGER - - MessageText: - - The APP needs to provide IMFContentProtectionManager callback to access the protected media file.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NO_RIGHTS - - MessageText: - - Client does not have rights to restore licenses.%0 - - - - - MessageId: MF_E_BACKUP_RESTRICTED_LICENSE - - MessageText: - - Licenses are restricted and hence can not be backed up.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NEEDS_INDIVIDUALIZATION - - MessageText: - - License restore requires machine to be individualized.%0 - - - - - MessageId: MF_S_PROTECTION_NOT_REQUIRED - - MessageText: - - Protection for stream is not required.%0 - - - - - MessageId: MF_E_COMPONENT_REVOKED - - MessageText: - - Component is revoked.%0 - - - - - MessageId: MF_E_TRUST_DISABLED - - MessageText: - - Trusted functionality is currently disabled on this component.%0 - - - - - MessageId: MF_E_WMDRMOTA_NO_ACTION - - MessageText: - - No Action is set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_ALREADY_SET - - MessageText: - - Action is already set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_HEADER_NOT_AVAILABLE - - MessageText: - - DRM Heaader is not available.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_ENCRYPTION_SCHEME_NOT_SUPPORTED - - MessageText: - - Current encryption scheme is not supported.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_MISMATCH - - MessageText: - - Action does not match with current configuration.%0 - - - - - MessageId: MF_E_WMDRMOTA_INVALID_POLICY - - MessageText: - - Invalid policy for WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_POLICY_UNSUPPORTED - - MessageText: - - The policies that the Input Trust Authority requires to be enforced are unsupported by the outputs.%0 - - - - - MessageId: MF_E_OPL_NOT_SUPPORTED - - MessageText: - - The OPL that the license requires to be enforced are not supported by the Input Trust Authority.%0 - - - - - MessageId: MF_E_TOPOLOGY_VERIFICATION_FAILED - - MessageText: - - The topology could not be successfully verified.%0 - - - - - MessageId: MF_E_SIGNATURE_VERIFICATION_FAILED - - MessageText: - - Signature verification could not be completed successfully for this component.%0 - - - - - MessageId: MF_E_DEBUGGING_NOT_ALLOWED - - MessageText: - - Running this process under a debugger while using protected content is not allowed.%0 - - - - - MessageId: MF_E_CODE_EXPIRED - - MessageText: - - MF component has expired.%0 - - - - - MessageId: MF_E_GRL_VERSION_TOO_LOW - - MessageText: - - The current GRL on the machine does not meet the minimum version requirements.%0 - - - - - MessageId: MF_E_GRL_RENEWAL_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any renewal entries for the specified revocation.%0 - - - - - MessageId: MF_E_GRL_EXTENSIBLE_ENTRY_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any extensible entries for the specified extension GUID.%0 - - - - - MessageId: MF_E_KERNEL_UNTRUSTED - - MessageText: - - The kernel isn't secure for high security level content.%0 - - - - - MessageId: MF_E_PEAUTH_UNTRUSTED - - MessageText: - - The response from protected environment driver isn't valid.%0 - - - - - MessageId: MF_E_NON_PE_PROCESS - - MessageText: - - A non-PE process tried to talk to PEAuth.%0 - - - - - MessageId: MF_E_REBOOT_REQUIRED - - MessageText: - - We need to reboot the machine.%0 - - - - - MessageId: MF_S_WAIT_FOR_POLICY_SET - - MessageText: - - Protection for this stream is not guaranteed to be enforced until the MEPolicySet event is fired.%0 - - - - - MessageId: MF_S_VIDEO_DISABLED_WITH_UNKNOWN_SOFTWARE_OUTPUT - - MessageText: - - This video stream is disabled because it is being sent to an unknown software output.%0 - - - - - MessageId: MF_E_GRL_INVALID_FORMAT - - MessageText: - - The GRL file is not correctly formed, it may have been corrupted or overwritten.%0 - - - - - MessageId: MF_E_GRL_UNRECOGNIZED_FORMAT - - MessageText: - - The GRL file is in a format newer than those recognized by this GRL Reader.%0 - - - - - MessageId: MF_E_ALL_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and required all processes that can run protected media to restart.%0 - - - - - MessageId: MF_E_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and the current process needs to restart.%0 - - - - - MessageId: MF_E_USERMODE_UNTRUSTED - - MessageText: - - The user space is untrusted for protected content play.%0 - - - - - MessageId: MF_E_PEAUTH_SESSION_NOT_STARTED - - MessageText: - - PEAuth communication session hasn't been started.%0 - - - - - MessageId: MF_E_PEAUTH_PUBLICKEY_REVOKED - - MessageText: - - PEAuth's public key is revoked.%0 - - - - - MessageId: MF_E_GRL_ABSENT - - MessageText: - - The GRL is absent.%0 - - - - - MessageId: MF_S_PE_TRUSTED - - MessageText: - - The Protected Environment is trusted.%0 - - - - - MessageId: MF_E_PE_UNTRUSTED - - MessageText: - - The Protected Environment is untrusted.%0 - - - - - MessageId: MF_E_PEAUTH_NOT_STARTED - - MessageText: - - The Protected Environment Authorization service (PEAUTH) has not been started.%0 - - - - - MessageId: MF_E_INCOMPATIBLE_SAMPLE_PROTECTION - - MessageText: - - The sample protection algorithms supported by components are not compatible.%0 - - - - - MessageId: MF_E_PE_SESSIONS_MAXED - - MessageText: - - No more protected environment sessions can be supported.%0 - - - - - MessageId: MF_E_HIGH_SECURITY_LEVEL_CONTENT_NOT_ALLOWED - - MessageText: - - WMDRM ITA does not allow protected content with high security level for this release.%0 - - - - - MessageId: MF_E_TEST_SIGNED_COMPONENTS_NOT_ALLOWED - - MessageText: - - WMDRM ITA cannot allow the requested action for the content as one or more components is not properly signed.%0 - - - - - MessageId: MF_E_ITA_UNSUPPORTED_ACTION - - MessageText: - - WMDRM ITA does not support the requested action.%0 - - - - - MessageId: MF_E_ITA_ERROR_PARSING_SAP_PARAMETERS - - MessageText: - - WMDRM ITA encountered an error in parsing the Secure Audio Path parameters.%0 - - - - - MessageId: MF_E_POLICY_MGR_ACTION_OUTOFBOUNDS - - MessageText: - - The Policy Manager action passed in is invalid.%0 - - - - - MessageId: MF_E_BAD_OPL_STRUCTURE_FORMAT - - MessageText: - - The structure specifying Output Protection Level is not the correct format.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_PROTECTION_GUID - - MessageText: - - WMDRM ITA does not recognize the Explicite Analog Video Output Protection guid specified in the license.%0 - - - - - MessageId: MF_E_NO_PMP_HOST - - MessageText: - - IMFPMPHost object not available.%0 - - - - - MessageId: MF_E_ITA_OPL_DATA_NOT_INITIALIZED - - MessageText: - - WMDRM ITA could not initialize the Output Protection Level data.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Analog Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_DIGITAL_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Digital Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_CLOCK_INVALID_CONTINUITY_KEY - - MessageText: - - The continuity key supplied is not currently valid.%0 - - - - - MessageId: MF_E_CLOCK_NO_TIME_SOURCE - - MessageText: - - No Presentation Time Source has been specified.%0 - - - - - MessageId: MF_E_CLOCK_STATE_ALREADY_SET - - MessageText: - - The clock is already in the requested state.%0 - - - - - MessageId: MF_E_CLOCK_NOT_SIMPLE - - MessageText: - - The clock has too many advanced features to carry out the request.%0 - - - - - MessageId: MF_S_CLOCK_STOPPED - - MessageText: - - Timer::SetTimer returns this success code if called happened while timer is stopped. Timer is not going to be dispatched until clock is running%0 - - - - - MessageId: MF_E_NO_MORE_DROP_MODES - - MessageText: - - The component does not support any more drop modes.%0 - - - - - MessageId: MF_E_NO_MORE_QUALITY_LEVELS - - MessageText: - - The component does not support any more quality levels.%0 - - - - - MessageId: MF_E_DROPTIME_NOT_SUPPORTED - - MessageText: - - The component does not support drop time functionality.%0 - - - - - MessageId: MF_E_QUALITYKNOB_WAIT_LONGER - - MessageText: - - Quality Manager needs to wait longer before bumping the Quality Level up.%0 - - - - - MessageId: MF_E_QM_INVALIDSTATE - - MessageText: - - Quality Manager is in an invalid state. Quality Management is off at this moment.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_CONTAINERTYPE - - MessageText: - - No transcode output container type is specified.%0 - - - - - MessageId: MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS - - MessageText: - - The profile does not have a media type configuration for any selected source streams.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_MATCHING_ENCODER - - MessageText: - - Cannot find an encoder MFT that accepts the user preferred output type.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_INITIALIZED - - MessageText: - - Memory allocator is not initialized.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_COMMITED - - MessageText: - - Memory allocator is not committed yet.%0 - - - - - MessageId: MF_E_ALLOCATOR_ALREADY_COMMITED - - MessageText: - - Memory allocator has already been committed.%0 - - - - - MessageId: MF_E_STREAM_ERROR - - MessageText: - - An error occurred in media stream.%0 - - - - - MessageId: MF_E_INVALID_STREAM_STATE - - MessageText: - - Stream is not in a state to handle the request.%0 - - - - - MessageId: MF_E_HW_STREAM_NOT_CONNECTED - - MessageText: - - Hardware stream is not connected yet.%0 - - - - - Main interface for using Media Foundation with NAudio - - - - - initializes MediaFoundation - only needs to be called once per process - - - - - Enumerate the installed MediaFoundation transforms in the specified category - - A category from MediaFoundationTransformCategories - - - - - uninitializes MediaFoundation - - - - - Creates a Media type - - - - - Creates a media type from a WaveFormat - - - - - Creates a memory buffer of the specified size - - Memory buffer size in bytes - The memory buffer - - - - Creates a sample object - - The sample object - - - - Creates a new attributes store - - Initial size - The attributes store - - - - Creates a media foundation byte stream based on a stream object - (usable with WinRT streams) - - The input stream - A media foundation byte stream - - - - Creates a source reader based on a byte stream - - The byte stream - A media foundation source reader - - - - Interop definitions for MediaFoundation - thanks to Lucian Wischik for the initial work on many of these definitions (also various interfaces) - n.b. the goal is to make as much of this internal as possible, and provide - better .NET APIs using the MediaFoundationApi class instead - - - - - Initializes Microsoft Media Foundation. - - - - - Shuts down the Microsoft Media Foundation platform - - - - - Creates an empty media type. - - - - - Initializes a media type from a WAVEFORMATEX structure. - - - - - Converts a Media Foundation audio media type to a WAVEFORMATEX structure. - - TODO: try making second parameter out WaveFormatExtraData - - - - Creates the source reader from a URL. - - - - - Creates the source reader from a byte stream. - - - - - Creates the sink writer from a URL or byte stream. - - - - - Creates a Microsoft Media Foundation byte stream that wraps an IRandomAccessStream object. - - - - - Gets a list of Microsoft Media Foundation transforms (MFTs) that match specified search criteria. - - - - - Creates an empty media sample. - - - - - Allocates system memory and creates a media buffer to manage it. - - - - - Creates an empty attribute store. - - - - - Gets a list of output formats from an audio encoder. - - - - - All streams - - - - - First audio stream - - - - - First video stream - - - - - Media source - - - - - Media Foundation SDK Version - - - - - Media Foundation API Version - - - - - Media Foundation Version - - - - - An abstract base class for simplifying working with Media Foundation Transforms - You need to override the method that actually creates and configures the transform - - - - - The Source Provider - - - - - The Output WaveFormat - - - - - Constructs a new MediaFoundationTransform wrapper - Will read one second at a time - - The source provider for input data to the transform - The desired output format - - - - To be implemented by overriding classes. Create the transform object, set up its input and output types, - and configure any custom properties in here - - An object implementing IMFTrasform - - - - Disposes this MediaFoundation transform - - - - - Disposes this Media Foundation Transform - - - - - Destructor - - - - - The output WaveFormat of this Media Foundation Transform - - - - - Reads data out of the source, passing it through the transform - - Output buffer - Offset within buffer to write to - Desired byte count - Number of bytes read - - - - Attempts to read from the transform - Some useful info here: - http://msdn.microsoft.com/en-gb/library/windows/desktop/aa965264%28v=vs.85%29.aspx#process_data - - - - - - Indicate that the source has been repositioned and completely drain out the transforms buffers - - - - - Media Foundation Transform Categories - - - - - MFT_CATEGORY_VIDEO_DECODER - - - - - MFT_CATEGORY_VIDEO_ENCODER - - - - - MFT_CATEGORY_VIDEO_EFFECT - - - - - MFT_CATEGORY_MULTIPLEXER - - - - - MFT_CATEGORY_DEMULTIPLEXER - - - - - MFT_CATEGORY_AUDIO_DECODER - - - - - MFT_CATEGORY_AUDIO_ENCODER - - - - - MFT_CATEGORY_AUDIO_EFFECT - - - - - MFT_CATEGORY_VIDEO_PROCESSOR - - - - - MFT_CATEGORY_OTHER - - - - - Media Type helper class, simplifying working with IMFMediaType - (will probably change in the future, to inherit from an attributes class) - Currently does not release the COM object, so you must do that yourself - - - - - Wraps an existing IMFMediaType object - - The IMFMediaType object - - - - Creates and wraps a new IMFMediaType object - - - - - Creates and wraps a new IMFMediaType object based on a WaveFormat - - WaveFormat - - - - Tries to get a UINT32 value, returning a default value if it doesn't exist - - Attribute key - Default value - Value or default if key doesn't exist - - - - The Sample Rate (valid for audio media types) - - - - - The number of Channels (valid for audio media types) - - - - - The number of bits per sample (n.b. not always valid for compressed audio types) - - - - - The average bytes per second (valid for audio media types) - - - - - The Media Subtype. For audio, is a value from the AudioSubtypes class - - - - - The Major type, e.g. audio or video (from the MediaTypes class) - - - - - Access to the actual IMFMediaType object - Use to pass to MF APIs or Marshal.ReleaseComObject when you are finished with it - - - - - Major Media Types - http://msdn.microsoft.com/en-us/library/windows/desktop/aa367377%28v=vs.85%29.aspx - - - - - Default - - - - - Audio - - - - - Video - - - - - Protected Media - - - - - Synchronized Accessible Media Interchange (SAMI) captions. - - - - - Script stream - - - - - Still image stream. - - - - - HTML stream. - - - - - Binary stream. - - - - - A stream that contains data files. - - - - - Contains information about an input stream on a Media Foundation transform (MFT) - - - - - Maximum amount of time between an input sample and the corresponding output sample, in 100-nanosecond units. - - - - - Bitwise OR of zero or more flags from the _MFT_INPUT_STREAM_INFO_FLAGS enumeration. - - - - - The minimum size of each input buffer, in bytes. - - - - - Maximum amount of input data, in bytes, that the MFT holds to perform lookahead. - - - - - The memory alignment required for input buffers. If the MFT does not require a specific alignment, the value is zero. - - - - - Defines messages for a Media Foundation transform (MFT). - - - - - Requests the MFT to flush all stored data. - - - - - Requests the MFT to drain any stored data. - - - - - Sets or clears the Direct3D Device Manager for DirectX Video Accereration (DXVA). - - - - - Drop samples - requires Windows 7 - - - - - Command Tick - requires Windows 8 - - - - - Notifies the MFT that streaming is about to begin. - - - - - Notifies the MFT that streaming is about to end. - - - - - Notifies the MFT that an input stream has ended. - - - - - Notifies the MFT that the first sample is about to be processed. - - - - - Marks a point in the stream. This message applies only to asynchronous MFTs. Requires Windows 7 - - - - - Contains information about an output buffer for a Media Foundation transform. - - - - - Output stream identifier. - - - - - Pointer to the IMFSample interface. - - - - - Before calling ProcessOutput, set this member to zero. - - - - - Before calling ProcessOutput, set this member to NULL. - - - - - Contains information about an output stream on a Media Foundation transform (MFT). - - - - - Bitwise OR of zero or more flags from the _MFT_OUTPUT_STREAM_INFO_FLAGS enumeration. - - - - - Minimum size of each output buffer, in bytes. - - - - - The memory alignment required for output buffers. - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The Media Subtype - - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. - - - - - The time stamp of the most recent sample to be encoded. - - - - - The time stamp of the most recent sample given to the media sink. - - - - - The time stamp of the most recent stream tick. - - - - - The system time of the most recent sample request from the media sink. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Contains flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - - - - - The MFT performs asynchronous data processing in software. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. - - - - - The MFT that must be unlocked by the application before use. - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. - - - - - Bitwise OR of all the flags, excluding MFT_ENUM_FLAG_SORTANDFILTER. - - - - - Indicates the status of an input stream on a Media Foundation transform (MFT). - - - - - None - - - - - The input stream can receive more data at this time. - - - - - Describes an input stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of input data must contain complete, unbroken units of data. - - - - - Each media sample that the client provides as input must contain exactly one unit of data, as defined for the MFT_INPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All input samples must be the same size. - - - - - MTF Input Stream Holds buffers - - - - - The MFT does not hold input samples after the IMFTransform::ProcessInput method returns. - - - - - This input stream can be removed by calling IMFTransform::DeleteInputStream. - - - - - This input stream is optional. - - - - - The MFT can perform in-place processing. - - - - - Defines flags for the IMFTransform::ProcessOutput method. - - - - - None - - - - - The MFT can still generate output from this stream without receiving any more input. - - - - - The format has changed on this output stream, or there is a new preferred format for this stream. - - - - - The MFT has removed this output stream. - - - - - There is no sample ready for this stream. - - - - - Indicates whether a Media Foundation transform (MFT) can produce output data. - - - - - None - - - - - There is a sample available for at least one output stream. - - - - - Describes an output stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of output data from the MFT contains complete, unbroken units of data. - - - - - Each output sample contains exactly one unit of data, as defined for the MFT_OUTPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All output samples are the same size. - - - - - The MFT can discard the output data from this output stream, if requested by the client. - - - - - This output stream is optional. - - - - - The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. - - - - - The MFT can either provide output samples for this stream or it can use samples that the client allocates. - - - - - The MFT does not require the client to process the output for this stream. - - - - - The MFT might remove this output stream during streaming. - - - - - Defines flags for processing output samples in a Media Foundation transform (MFT). - - - - - None - - - - - Do not produce output for streams in which the pSample member of the MFT_OUTPUT_DATA_BUFFER structure is NULL. - - - - - Regenerates the last output sample. - - - - - Process Output Status flags - - - - - None - - - - - The Media Foundation transform (MFT) has created one or more new output streams. - - - - - Defines flags for the setting or testing the media type on a Media Foundation transform (MFT). - - - - - None - - - - - Test the proposed media type, but do not set it. - - - - - Represents a MIDI Channel AfterTouch Event. - - - - - Creates a new ChannelAfterTouchEvent from raw MIDI data - - A binary reader - - - - Creates a new Channel After-Touch Event - - Absolute time - Channel - After-touch pressure - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The aftertouch pressure value - - - - - Represents a MIDI control change event - - - - - Reads a control change event from a MIDI stream - - Binary reader on the MIDI stream - - - - Creates a control change event - - Time - MIDI Channel Number - The MIDI Controller - Controller value - - - - Describes this control change event - - A string describing this event - - - - - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The controller number - - - - - The controller value - - - - - Represents a MIDI key signature event event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new Key signature event with the specified data - - - - - Creates a deep clone of this MIDI event. - - - - - Number of sharps or flats - - - - - Major or Minor key - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event - - - - - Gets the type of this meta event - - - - - Empty constructor - - - - - Custom constructor for use by derived types, who will manage the data themselves - - Meta event type - Meta data length - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Reads a meta-event from a stream - - A binary reader based on the stream of MIDI data - A new MetaEvent object - - - - Describes this meta event - - - - - - - - - - MIDI MetaEvent Type - - - - Track sequence number - - - Text event - - - Copyright - - - Sequence track name - - - Track instrument name - - - Lyric - - - Marker - - - Cue point - - - Program (patch) name - - - Device (port) name - - - MIDI Channel (not official?) - - - MIDI Port (not official?) - - - End track - - - Set tempo - - - SMPTE offset - - - Time signature - - - Key signature - - - Sequencer specific - - - - MIDI command codes - - - - Note Off - - - Note On - - - Key After-touch - - - Control change - - - Patch change - - - Channel after-touch - - - Pitch wheel change - - - Sysex message - - - Eox (comes at end of a sysex message) - - - Timing clock (used when synchronization is required) - - - Start sequence - - - Continue sequence - - - Stop sequence - - - Auto-Sensing - - - Meta-event - - - - MidiController enumeration - http://www.midi.org/techspecs/midimessages.php#3 - - - - Bank Select (MSB) - - - Modulation (MSB) - - - Breath Controller - - - Foot controller (MSB) - - - Main volume - - - Pan - - - Expression - - - Bank Select LSB - - - Sustain - - - Portamento On/Off - - - Sostenuto On/Off - - - Soft Pedal On/Off - - - Legato Footswitch - - - Reset all controllers - - - All notes off - - - - Represents an individual MIDI event - - - - The MIDI command code - - - - Creates a MidiEvent from a raw message received using - the MME MIDI In APIs - - The short MIDI message - A new MIDI Event - - - - Constructs a MidiEvent from a BinaryStream - - The binary stream of MIDI data - The previous MIDI event (pass null for first event) - A new MidiEvent - - - - Converts this MIDI event to a short message (32 bit integer) that - can be sent by the Windows MIDI out short message APIs - Cannot be implemented for all MIDI messages - - A short message - - - - Default constructor - - - - - Creates a MIDI event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - - - - Creates a deep clone of this MIDI event. - - - - - The MIDI Channel Number for this event (1-16) - - - - - The Delta time for this event - - - - - The absolute time for this event - - - - - The command code for this event - - - - - Whether this is a note off event - - - - - Whether this is a note on event - - - - - Determines if this is an end track event - - - - - Displays a summary of the MIDI event - - A string containing a brief description of this MIDI event - - - - Utility function that can read a variable length integer from a binary stream - - The binary stream - The integer read - - - - Writes a variable length integer to a binary stream - - Binary stream - The value to write - - - - Exports this MIDI event's data - Overriden in derived classes, but they should call this version - - Absolute time used to calculate delta. - Is updated ready for the next delta calculation - Stream to write to - - - - A helper class to manage collection of MIDI events - It has the ability to organise them in tracks - - - - - Creates a new Midi Event collection - - Initial file type - Delta Ticks Per Quarter Note - - - - The number of tracks - - - - - The absolute time that should be considered as time zero - Not directly used here, but useful for timeshifting applications - - - - - The number of ticks per quarter note - - - - - Gets events on a specified track - - Track number - The list of events - - - - Gets events on a specific track - - Track number - The list of events - - - - Adds a new track - - The new track event list - - - - Adds a new track - - Initial events to add to the new track - The new track event list - - - - Removes a track - - Track number to remove - - - - Clears all events - - - - - The MIDI file type - - - - - Adds an event to the appropriate track depending on file type - - The event to be added - The original (or desired) track number - When adding events in type 0 mode, the originalTrack parameter - is ignored. If in type 1 mode, it will use the original track number to - store the new events. If the original track was 0 and this is a channel based - event, it will create new tracks if necessary and put it on the track corresponding - to its channel number - - - - Sorts, removes empty tracks and adds end track markers - - - - - Gets an enumerator for the lists of track events - - - - - Gets an enumerator for the lists of track events - - - - - Utility class for comparing MidiEvent objects - - - - - Compares two MidiEvents - Sorts by time, with EndTrack always sorted to the end - - - - - Class able to read a MIDI file - - - - - Opens a MIDI file for reading - - Name of MIDI file - - - - MIDI File format - - - - - Opens a MIDI file for reading - - Name of MIDI file - If true will error on non-paired note events - - - - Opens a MIDI file stream for reading - - The input stream containing a MIDI file - If true will error on non-paired note events - - - - The collection of events in this MIDI file - - - - - Number of tracks in this MIDI file - - - - - Delta Ticks Per Quarter Note - - - - - Describes the MIDI file - - A string describing the MIDI file and its events - - - - Exports a MIDI file - - Filename to export to - Events to export - - - - Represents a MIDI in device - - - - - Called when a MIDI message is received - - - - - An invalid MIDI message - - - - - Gets the number of MIDI input devices available in the system - - - - - Opens a specified MIDI in device - - The device number - - - - Closes this MIDI in device - - - - - Closes this MIDI in device - - - - - Start the MIDI in device - - - - - Stop the MIDI in device - - - - - Reset the MIDI in device - - - - - Gets the MIDI in device info - - - - - Closes the MIDI out device - - True if called from Dispose - - - - Cleanup - - - - - MIDI In Device Capabilities - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name - - - - - Support - Reserved - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - MIDI In Message Information - - - - - Create a new MIDI In Message EventArgs - - - - - - - The Raw message received from the MIDI In API - - - - - The raw message interpreted as a MidiEvent - - - - - The timestamp in milliseconds for this message - - - - - MIM_OPEN - - - - - MIM_CLOSE - - - - - MIM_DATA - - - - - MIM_LONGDATA - - - - - MIM_ERROR - - - - - MIM_LONGERROR - - - - - MIM_MOREDATA - - - - - MOM_OPEN - - - - - MOM_CLOSE - - - - - MOM_DONE - - - - - Represents a MIDI message - - - - - Creates a new MIDI message - - Status - Data parameter 1 - Data parameter 2 - - - - Creates a new MIDI message from a raw message - - A packed MIDI message from an MMIO function - - - - Creates a Note On message - - Note number (0 to 127) - Volume (0 to 127) - MIDI channel (1 to 16) - A new MidiMessage object - - - - Creates a Note Off message - - Note number - Volume - MIDI channel (1-16) - A new MidiMessage object - - - - Creates a patch change message - - The patch number - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Creates a Control Change message - - The controller number to change - The value to set the controller to - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Returns the raw MIDI message data - - - - - Represents a MIDI out device - - - - - Gets the number of MIDI devices available in the system - - - - - Gets the MIDI Out device info - - - - - Opens a specified MIDI out device - - The device number - - - - Closes this MIDI out device - - - - - Closes this MIDI out device - - - - - Gets or sets the volume for this MIDI out device - - - - - Resets the MIDI out device - - - - - Sends a MIDI out message - - Message - Parameter 1 - Parameter 2 - - - - Sends a MIDI message to the MIDI out device - - The message to send - - - - Closes the MIDI out device - - True if called from Dispose - - - - Send a long message, for example sysex. - - The bytes to send. - - - - Cleanup - - - - - class representing the capabilities of a MIDI out device - MIDIOUTCAPS: http://msdn.microsoft.com/en-us/library/dd798467%28VS.85%29.aspx - - - - - MIDICAPS_VOLUME - - - - - separate left-right volume control - MIDICAPS_LRVOLUME - - - - - MIDICAPS_CACHE - - - - - MIDICAPS_STREAM - driver supports midiStreamOut directly - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - Returns the number of supported voices - - - - - Gets the polyphony of the device - - - - - Returns true if the device supports all channels - - - - - Queries whether a particular channel is supported - - Channel number to test - True if the channel is supported - - - - Returns true if the device supports patch caching - - - - - Returns true if the device supports separate left and right volume - - - - - Returns true if the device supports MIDI stream out - - - - - Returns true if the device supports volume control - - - - - Returns the type of technology used by this MIDI out device - - - - - Represents the different types of technology used by a MIDI out device - - from mmsystem.h - - - The device is a MIDI port - - - The device is a MIDI synth - - - The device is a square wave synth - - - The device is an FM synth - - - The device is a MIDI mapper - - - The device is a WaveTable synth - - - The device is a software synth - - - - Represents a note MIDI event - - - - - Reads a NoteEvent from a stream of MIDI data - - Binary Reader for the stream - - - - Creates a MIDI Note Event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - MIDI Note Number - MIDI Note Velocity - - - - - - - - - The MIDI note number - - - - - The note velocity - - - - - The note name - - - - - Describes the Note Event - - Note event as a string - - - - - - - - - Represents a MIDI note on event - - - - - Reads a new Note On event from a stream of MIDI data - - Binary reader on the MIDI data stream - - - - Creates a NoteOn event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI note number - MIDI note velocity - MIDI note duration - - - - Creates a deep clone of this MIDI event. - - - - - The associated Note off event - - - - - Get or set the Note Number, updating the off event at the same time - - - - - Get or set the channel, updating the off event at the same time - - - - - The duration of this note - - - There must be a note off event - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI patch change event - - - - - Gets the default MIDI instrument names - - - - - Reads a new patch change event from a MIDI stream - - Binary reader for the MIDI stream - - - - Creates a new patch change event - - Time of the event - Channel number - Patch number - - - - The Patch Number - - - - - Describes this patch change event - - String describing the patch change event - - - - Gets as a short message for sending with the midiOutShortMsg API - - short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI pitch wheel change event - - - - - Reads a pitch wheel change event from a MIDI stream - - The MIDI stream to read from - - - - Creates a new pitch wheel change event - - Absolute event time - Channel - Pitch wheel value - - - - Describes this pitch wheel change event - - String describing this pitch wheel change event - - - - Pitch Wheel Value 0 is minimum, 0x2000 (8192) is default, 0x3FFF (16383) is maximum - - - - - Gets a short message - - Integer to sent as short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event with raw data - - - - - Raw data contained in the meta event - - - - - Creates a meta event with raw data - - - - - Creates a deep clone of this MIDI event. - - - - - Describes this meta event - - - - - - - - - - Represents a Sequencer Specific event - - - - - Reads a new sequencer specific event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new Sequencer Specific event - - The sequencer specific data - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this sequencer specific - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - SMPTE Offset Event - - - - - Creates a new time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a deep clone of this MIDI event. - - - - - Hours - - - - - Minutes - - - - - Seconds - - - - - Frames - - - - - SubFrames - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI sysex message - - - - - Reads a sysex message from a MIDI stream - - Stream of MIDI data - a new sysex message - - - - Creates a deep clone of this MIDI event. - - - - - Describes this sysex message - - A string describing the sysex message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI tempo event - - - - - Reads a new tempo event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new tempo event with specified settings - - Microseconds per quarter note - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Describes this tempo event - - String describing the tempo event - - - - Microseconds per quarter note - - - - - Tempo - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI text event - - - - - Reads a new text event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TextEvent - - The text in this type - MetaEvent type (must be one that is - associated with text data) - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this text event - - - - - The raw contents of this text event - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TimeSignatureEvent - - Time at which to create this event - Numerator - Denominator - Ticks in Metronome Click - No of 32nd Notes in Quarter Click - - - - Creates a deep clone of this MIDI event. - - - - - Numerator (number of beats in a bar) - - - - - Denominator (Beat unit), - 1 means 2, 2 means 4 (crochet), 3 means 8 (quaver), 4 means 16 and 5 means 32 - - - - - Ticks in a metronome click - - - - - Number of 32nd notes in a quarter note - - - - - The time signature - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI track sequence number event event - - - - - Creates a new track sequence number event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a deep clone of this MIDI event. - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Boolean mixer control - - - - - Gets the details for this control - - memory pointer - - - - The current value of the control - - - - - Custom Mixer control - - - - - Get the data for this custom control - - pointer to memory to receive data - - - - List text mixer control - - - - - Get the details for this control - - Memory location to read to - - - Represents a Windows mixer device - - - The number of mixer devices available - - - Connects to the specified mixer - The index of the mixer to use. - This should be between zero and NumberOfDevices - 1 - - - The number of destinations this mixer supports - - - The name of this mixer device - - - The manufacturer code for this mixer device - - - The product identifier code for this mixer device - - - Retrieve the specified MixerDestination object - The ID of the destination to use. - Should be between 0 and DestinationCount - 1 - - - - A way to enumerate the destinations - - - - - A way to enumerate all available devices - - - - - Represents a mixer control - - - - - Mixer Handle - - - - - Number of Channels - - - - - Mixer Handle Type - - - - - Gets all the mixer controls - - Mixer Handle - Mixer Line - Mixer Handle Type - - - - - Gets a specified Mixer Control - - Mixer Handle - Line ID - Control ID - Number of Channels - Flags to use (indicates the meaning of mixerHandle) - - - - - Gets the control details - - - - - Gets the control details - - - - - - Mixer control name - - - - - Mixer control type - - - - - Returns true if this is a boolean control - - Control type - - - - Is this a boolean control - - - - - Determines whether a specified mixer control type is a list text control - - - - - True if this is a list text control - - - - - True if this is a signed control - - - - - True if this is an unsigned control - - - - - True if this is a custom control - - - - - String representation for debug purposes - - - - - Mixer control types - - - - Custom - - - Boolean meter - - - Signed meter - - - Peak meter - - - Unsigned meter - - - Boolean - - - On Off - - - Mute - - - Mono - - - Loudness - - - Stereo Enhance - - - Button - - - Decibels - - - Signed - - - Unsigned - - - Percent - - - Slider - - - Pan - - - Q-sound pan - - - Fader - - - Volume - - - Bass - - - Treble - - - Equaliser - - - Single Select - - - Mux - - - Multiple select - - - Mixer - - - Micro time - - - Milli time - - - - Mixer Interop Flags - - - - - MIXER_OBJECTF_HANDLE = 0x80000000; - - - - - MIXER_OBJECTF_MIXER = 0x00000000; - - - - - MIXER_OBJECTF_HMIXER - - - - - MIXER_OBJECTF_WAVEOUT - - - - - MIXER_OBJECTF_HWAVEOUT - - - - - MIXER_OBJECTF_WAVEIN - - - - - MIXER_OBJECTF_HWAVEIN - - - - - MIXER_OBJECTF_MIDIOUT - - - - - MIXER_OBJECTF_HMIDIOUT - - - - - MIXER_OBJECTF_MIDIIN - - - - - MIXER_OBJECTF_HMIDIIN - - - - - MIXER_OBJECTF_AUX - - - - - MIXER_GETCONTROLDETAILSF_VALUE = 0x00000000; - MIXER_SETCONTROLDETAILSF_VALUE = 0x00000000; - - - - - MIXER_GETCONTROLDETAILSF_LISTTEXT = 0x00000001; - MIXER_SETCONTROLDETAILSF_LISTTEXT = 0x00000001; - - - - - MIXER_GETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_SETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_GETLINECONTROLSF_QUERYMASK = 0x0000000F; - - - - - MIXER_GETLINECONTROLSF_ALL = 0x00000000; - - - - - MIXER_GETLINECONTROLSF_ONEBYID = 0x00000001; - - - - - MIXER_GETLINECONTROLSF_ONEBYTYPE = 0x00000002; - - - - - MIXER_GETLINEINFOF_DESTINATION = 0x00000000; - - - - - MIXER_GETLINEINFOF_SOURCE = 0x00000001; - - - - - MIXER_GETLINEINFOF_LINEID = 0x00000002; - - - - - MIXER_GETLINEINFOF_COMPONENTTYPE = 0x00000003; - - - - - MIXER_GETLINEINFOF_TARGETTYPE = 0x00000004; - - - - - MIXER_GETLINEINFOF_QUERYMASK = 0x0000000F; - - - - - Mixer Line Flags - - - - - Audio line is active. An active line indicates that a signal is probably passing - through the line. - - - - - Audio line is disconnected. A disconnected line's associated controls can still be - modified, but the changes have no effect until the line is connected. - - - - - Audio line is an audio source line associated with a single audio destination line. - If this flag is not set, this line is an audio destination line associated with zero - or more audio source lines. - - - - - BOUNDS structure - - - - - dwMinimum / lMinimum / reserved 0 - - - - - dwMaximum / lMaximum / reserved 1 - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - METRICS structure - - - - - cSteps / reserved[0] - - - - - cbCustomData / reserved[1], number of bytes for control details - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - MIXERCONTROL struct - http://msdn.microsoft.com/en-us/library/dd757293%28VS.85%29.aspx - - - - - Represents a mixer line (source or destination) - - - - - Creates a new mixer destination - - Mixer Handle - Destination Index - Mixer Handle Type - - - - Creates a new Mixer Source For a Specified Source - - Mixer Handle - Destination Index - Source Index - Flag indicating the meaning of mixerHandle - - - - Creates a new Mixer Source - - Wave In Device - - - - Mixer Line Name - - - - - Mixer Line short name - - - - - The line ID - - - - - Component Type - - - - - Mixer destination type description - - - - - Number of channels - - - - - Number of sources - - - - - Number of controls - - - - - Is this destination active - - - - - Is this destination disconnected - - - - - Is this destination a source - - - - - Gets the specified source - - - - - Enumerator for the controls on this Mixer Limne - - - - - Enumerator for the sources on this Mixer Line - - - - - The name of the target output device - - - - - Describes this Mixer Line (for diagnostic purposes) - - - - - Mixer Line Component type enumeration - - - - - Audio line is a destination that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_DST_UNDEFINED - - - - - Audio line is a digital destination (for example, digital input to a DAT or CD audio device). - MIXERLINE_COMPONENTTYPE_DST_DIGITAL - - - - - Audio line is a line level destination (for example, line level input from a CD audio device) that will be the final recording source for the analog-to-digital converter (ADC). Because most audio cards for personal computers provide some sort of gain for the recording audio source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_DST_WAVEIN type. - MIXERLINE_COMPONENTTYPE_DST_LINE - - - - - Audio line is a destination used for a monitor. - MIXERLINE_COMPONENTTYPE_DST_MONITOR - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive speakers. This is the typical component type for the audio output of audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_SPEAKERS - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive headphones. Most audio cards use the same audio destination line for speakers and headphones, in which case the mixer device simply uses the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS type. - MIXERLINE_COMPONENTTYPE_DST_HEADPHONES - - - - - Audio line is a destination that will be routed to a telephone line. - MIXERLINE_COMPONENTTYPE_DST_TELEPHONE - - - - - Audio line is a destination that will be the final recording source for the waveform-audio input (ADC). This line typically provides some sort of gain or attenuation. This is the typical component type for the recording line of most audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_WAVEIN - - - - - Audio line is a destination that will be the final recording source for voice input. This component type is exactly like MIXERLINE_COMPONENTTYPE_DST_WAVEIN but is intended specifically for settings used during voice recording/recognition. Support for this line is optional for a mixer device. Many mixer devices provide only MIXERLINE_COMPONENTTYPE_DST_WAVEIN. - MIXERLINE_COMPONENTTYPE_DST_VOICEIN - - - - - Audio line is a source that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_SRC_UNDEFINED - - - - - Audio line is a digital source (for example, digital output from a DAT or audio CD). - MIXERLINE_COMPONENTTYPE_SRC_DIGITAL - - - - - Audio line is a line-level source (for example, line-level input from an external stereo) that can be used as an optional recording source. Because most audio cards for personal computers provide some sort of gain for the recording source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY type. - MIXERLINE_COMPONENTTYPE_SRC_LINE - - - - - Audio line is a microphone recording source. Most audio cards for personal computers provide at least two types of recording sources: an auxiliary audio line and microphone input. A microphone audio line typically provides some sort of gain. Audio cards that use a single input for use with a microphone or auxiliary audio line should use the MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE component type. - MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE - - - - - Audio line is a source originating from the output of an internal synthesizer. Most audio cards for personal computers provide some sort of MIDI synthesizer (for example, an Adlib®-compatible or OPL/3 FM synthesizer). - MIXERLINE_COMPONENTTYPE_SRC_SYNTHESIZER - - - - - Audio line is a source originating from the output of an internal audio CD. This component type is provided for audio cards that provide an audio source line intended to be connected to an audio CD (or CD-ROM playing an audio CD). - MIXERLINE_COMPONENTTYPE_SRC_COMPACTDISC - - - - - Audio line is a source originating from an incoming telephone line. - MIXERLINE_COMPONENTTYPE_SRC_TELEPHONE - - - - - Audio line is a source originating from personal computer speaker. Several audio cards for personal computers provide the ability to mix what would typically be played on the internal speaker with the output of an audio card. Some audio cards support the ability to use this output as a recording source. - MIXERLINE_COMPONENTTYPE_SRC_PCSPEAKER - - - - - Audio line is a source originating from the waveform-audio output digital-to-analog converter (DAC). Most audio cards for personal computers provide this component type as a source to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination. Some cards also allow this source to be routed to the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_WAVEOUT - - - - - Audio line is a source originating from the auxiliary audio line. This line type is intended as a source with gain or attenuation that can be routed to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination and/or recorded from the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY - - - - - Audio line is an analog source (for example, analog output from a video-cassette tape). - MIXERLINE_COMPONENTTYPE_SRC_ANALOG - - - - - Represents a signed mixer control - - - - - Gets details for this contrl - - - - - The value of the control - - - - - Minimum value for this control - - - - - Maximum value for this control - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - - Represents an unsigned mixer control - - - - - Gets the details for this control - - - - - The control value - - - - - The control's minimum value - - - - - The control's maximum value - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - Helper methods for working with audio buffers - - - - - Ensures the buffer is big enough - - - - - - - - Ensures the buffer is big enough - - - - - - - - these will become extension methods once we move to .NET 3.5 - - - - - Checks if the buffer passed in is entirely full of nulls - - - - - Converts to a string containing the buffer described in hex - - - - - Decodes the buffer using the specified encoding, stopping at the first null - - - - - Concatenates the given arrays into a single array. - - The arrays to concatenate - The concatenated resulting array. - - - - An encoding for use with file types that have one byte per character - - - - - The one and only instance of this class - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Chunk Identifier helpers - - - - - Chunk identifier to Int32 (replaces mmioStringToFOURCC) - - four character chunk identifier - Chunk identifier as int 32 - - - - A very basic circular buffer implementation - - - - - Create a new circular buffer - - Max buffer size in bytes - - - - Write data to the buffer - - Data to write - Offset into data - Number of bytes to write - number of bytes written - - - - Read from the buffer - - Buffer to read into - Offset into read buffer - Bytes to read - Number of bytes actually read - - - - Maximum length of this circular buffer - - - - - Number of bytes currently stored in the circular buffer - - - - - Resets the buffer - - - - - Advances the buffer, discarding bytes - - Bytes to advance - - - - A util class for conversions - - - - - linear to dB conversion - - linear value - decibel value - - - - dB to linear conversion - - decibel value - linear value - - - - Allows us to add descriptions to interop members - - - - - The description - - - - - Field description - - - - - String representation - - - - - - Helper to get descriptions - - - - - Describes the Guid by looking for a FieldDescription attribute on the specified class - - - - - HResult - - - - - S_OK - - - - - S_FALSE - - - - - E_INVALIDARG (from winerror.h) - - - - - MAKE_HRESULT macro - - - - - Helper to deal with the fact that in Win Store apps, - the HResult property name has changed - - COM Exception - The HResult - - - - Methods for converting between IEEE 80-bit extended double precision - and standard C# double precision. - - - - - Converts a C# double precision number to an 80-bit - IEEE extended double precision number (occupying 10 bytes). - - The double precision number to convert to IEEE extended. - An array of 10 bytes containing the IEEE extended number. - - - - Converts an IEEE 80-bit extended precision number to a - C# double precision number. - - The 80-bit IEEE extended number (as an array of 10 bytes). - A C# double precision number that is a close representation of the IEEE extended number. - - - - Pass-through stream that ignores Dispose - Useful for dealing with MemoryStreams that you want to re-use - - - - - The source stream all other methods fall through to - - - - - If true the Dispose will be ignored, if false, will pass through to the SourceStream - Set to true by default - - - - - Creates a new IgnoreDisposeStream - - The source stream - - - - Can Read - - - - - Can Seek - - - - - Can write to the underlying stream - - - - - Flushes the underlying stream - - - - - Gets the length of the underlying stream - - - - - Gets or sets the position of the underlying stream - - - - - Reads from the underlying stream - - - - - Seeks on the underlying stream - - - - - Sets the length of the underlying stream - - - - - Writes to the underlying stream - - - - - Dispose - by default (IgnoreDispose = true) will do nothing, - leaving the underlying stream undisposed - - - - - Support for Marshal Methods in both UWP and .NET 3.5 - - - - - SizeOf a structure - - - - - Offset of a field in a structure - - - - - Pointer to Structure - - - - - In-place and stable implementation of MergeSort - - - - - MergeSort a list of comparable items - - - - - MergeSort a list - - - - - General purpose native methods for internal NAudio use - - - - - A thread-safe Progress Log Control - - - - - Creates a new progress log control - - - - - The contents of the log as text - - - - - Log a message - - - - - Clear the log - - - - - Required designer variable. - - - - - Clean up any resources being used. - - true if managed resources should be disposed; otherwise, false. - - - - Required method for Designer support - do not modify - the contents of this method with the code editor. - - - - - WavePosition extension methods - - - - - Get Position as timespan - - - - - Manufacturer codes from mmreg.h - - - - Microsoft Corporation - - - Creative Labs, Inc - - - Media Vision, Inc. - - - Fujitsu Corp. - - - Artisoft, Inc. - - - Turtle Beach, Inc. - - - IBM Corporation - - - Vocaltec LTD. - - - Roland - - - DSP Solutions, Inc. - - - NEC - - - ATI - - - Wang Laboratories, Inc - - - Tandy Corporation - - - Voyetra - - - Antex Electronics Corporation - - - ICL Personal Systems - - - Intel Corporation - - - Advanced Gravis - - - Video Associates Labs, Inc. - - - InterActive Inc - - - Yamaha Corporation of America - - - Everex Systems, Inc - - - Echo Speech Corporation - - - Sierra Semiconductor Corp - - - Computer Aided Technologies - - - APPS Software International - - - DSP Group, Inc - - - microEngineering Labs - - - Computer Friends, Inc. - - - ESS Technology - - - Audio, Inc. - - - Motorola, Inc. - - - Canopus, co., Ltd. - - - Seiko Epson Corporation - - - Truevision - - - Aztech Labs, Inc. - - - Videologic - - - SCALACS - - - Korg Inc. - - - Audio Processing Technology - - - Integrated Circuit Systems, Inc. - - - Iterated Systems, Inc. - - - Metheus - - - Logitech, Inc. - - - Winnov, Inc. - - - NCR Corporation - - - EXAN - - - AST Research Inc. - - - Willow Pond Corporation - - - Sonic Foundry - - - Vitec Multimedia - - - MOSCOM Corporation - - - Silicon Soft, Inc. - - - Supermac - - - Audio Processing Technology - - - Speech Compression - - - Ahead, Inc. - - - Dolby Laboratories - - - OKI - - - AuraVision Corporation - - - Ing C. Olivetti & C., S.p.A. - - - I/O Magic Corporation - - - Matsushita Electric Industrial Co., LTD. - - - Control Resources Limited - - - Xebec Multimedia Solutions Limited - - - New Media Corporation - - - Natural MicroSystems - - - Lyrrus Inc. - - - Compusic - - - OPTi Computers Inc. - - - Adlib Accessories Inc. - - - Compaq Computer Corp. - - - Dialogic Corporation - - - InSoft, Inc. - - - M.P. Technologies, Inc. - - - Weitek - - - Lernout & Hauspie - - - Quanta Computer Inc. - - - Apple Computer, Inc. - - - Digital Equipment Corporation - - - Mark of the Unicorn - - - Workbit Corporation - - - Ositech Communications Inc. - - - miro Computer Products AG - - - Cirrus Logic - - - ISOLUTION B.V. - - - Horizons Technology, Inc - - - Computer Concepts Ltd - - - Voice Technologies Group, Inc. - - - Radius - - - Rockwell International - - - Co. XYZ for testing - - - Opcode Systems - - - Voxware Inc - - - Northern Telecom Limited - - - APICOM - - - Grande Software - - - ADDX - - - Wildcat Canyon Software - - - Rhetorex Inc - - - Brooktree Corporation - - - ENSONIQ Corporation - - - FAST Multimedia AG - - - NVidia Corporation - - - OKSORI Co., Ltd. - - - DiAcoustics, Inc. - - - Gulbransen, Inc. - - - Kay Elemetrics, Inc. - - - Crystal Semiconductor Corporation - - - Splash Studios - - - Quarterdeck Corporation - - - TDK Corporation - - - Digital Audio Labs, Inc. - - - Seer Systems, Inc. - - - PictureTel Corporation - - - AT&T Microelectronics - - - Osprey Technologies, Inc. - - - Mediatrix Peripherals - - - SounDesignS M.C.S. Ltd. - - - A.L. Digital Ltd. - - - Spectrum Signal Processing, Inc. - - - Electronic Courseware Systems, Inc. - - - AMD - - - Core Dynamics - - - CANAM Computers - - - Softsound, Ltd. - - - Norris Communications, Inc. - - - Danka Data Devices - - - EuPhonics - - - Precept Software, Inc. - - - Crystal Net Corporation - - - Chromatic Research, Inc - - - Voice Information Systems, Inc - - - Vienna Systems - - - Connectix Corporation - - - Gadget Labs LLC - - - Frontier Design Group LLC - - - Viona Development GmbH - - - Casio Computer Co., LTD - - - Diamond Multimedia - - - S3 - - - Fraunhofer - - - - Summary description for MmException. - - - - - Creates a new MmException - - The result returned by the Windows API call - The name of the Windows API that failed - - - - Helper function to automatically raise an exception on failure - - The result of the API call - The API function name - - - - Returns the Windows API result - - - - - Windows multimedia error codes from mmsystem.h. - - - - no error, MMSYSERR_NOERROR - - - unspecified error, MMSYSERR_ERROR - - - device ID out of range, MMSYSERR_BADDEVICEID - - - driver failed enable, MMSYSERR_NOTENABLED - - - device already allocated, MMSYSERR_ALLOCATED - - - device handle is invalid, MMSYSERR_INVALHANDLE - - - no device driver present, MMSYSERR_NODRIVER - - - memory allocation error, MMSYSERR_NOMEM - - - function isn't supported, MMSYSERR_NOTSUPPORTED - - - error value out of range, MMSYSERR_BADERRNUM - - - invalid flag passed, MMSYSERR_INVALFLAG - - - invalid parameter passed, MMSYSERR_INVALPARAM - - - handle being used simultaneously on another thread (eg callback),MMSYSERR_HANDLEBUSY - - - specified alias not found, MMSYSERR_INVALIDALIAS - - - bad registry database, MMSYSERR_BADDB - - - registry key not found, MMSYSERR_KEYNOTFOUND - - - registry read error, MMSYSERR_READERROR - - - registry write error, MMSYSERR_WRITEERROR - - - registry delete error, MMSYSERR_DELETEERROR - - - registry value not found, MMSYSERR_VALNOTFOUND - - - driver does not call DriverCallback, MMSYSERR_NODRIVERCB - - - more data to be returned, MMSYSERR_MOREDATA - - - unsupported wave format, WAVERR_BADFORMAT - - - still something playing, WAVERR_STILLPLAYING - - - header not prepared, WAVERR_UNPREPARED - - - device is synchronous, WAVERR_SYNC - - - Conversion not possible (ACMERR_NOTPOSSIBLE) - - - Busy (ACMERR_BUSY) - - - Header Unprepared (ACMERR_UNPREPARED) - - - Cancelled (ACMERR_CANCELED) - - - invalid line (MIXERR_INVALLINE) - - - invalid control (MIXERR_INVALCONTROL) - - - invalid value (MIXERR_INVALVALUE) - - - diff --git a/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.dll b/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.dll deleted file mode 100644 index a709fe0..0000000 Binary files a/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.dll and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.xml b/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.xml deleted file mode 100644 index 1b4c3c3..0000000 --- a/packages/NAudio.1.10.0/lib/netstandard2.0/NAudio.xml +++ /dev/null @@ -1,23957 +0,0 @@ - - - - NAudio - - - - - a-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts an a-law encoded byte to a 16 bit linear sample - - a-law encoded byte - Linear sample - - - - A-law encoder - - - - - Encodes a single 16 bit sample to a-law - - 16 bit PCM sample - a-law encoded byte - - - - SpanDSP - a series of DSP components for telephony - - g722_decode.c - The ITU G.722 codec, decode part. - - Written by Steve Underwood <steveu@coppice.org> - - Copyright (C) 2005 Steve Underwood - Ported to C# by Mark Heath 2011 - - Despite my general liking of the GPL, I place my own contributions - to this code in the public domain for the benefit of all mankind - - even the slimy ones who might try to proprietize my work and use it - to my detriment. - - Based in part on a single channel G.722 codec which is: - Copyright (c) CMU 1993 - Computer Science, Speech Group - Chengxiang Lu and Alex Hauptmann - - - - - hard limits to 16 bit samples - - - - - Decodes a buffer of G722 - - Codec state - Output buffer (to contain decompressed PCM samples) - - Number of bytes in input G722 data to decode - Number of samples written into output buffer - - - - Encodes a buffer of G722 - - Codec state - Output buffer (to contain encoded G722) - PCM 16 bit samples to encode - Number of samples in the input buffer to encode - Number of encoded bytes written into output buffer - - - - Stores state to be used between calls to Encode or Decode - - - - - ITU Test Mode - TRUE if the operating in the special ITU test mode, with the band split filters disabled. - - - - - TRUE if the G.722 data is packed - - - - - 8kHz Sampling - TRUE if encode from 8k samples/second - - - - - Bits Per Sample - 6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps. - - - - - Signal history for the QMF (x) - - - - - Band - - - - - In bit buffer - - - - - Number of bits in InBuffer - - - - - Out bit buffer - - - - - Number of bits in OutBuffer - - - - - Creates a new instance of G722 Codec State for a - new encode or decode session - - Bitrate (typically 64000) - Special options - - - - Band data for G722 Codec - - - - s - - - sp - - - sz - - - r - - - a - - - ap - - - p - - - d - - - b - - - bp - - - sg - - - nb - - - det - - - - G722 Flags - - - - - None - - - - - Using a G722 sample rate of 8000 - - - - - Packed - - - - - mu-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts a mu-law encoded byte to a 16 bit linear sample - - mu-law encoded byte - Linear sample - - - - mu-law encoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - Encodes a single 16 bit sample to mu-law - - 16 bit PCM sample - mu-law encoded byte - - - - Audio Capture Client - - - - - Gets a pointer to the buffer - - Pointer to the buffer - - - - Gets a pointer to the buffer - - Number of frames to read - Buffer flags - Pointer to the buffer - - - - Gets the size of the next packet - - - - - Release buffer - - Number of frames written - - - - Release the COM object - - - - - Windows CoreAudio AudioClient - - - - - Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams. - Can be called before initialize - - - - - Initializes the Audio Client - - Share Mode - Stream Flags - Buffer Duration - Periodicity - Wave Format - Audio Session GUID (can be null) - - - - Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first) - - - - - Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized. - - - - - Retrieves the number of frames of padding in the endpoint buffer (must initialize first) - - - - - Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer. - (can be called before initialize) - - - - - Gets the minimum device period - (can be called before initialize) - - - - - Returns the AudioStreamVolume service for this AudioClient. - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Gets the AudioClockClient service - - - - - Gets the AudioRenderClient service - - - - - Gets the AudioCaptureClient service - - - - - Determines whether if the specified output format is supported - - The share mode. - The desired format. - True if the format is supported - - - - Determines if the specified output format is supported in shared mode - - Share Mode - Desired Format - Output The closest match format. - True if the format is supported - - - - Starts the audio stream - - - - - Stops the audio stream. - - - - - Set the Event Handle for buffer synchro. - - The Wait Handle to setup - - - - Resets the audio stream - Reset is a control method that the client calls to reset a stopped audio stream. - Resetting the stream flushes all pending data and resets the audio clock stream - position to 0. This method fails if it is called on a stream that is not stopped - - - - - Dispose - - - - - Audio Client Buffer Flags - - - - - None - - - - - AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY - - - - - AUDCLNT_BUFFERFLAGS_SILENT - - - - - AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR - - - - - The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream. - - http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx - - - - The size of the buffer for the audio stream. - - - - - Boolean value to indicate whether or not the audio stream is hardware-offloaded - - - - - An enumeration that is used to specify the category of the audio stream. - - - - - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - - AUDCLNT_SHAREMODE - - - - - AUDCLNT_SHAREMODE_SHARED, - - - - - AUDCLNT_SHAREMODE_EXCLUSIVE - - - - - AUDCLNT_STREAMFLAGS - - - - - None - - - - - AUDCLNT_STREAMFLAGS_CROSSPROCESS - - - - - AUDCLNT_STREAMFLAGS_LOOPBACK - - - - - AUDCLNT_STREAMFLAGS_EVENTCALLBACK - - - - - AUDCLNT_STREAMFLAGS_NOPERSIST - - - - - Defines values that describe the characteristics of an audio stream. - - - - - No stream options. - - - - - The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware. - - - - - Audio Clock Client - - - - - Characteristics - - - - - Frequency - - - - - Get Position - - - - - Adjusted Position - - - - - Can Adjust Position - - - - - Dispose - - - - - Audio Endpoint Volume - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - On Volume Notification - - - - - Volume Range - - - - - Hardware Support - - - - - Step Information - - - - - Channels - - - - - Master Volume Level - - - - - Master Volume Level Scalar - - - - - Mute - - - - - Volume Step Up - - - - - Volume Step Down - - - - - Creates a new Audio endpoint volume - - IAudioEndpointVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Audio Endpoint Volume Channel - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - Volume Level - - - - - Volume Level Scalar - - - - - Audio Endpoint Volume Channels - - - - - Channel Count - - - - - Indexer - get a specific channel - - - - - Audio Endpoint Volume Notifiaction Delegate - - Audio Volume Notification Data - - - - Audio Endpoint Volume Step Information - - - - - Step - - - - - StepCount - - - - - Audio Endpoint Volume Volume Range - - - - - Minimum Decibels - - - - - Maximum Decibels - - - - - Increment Decibels - - - - - Audio Meter Information - - - - - Peak Values - - - - - Hardware Support - - - - - Master Peak Value - - - - - Audio Meter Information Channels - - - - - Metering Channel Count - - - - - Get Peak value - - Channel index - Peak value - - - - Audio Render Client - - - - - Gets a pointer to the buffer - - Number of frames requested - Pointer to the buffer - - - - Release buffer - - Number of frames written - Buffer flags - - - - Release the COM object - - - - - AudioSessionControl object for information - regarding an audio session - - - - - Constructor. - - - - - - Dispose - - - - - Finalizer - - - - - Audio meter information of the audio session. - - - - - Simple audio volume of the audio session (for volume and mute status). - - - - - The current state of the audio session. - - - - - The name of the audio session. - - - - - the path to the icon shown in the mixer. - - - - - The session identifier of the audio session. - - - - - The session instance identifier of the audio session. - - - - - The process identifier of the audio session. - - - - - Is the session a system sounds session. - - - - - the grouping param for an audio session grouping - - - - - - For chanigng the grouping param and supplying the context of said change - - - - - - - Registers an even client for callbacks - - - - - - Unregisters an event client from receiving callbacks - - - - - - AudioSessionEvents callback implementation - - - - - Constructor. - - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - AudioSessionManager - - Designed to manage audio sessions and in particuar the - SimpleAudioVolume interface to adjust a session volume - - - - - Session created delegate - - - - - Occurs when audio session has been added (for example run another program that use audio playback). - - - - - SimpleAudioVolume object - for adjusting the volume for the user session - - - - - AudioSessionControl object - for registring for callbacks and other session information - - - - - Refresh session of current device. - - - - - Returns list of sessions of current device. - - - - - Dispose. - - - - - Finalizer. - - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Manages the AudioStreamVolume for the . - - - - - Verify that the channel index is valid. - - - - - - - Return the current stream volumes for all channels - - An array of volume levels between 0.0 and 1.0 for each channel in the audio stream. - - - - Returns the current number of channels in this audio stream. - - - - - Return the current volume for the requested channel. - - The 0 based index into the channels. - The volume level for the channel between 0.0 and 1.0. - - - - Set the volume level for each channel of the audio stream. - - An array of volume levels (between 0.0 and 1.0) one for each channel. - - A volume level MUST be supplied for reach channel in the audio stream. - - - Thrown when does not contain elements. - - - - - Sets the volume level for one channel in the audio stream. - - The 0-based index into the channels to adjust the volume of. - The volume level between 0.0 and 1.0 for this channel of the audio stream. - - - - Dispose - - - - - Release/cleanup objects during Dispose/finalization. - - True if disposing and false if being finalized. - - - - Audio Volume Notification Data - - - - - Event Context - - - - - Muted - - - - - Guid that raised the event - - - - - Master Volume - - - - - Channels - - - - - Channel Volume - - - - - Audio Volume Notification Data - - - - - - - - - - Connector - - - - - Connects this connector to a connector in another device-topology object - - - - - Retreives the type of this connector - - - - - Retreives the data flow of this connector - - - - - Disconnects this connector from it's connected connector (if connected) - - - - - Indicates whether this connector is connected to another connector - - - - - Retreives the connector this connector is connected to (if connected) - - - - - Retreives the global ID of the connector this connector is connected to (if connected) - - - - - Retreives the device ID of the audio device this connector is connected to (if connected) - - - - - Connector Type - - - - - The connector is part of a connection of unknown type. - - - - - The connector is part of a physical connection to an auxiliary device that is installed inside the system chassis - - - - - The connector is part of a physical connection to an external device. - - - - - The connector is part of a software-configured I/O connection (typically a DMA channel) between system memory and an audio hardware device on an audio adapter. - - - - - The connector is part of a permanent connection that is fixed and cannot be configured under software control. - - - - - The connector is part of a connection to a network. - - - - - The EDataFlow enumeration defines constants that indicate the direction - in which audio data flows between an audio endpoint device and an application - - - - - Audio rendering stream. - Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, - to the application - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio - endpoint device, or from the audio endpoint device to the application. - - - - - Device State - - - - - DEVICE_STATE_ACTIVE - - - - - DEVICE_STATE_DISABLED - - - - - DEVICE_STATE_NOTPRESENT - - - - - DEVICE_STATE_UNPLUGGED - - - - - DEVICE_STATEMASK_ALL - - - - - Windows CoreAudio DeviceTopology - - - - - Retrieves the number of connections associated with this device-topology object - - - - - Retrieves the connector at the supplied index - - - - - Retrieves the device id of the device represented by this device-topology object - - - - - Endpoint Hardware Support - - - - - Volume - - - - - Mute - - - - - Meter - - - - - Representation of binary large object container. - - - - - Length of binary object. - - - - - Pointer to buffer storing data. - - - - - is defined in WTypes.h - - - - - Audio Client WASAPI Error Codes (HResult) - - - - - AUDCLNT_E_NOT_INITIALIZED - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_IN_USE - - - - - AUDCLNT_E_RESOURCES_INVALIDATED - - - - - Windows CoreAudio IAudioClient interface - Defined in AudioClient.h - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - Defined in AudioClient.h - - - - - Defined in AudioClient.h - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier for the audio session. - - Receives the session identifier. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier of the audio session instance. - - Receives the identifier of a particular instance. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the process identifier of the audio session. - - Receives the process identifier of the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Indicates whether the session is a system sounds session. - - An HRESULT code indicating whether the operation succeeded of failed. - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Defines constants that indicate the current state of an audio session. - - - MSDN Reference: http://msdn.microsoft.com/en-us/library/dd370792.aspx - - - - - The audio session is inactive. - - - - - The audio session is active. - - - - - The audio session has expired. - - - - - Defines constants that indicate a reason for an audio session being disconnected. - - - MSDN Reference: Unknown - - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the WTS session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - interface to receive session related events - - - - - notification of volume changes including muting of audio session - - the current volume - the current mute state, true muted, false otherwise - - - - notification of display name changed - - the current display name - - - - notification of icon path changed - - the current icon path - - - - notification of the client that the volume level of an audio channel in the session submix has changed - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - - - - notification of the client that the grouping parameter for the session has changed - - >The new grouping parameter for the session. - - - - notification of the client that the stream-activity state of the session has changed - - The new session state. - - - - notification of the client that the session has been disconnected - - The reason that the audio session was disconnected. - - - - Windows CoreAudio IAudioSessionManager interface - Defined in AudioPolicy.h - - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionNotification interface - Defined in AudioPolicy.h - - - - - - - session being added - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IConnector interface - Defined in devicetopology.h - - - - - Windows CoreAudio IDeviceTopology interface - Defined in devicetopology.h - - - - - defined in MMDeviceAPI.h - - - - - IMMNotificationClient - - - - - Device State Changed - - - - - Device Added - - - - - Device Removed - - - - - Default Device Changed - - - - - Property Value Changed - - - - - - - Windows CoreAudio IPart interface - Defined in devicetopology.h - - - - - Windows CoreAudio IPartsList interface - Defined in devicetopology.h - - - - - is defined in propsys.h - - - - - Windows CoreAudio ISimpleAudioVolume interface - Defined in AudioClient.h - - - - - Sets the master volume level for the audio session. - - The new volume level expressed as a normalized value between 0.0 and 1.0. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the client volume level for the audio session. - - Receives the volume level expressed as a normalized value between 0.0 and 1.0. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Sets the muting state for the audio session. - - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the current muting state for the audio session. - - Receives the muting state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - implements IMMDeviceEnumerator - - - - - MMDevice STGM enumeration - - - - - Read-only access mode. - - - - - Write-only access mode. - - - - - Read-write access mode. - - - - - from Propidl.h. - http://msdn.microsoft.com/en-us/library/aa380072(VS.85).aspx - contains a union so we have to do an explicit layout - - - - - Value type tag. - - - - - Reserved1. - - - - - Reserved2. - - - - - Reserved3. - - - - - cVal. - - - - - bVal. - - - - - iVal. - - - - - uiVal. - - - - - lVal. - - - - - ulVal. - - - - - intVal. - - - - - uintVal. - - - - - hVal. - - - - - uhVal. - - - - - fltVal. - - - - - dblVal. - - - - - boolVal. - - - - - scode. - - - - - Date time. - - - - - Binary large object. - - - - - Pointer value. - - - - - Creates a new PropVariant containing a long value - - - - - Helper method to gets blob data - - - - - Interprets a blob as an array of structs - - - - - Gets the type of data in this PropVariant - - - - - Property value - - - - - allows freeing up memory, might turn this into a Dispose method? - - - - - Clears with a known pointer - - - - - MM Device - - - - - Initializes the device's property store. - - The storage-access mode to open store for. - Administrative client is required for Write and ReadWrite modes. - - - - Audio Client - Makes a new one each call to allow caller to manage when to dispose - n.b. should probably not be a property anymore - - - - - Audio Meter Information - - - - - Audio Endpoint Volume - - - - - AudioSessionManager instance - - - - - DeviceTopology instance - - - - - Properties - - - - - Friendly name for the endpoint - - - - - Friendly name of device - - - - - Icon path of device - - - - - Device Instance Id of Device - - - - - Device ID - - - - - Data Flow - - - - - Device State - - - - - To string - - - - - Dispose - - - - - Finalizer - - - - - Multimedia Device Collection - - - - - Device count - - - - - Get device by index - - Device index - Device at the specified index - - - - Get Enumerator - - Device enumerator - - - - MM Device Enumerator - - - - - Creates a new MM Device Enumerator - - - - - Enumerate Audio Endpoints - - Desired DataFlow - State Mask - Device Collection - - - - Get Default Endpoint - - Data Flow - Role - Device - - - - Check to see if a default audio end point exists without needing an exception. - - Data Flow - Role - True if one exists, and false if one does not exist. - - - - Get device by ID - - Device ID - Device - - - - Registers a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - Unregisters a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - - - - Called to dispose/finalize contained objects. - - True if disposing, false if called from a finalizer. - - - - PROPERTYKEY is defined in wtypes.h - - - - - Format ID - - - - - Property ID - - - - - - - - - - - Property Keys - - - - - PKEY_DeviceInterface_FriendlyName - - - - - PKEY_AudioEndpoint_FormFactor - - - - - PKEY_AudioEndpoint_ControlPanelPageProvider - - - - - PKEY_AudioEndpoint_Association - - - - - PKEY_AudioEndpoint_PhysicalSpeakers - - - - - PKEY_AudioEndpoint_GUID - - - - - PKEY_AudioEndpoint_Disable_SysFx - - - - - PKEY_AudioEndpoint_FullRangeSpeakers - - - - - PKEY_AudioEndpoint_Supports_EventDriven_Mode - - - - - PKEY_AudioEndpoint_JackSubType - - - - - PKEY_AudioEngine_DeviceFormat - - - - - PKEY_AudioEngine_OEMFormat - - - - - PKEY _Devie_FriendlyName - - - - - PKEY _Device_IconPath - - - - - Device description property. - - - - - Id of controller device for endpoint device property. - - - - - Device interface key property. - - - - - System-supplied device instance identification string, assigned by PnP manager, persistent across system restarts. - - - - - Property Store class, only supports reading properties at the moment. - - - - - Property Count - - - - - Gets property by index - - Property index - The property - - - - Contains property guid - - Looks for a specific key - True if found - - - - Indexer by guid - - Property Key - Property or null if not found - - - - Gets property key at sepecified index - - Index - Property key - - - - Gets property value at specified index - - Index - Property value - - - - Sets property value at specified key. - - Key of property to set. - Value to write. - - - - Saves a property change. - - - - - Creates a new property store - - IPropertyStore COM interface - - - - Property Store Property - - - - - Property Key - - - - - Property Value - - - - - The ERole enumeration defines constants that indicate the role - that the system has assigned to an audio endpoint device - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording - - - - - Voice communications (talking to another person). - - - - - Collection of sessions. - - - - - Returns session at index. - - - - - - - Number of current sessions. - - - - - Windows CoreAudio SimpleAudioVolume - - - - - Creates a new Audio endpoint volume - - ISimpleAudioVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Allows the user to adjust the volume from - 0.0 to 1.0 - - - - - Mute - - - - - Represents state of a capture device - - - - - Not recording - - - - - Beginning to record - - - - - Recording in progress - - - - - Requesting stop - - - - - Audio Capture using Wasapi - See http://msdn.microsoft.com/en-us/library/dd370800%28VS.85%29.aspx - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - - - - Initializes a new instance of the class. - - The capture device. - true if sync is done with event. false use sleep. - Length of the audio buffer in milliseconds. A lower value means lower latency but increased CPU usage. - - - - Share Mode - set before calling StartRecording - - - - - Current Capturing State - - - - - Capturing wave format - - - - - Gets the default audio capture device - - The default audio capture device - - - - To allow overrides to specify different flags (e.g. loopback) - - - - - Start Capturing - - - - - Stop Capturing (requests a stop, wait for RecordingStopped event to know it has finished) - - - - - Dispose - - - - - Contains the name and CLSID of a DirectX Media Object - - - - - Name - - - - - CLSID - - - - - Initializes a new instance of DmoDescriptor - - - - - DirectX Media Object Enumerator - - - - - Get audio effect names - - Audio effect names - - - - Get audio encoder names - - Audio encoder names - - - - Get audio decoder names - - Audio decoder names - - - - DMO Guids for use with DMOEnum - dmoreg.h - - - - - MediaErr.h - - - - - DMO Inplace Process Flags - - - - - DMO_INPLACE_NORMAL - - - - - DMO_INPLACE_ZERO - - - - - Return value when Process is executed with IMediaObjectInPlace - - - - - Success. There is no remaining data to process. - - - - - Success. There is still data to process. - - - - - DMO Input Data Buffer Flags - - - - - None - - - - - DMO_INPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_INPUT_DATA_BUFFERF_TIME - - - - - DMO_INPUT_DATA_BUFFERF_TIMELENGTH - - - - - http://msdn.microsoft.com/en-us/library/aa929922.aspx - DMO_MEDIA_TYPE - - - - - Major type - - - - - Major type name - - - - - Subtype - - - - - Subtype name - - - - - Fixed size samples - - - - - Sample size - - - - - Format type - - - - - Format type name - - - - - Gets the structure as a Wave format (if it is one) - - - - - Sets this object up to point to a wave format - - Wave format structure - - - - DMO Output Data Buffer - - - - - Creates a new DMO Output Data Buffer structure - - Maximum buffer size - - - - Dispose - - - - - Media Buffer - - - - - Length of data in buffer - - - - - Status Flags - - - - - Timestamp - - - - - Duration - - - - - Retrives the data in this buffer - - Buffer to receive data - Offset into buffer - - - - Is more data available - If true, ProcessOuput should be called again - - - - - DMO Output Data Buffer Flags - - - - - None - - - - - DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_OUTPUT_DATA_BUFFERF_TIME - - - - - DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH - - - - - DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE - - - - - DMO_PARTIAL_MEDIATYPE - - - - - DMO Process Output Flags - - - - - None - - - - - DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER - - - - - Chorus Phase - - - - - DSFXCHORUS_PHASE_NEG_180 - - - - - DSFXCHORUS_PHASE_NEG_90 - - - - - DSFXCHORUS_PHASE_ZERO - - - - - DSFXCHORUS_PHASE_90 - - - - - DSFXCHORUS_PHASE_180 - - - - - Chorus Wave Form - - - - - DSFXCHORUS_WAVE_TRIANGLE - - - - - DSFXCHORUS_WAVE_SIN - - - - - DMO Chorus Effect - - - - - DMO Chorus Params - - - - - DSFXCHORUS_WETDRYMIX_MIN - - - - - DSFXCHORUS_WETDRYMIX_MAX - - - - - DSFXCHORUS_WETDRYMIX_DEFAULT - - - - - DSFXCHORUS_DEPTH_MIN - - - - - DSFXCHORUS_DEPTH_MAX - - - - - DSFXCHORUS_DEPTH_DEFAULT - - - - - DSFXCHORUS_FEEDBACK_MIN - - - - - DSFXCHORUS_FEEDBACK_MAX - - - - - DSFXCHORUS_FEEDBACK_DEFAULT - - - - - DSFXCHORUS_FREQUENCY_MIN - - - - - DSFXCHORUS_FREQUENCY_MAX - - - - - DSFXCHORUS_FREQUENCY_DEFAULT - - - - - DSFXCHORUS_WAVE_DEFAULT - - - - - DSFXCHORUS_DELAY_MIN - - - - - DSFXCHORUS_DELAY_MAX - - - - - DSFXCHORUS_DELAY_DEFAULT - - - - - DSFXCHORUS_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Chorus - - - - - Dispose code - - - - - DMO Compressor Effect - - - - - DMO Compressor Params - - - - - DSFXCOMPRESSOR_GAIN_MIN - - - - - DSFXCOMPRESSOR_GAIN_MAX - - - - - DSFXCOMPRESSOR_GAIN_DEFAULT - - - - - DSFXCOMPRESSOR_ATTACK_MIN - - - - - DSFXCOMPRESSOR_ATTACK_MAX - - - - - DSFXCOMPRESSOR_ATTACK_DEFAULT - - - - - DSFXCOMPRESSOR_RELEASE_MIN - - - - - DSFXCOMPRESSOR_RELEASE_MAX - - - - - DSFXCOMPRESSOR_RELEASE_DEFAULT - - - - - DSFXCOMPRESSOR_THRESHOLD_MIN - - - - - DSFXCOMPRESSOR_THRESHOLD_MAX - - - - - DSFXCOMPRESSOR_THRESHOLD_DEFAULT - - - - - DSFXCOMPRESSOR_RATIO_MIN - - - - - DSFXCOMPRESSOR_RATIO_MAX - - - - - DSFXCOMPRESSOR_RATIO_DEFAULT - - - - - DSFXCOMPRESSOR_PREDELAY_MIN - - - - - DSFXCOMPRESSOR_PREDELAY_MAX - - - - - DSFXCOMPRESSOR_PREDELAY_DEFAULT - - - - - Output gain of signal after compression. - - - - - Time before compression reaches its full value. - - - - - Speed at which compression is stopped after input drops below Threshold. - - - - - Point at which compression begins, in decibels. - - - - - Compression ratio - - - - - Time after Threshold is reached before attack phase is started, in milliseconds. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Compressor - - - - - Dispose code - - - - - DMO Distortion Effect - - - - - DMO Distortion Params - - - - - DSFXDISTORTION_GAIN_MIN - - - - - DSFXDISTORTION_GAIN_MAX - - - - - DSFXDISTORTION_GAIN_DEFAULT - - - - - DSFXDISTORTION_EDGE_MIN - - - - - DSFXDISTORTION_EDGE_MAX - - - - - DSFXDISTORTION_EDGE_DEFAULT - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MIN - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_MAX - - - - - DSFXDISTORTION_POSTEQCENTERFREQUENCY_DEFAULT - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MIN - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_MAX - - - - - DSFXDISTORTION_POSTEQBANDWIDTH_DEFAULT - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MIN - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_MAX - - - - - DSFXDISTORTION_PRELOWPASSCUTOFF_DEFAULT - - - - - Amount of signal change after distortion. - - - - - Percentage of distortion intensity. - - - - - Center frequency of harmonic content addition. - - - - - Width of frequency band that determines range of harmonic content addition. - - - - - Filter cutoff for high-frequency harmonics attenuation. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Distortion - - - - - Dispose code - - - - - Dmo Echo Effect - - - - - DMO Echo Params - - - - - DSFXECHO_WETDRYMIX_MIN - - - - - DSFXECHO_WETDRYMIX_MAX - - - - - DSFXECHO_WETDRYMIX_DEFAULT - - - - - DSFXECHO_FEEDBACK_MIN - - - - - DSFXECHO_FEEDBACK_MAX - - - - - DSFXECHO_FEEDBACK_DEFAULT - - - - - DSFXECHO_LEFTDELAY_MIN - - - - - DSFXECHO_LEFTDELAY_MAX - - - - - DSFXECHO_LEFTDELAY_DEFAULT - - - - - DSFXECHO_RIGHTDELAY_MIN - - - - - DSFXECHO_RIGHTDELAY_MAX - - - - - DSFXECHO_RIGHTDELAY_DEFAULT - - - - - DSFXECHO_PANDELAY_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage of output fed back into input. - - - - - Delay for left channel, in milliseconds. - - - - - Delay for right channel, in milliseconds. - - - - - Value that specifies whether to swap left and right delays with each successive echo. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Echo - - - - - Dispose code - - - - - DMO Flanger Effect - - - - - DMO Flanger Params - - - - - DSFXFLANGER_WETDRYMIX_MIN - - - - - DSFXFLANGER_WETDRYMIX_MAX - - - - - DSFXFLANGER_WETDRYMIX_DEFAULT - - - - - DSFXFLANGER_DEPTH_MIN - - - - - DSFXFLANGER_DEPTH_MAX - - - - - DSFXFLANGER_DEPTH_DEFAULT - - - - - DSFXFLANGER_FEEDBACK_MIN - - - - - DSFXFLANGER_FEEDBACK_MAX - - - - - DSFXFLANGER_FEEDBACK_DEFAULT - - - - - DSFXFLANGER_FREQUENCY_MIN - - - - - DSFXFLANGER_FREQUENCY_MAX - - - - - DSFXFLANGER_FREQUENCY_DEFAULT - - - - - DSFXFLANGER_WAVE_DEFAULT - - - - - DSFXFLANGER_DELAY_MIN - - - - - DSFXFLANGER_DELAY_MAX - - - - - DSFXFLANGER_DELAY_DEFAULT - - - - - DSFXFLANGER_PHASE_DEFAULT - - - - - Ratio of wet (processed) signal to dry (unprocessed) signal. - - - - - Percentage by which the delay time is modulated by the low-frequency oscillator, - in hundredths of a percentage point. - - - - - Percentage of output signal to feed back into the effect's input. - - - - - Frequency of the LFO. - - - - - Waveform shape of the LFO. - - - - - Number of milliseconds the input is delayed before it is played back. - - - - - Phase differential between left and right LFOs. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Flanger - - - - - Dispose code - - - - - DMO Gargle Effect - - - - - DMO Gargle Params - - - - - DSFXGARGLE_RATEHZ_MIN - - - - - DSFXGARGLE_RATEHZ_MAX - - - - - DSFXGARGLE_RATEHZ_DEFAULT - - - - - DSFXGARGLE_WAVE_DEFAULT - - - - - Rate of modulation in hz - - - - - Gargle Wave Shape - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO Gargle - - - - - Dispose code - - - - - DMO I3DL2Reverb Effect - - - - - DMO I3DL2Reverb Params - - - - - DSFX_I3DL2REVERB_ROOM_MIN - - - - - DSFX_I3DL2REVERB_ROOM_MAX - - - - - DSFX_I3DL2REVERB_ROOM_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMHF_MIN - - - - - DSFX_I3DL2REVERB_ROOMHF_MAX - - - - - DSFX_I3DL2REVERB_ROOMHF_DEFAULT - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MIN - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_MAX - - - - - DSFX_I3DL2REVERB_ROOMROLLOFFFACTOR_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYTIME_MIN - - - - - DSFX_I3DL2REVERB_DECAYTIME_MAX - - - - - DSFX_I3DL2REVERB_DECAYTIME_DEFAULT - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MIN - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_MAX - - - - - DSFX_I3DL2REVERB_DECAYHFRATIO_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONS_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONS_DEFAULT - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MIN - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_MAX - - - - - DSFX_I3DL2REVERB_REFLECTIONSDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERB_MIN - - - - - DSFX_I3DL2REVERB_REVERB_MAX - - - - - DSFX_I3DL2REVERB_REVERB_DEFAULT - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MIN - - - - - DSFX_I3DL2REVERB_REVERBDELAY_MAX - - - - - DSFX_I3DL2REVERB_REVERBDELAY_DEFAULT - - - - - DSFX_I3DL2REVERB_DIFFUSION_MIN - - - - - DSFX_I3DL2REVERB_DIFFUSION_MAX - - - - - DSFX_I3DL2REVERB_DIFFUSION_DEFAULT - - - - - DSFX_I3DL2REVERB_DENSITY_MIN - - - - - DSFX_I3DL2REVERB_DENSITY_MAX - - - - - DSFX_I3DL2REVERB_DENSITY_DEFAULT - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MIN - - - - - DSFX_I3DL2REVERB_HFREFERENCE_MAX - - - - - DSFX_I3DL2REVERB_HFREFERENCE_DEFAULT - - - - - DSFX_I3DL2REVERB_QUALITY_MIN - - - - - DSFX_I3DL2REVERB_QUALITY_MAX - - - - - DSFX_I3DL2REVERB_QUALITY_DEFAULT - - - - - Attenuation of the room effect, in millibels (mB) - - - - - Attenuation of the room high-frequency effect, in mB. - - - - - Rolloff factor for the reflected signals. - - - - - Decay time, in seconds. - - - - - Ratio of the decay time at high frequencies to the decay time at low frequencies. - - - - - Attenuation of early reflections relative to lRoom, in mB. - - - - - Delay time of the first reflection relative to the direct path, in seconds. - - - - - Attenuation of late reverberation relative to lRoom, in mB. - - - - - Time limit between the early reflections and the late reverberation relative to the time of the first reflection. - - - - - Echo density in the late reverberation decay, in percent. - - - - - Modal density in the late reverberation decay, in percent. - - - - - Reference high frequency, in hertz. - - - - - the quality of the environmental reverberation effect. Higher values produce better quality at the expense of processing time. - - - - - Sets standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - retrieves an identifier for standard reverberation parameters of a buffer. - - I3DL2EnvironmentPreset - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO I3DL2Reverb - - - - - Dispose code - - - - - DMO Parametric Equalizer Effect - - - - - DMO ParamEq Params - - - - - DSFXPARAMEQ_CENTER_MIN - - - - - DSFXPARAMEQ_CENTER_MAX - - - - - DSFXPARAMEQ_CENTER_DEFAULT - - - - - DSFXPARAMEQ_BANDWIDTH_MIN - - - - - DSFXPARAMEQ_BANDWIDTH_MAX - - - - - DSFXPARAMEQ_BANDWIDTH_DEFAULT - - - - - DSFXPARAMEQ_GAIN_MIN - - - - - DSFXPARAMEQ_GAIN_MAX - - - - - DSFXPARAMEQ_GAIN_DEFAULT - - - - - Center frequency, in hertz - - - - - Bandwidth, in semitones. - - - - - Gain - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO ParamEq - - - - - Dispose code - - - - - DMO Reverb Effect - - - - - DMO Reverb Params - - - - - DSFX_WAVESREVERB_INGAIN_MIN - - - - - DSFX_WAVESREVERB_INGAIN_MAX - - - - - DSFX_WAVESREVERB_INGAIN_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBMIX_MIN - - - - - DSFX_WAVESREVERB_REVERBMIX_MAX - - - - - DSFX_WAVESREVERB_REVERBMIX_DEFAULT - - - - - DSFX_WAVESREVERB_REVERBTIME_MIN - - - - - DSFX_WAVESREVERB_REVERBTIME_MAX - - - - - DSFX_WAVESREVERB_REVERBTIME_DEFAULT - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MIN - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_MAX - - - - - DSFX_WAVESREVERB_HIGHFREQRTRATIO_DEFAULT - - - - - Input gain of signal, in decibels (dB). - - - - - Reverb mix, in dB. - - - - - Reverb time, in milliseconds. - - - - - High-frequency reverb time ratio. - - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - Create new DMO WavesReverb - - - - - Dispose code - - - - - DSFXECHO_PANDELAY - - - - - DSFXECHO_PANDELAY_MIN - - - - - DSFXECHO_PANDELAY_MAX - - - - - Flanger Phase - - - - - DSFXFLANGER_PHASE_NEG_180 - - - - - DSFXFLANGER_PHASE_NEG_90 - - - - - DSFXFLANGER_PHASE_ZERO - - - - - DSFXFLANGER_PHASE_90 - - - - - DSFXFLANGER_PHASE_180 - - - - - Flanger Wave Form - - - - - DSFXFLANGER_WAVE_TRIANGLE - - - - - DSFXFLANGER_WAVE_SIN - - - - - Gargle Wave Shape - - - - - DSFXGARGLE_WAVE_TRIANGLE - - - - - DSFXGARGLE_WAVE_SQUARE - - - - - I3DL2 Reverberation Presets - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_DEFAULT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_GENERIC - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PADDEDCELL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_BATHROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LIVINGROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_AUDITORIUM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CONCERTHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CAVE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ARENA - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HANGAR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CARPETEDHALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_HALLWAY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_STONECORRIDOR - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_ALLEY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_FOREST - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_CITY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MOUNTAINS - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_QUARRY - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLAIN - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PARKINGLOT - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SEWERPIPE - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_UNDERWATER - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_SMALLROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEROOM - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_MEDIUMHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_LARGEHALL - - - - - DSFX_I3DL2_ENVIRONMENT_PRESET_PLATE - - - - - Interface of DMO Effectors - - Parameters of the effect to be used - - - - Media Object - - - - - Media Object InPlace - - - - - Effect Parameter - - - - - IMediaBuffer Interface - - - - - Set Length - - Length - HRESULT - - - - Get Max Length - - Max Length - HRESULT - - - - Get Buffer and Length - - Pointer to variable into which to write the Buffer Pointer - Pointer to variable into which to write the Valid Data Length - HRESULT - - - - defined in mediaobj.h - - - - - defined in mediaobj.h - - - - - defined in Medparam.h - - - - - Windows Media Resampler Props - wmcodecdsp.h - - - - - Range is 1 to 60 - - - - - Specifies the channel matrix. - - - - - Attempting to implement the COM IMediaBuffer interface as a .NET object - Not sure what will happen when I pass this to an unmanaged object - - - - - Creates a new Media Buffer - - Maximum length in bytes - - - - Dispose and free memory for buffer - - - - - Finalizer - - - - - Set length of valid data in the buffer - - length - HRESULT - - - - Gets the maximum length of the buffer - - Max length (output parameter) - HRESULT - - - - Gets buffer and / or length - - Pointer to variable into which buffer pointer should be written - Pointer to variable into which valid data length should be written - HRESULT - - - - Length of data in the media buffer - - - - - Loads data into this buffer - - Data to load - Number of bytes to load - - - - Retrieves the data in the output buffer - - buffer to retrieve into - offset within that buffer - - - - Media Object - - - - - Creates a new Media Object - - Media Object COM interface - - - - Number of input streams - - - - - Number of output streams - - - - - Gets the input media type for the specified input stream - - Input stream index - Input type index - DMO Media Type or null if there are no more input types - - - - Gets the DMO Media Output type - - The output stream - Output type index - DMO Media Type or null if no more available - - - - retrieves the media type that was set for an output stream, if any - - Output stream index - DMO Media Type or null if no more available - - - - Enumerates the supported input types - - Input stream index - Enumeration of input types - - - - Enumerates the output types - - Output stream index - Enumeration of supported output types - - - - Querys whether a specified input type is supported - - Input stream index - Media type to check - true if supports - - - - Sets the input type helper method - - Input stream index - Media type - Flags (can be used to test rather than set) - - - - Sets the input type - - Input stream index - Media Type - - - - Sets the input type to the specified Wave format - - Input stream index - Wave format - - - - Requests whether the specified Wave format is supported as an input - - Input stream index - Wave format - true if supported - - - - Helper function to make a DMO Media Type to represent a particular WaveFormat - - - - - Checks if a specified output type is supported - n.b. you may need to set the input type first - - Output stream index - Media type - True if supported - - - - Tests if the specified Wave Format is supported for output - n.b. may need to set the input type first - - Output stream index - Wave format - True if supported - - - - Helper method to call SetOutputType - - - - - Sets the output type - n.b. may need to set the input type first - - Output stream index - Media type to set - - - - Set output type to the specified wave format - n.b. may need to set input type first - - Output stream index - Wave format - - - - Get Input Size Info - - Input Stream Index - Input Size Info - - - - Get Output Size Info - - Output Stream Index - Output Size Info - - - - Process Input - - Input Stream index - Media Buffer - Flags - Timestamp - Duration - - - - Process Output - - Flags - Output buffer count - Output buffers - - - - Gives the DMO a chance to allocate any resources needed for streaming - - - - - Tells the DMO to free any resources needed for streaming - - - - - Gets maximum input latency - - input stream index - Maximum input latency as a ref-time - - - - Flushes all buffered data - - - - - Report a discontinuity on the specified input stream - - Input Stream index - - - - Is this input stream accepting data? - - Input Stream index - true if accepting data - - - - Experimental code, not currently being called - Not sure if it is necessary anyway - - - - - Media Object InPlace - - - - - Creates a new Media Object InPlace - - Media Object InPlace COM Interface - - - - Processes a block of data. - The application supplies a pointer to a block of input data. The DMO processes the data in place. - - Size of the data, in bytes. - offset into buffer - In/Out Data Buffer - Start time of the data. - DmoInplaceProcessFlags - Return value when Process is executed with IMediaObjectInPlace - - - - Creates a copy of the DMO in its current state. - - Copyed MediaObjectInPlace - - - - Retrieves the latency introduced by this DMO. - - The latency, in 100-nanosecond units - - - - Get Media Object - - Media Object - - - - Dispose code - - - - - Media Object Size Info - - - - - Minimum Buffer Size, in bytes - - - - - Max Lookahead - - - - - Alignment - - - - - Media Object Size Info - - - - - ToString - - - - - MP_PARAMINFO - - - - - MP_TYPE - - - - - MPT_INT - - - - - MPT_FLOAT - - - - - MPT_BOOL - - - - - MPT_ENUM - - - - - MPT_MAX - - - - - MP_CURVE_TYPE - - - - - uuids.h, ksuuids.h - - - - - From wmcodecsdp.h - Implements: - - IMediaObject - - IMFTransform (Media foundation - we will leave this for now as there is loads of MF stuff) - - IPropertyStore - - IWMResamplerProps - Can resample PCM or IEEE - - - - - DMO Resampler - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - implements IMediaObject (DirectX Media Object) - implements IMFTransform (Media Foundation Transform) - On Windows XP, it is always an MM (if present at all) - - - - - Windows Media MP3 Decoder (as a DMO) - WORK IN PROGRESS - DO NOT USE! - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - BiQuad filter - - - - - Passes a single sample through the filter - - Input sample - Output sample - - - - Set this up as a low pass filter - - Sample Rate - Cut-off Frequency - Bandwidth - - - - Set this up as a peaking EQ - - Sample Rate - Centre Frequency - Bandwidth (Q) - Gain in decibels - - - - Set this as a high pass filter - - - - - Create a low pass filter - - - - - Create a High pass filter - - - - - Create a bandpass filter with constant skirt gain - - - - - Create a bandpass filter with constant peak gain - - - - - Creates a notch filter - - - - - Creaes an all pass filter - - - - - Create a Peaking EQ - - - - - H(s) = A * (s^2 + (sqrt(A)/Q)*s + A)/(A*s^2 + (sqrt(A)/Q)*s + 1) - - - - a "shelf slope" parameter (for shelving EQ only). - When S = 1, the shelf slope is as steep as it can be and remain monotonically - increasing or decreasing gain with frequency. The shelf slope, in dB/octave, - remains proportional to S for all other values for a fixed f0/Fs and dBgain. - Gain in decibels - - - - H(s) = A * (A*s^2 + (sqrt(A)/Q)*s + 1)/(s^2 + (sqrt(A)/Q)*s + A) - - - - - - - - - - Type to represent complex number - - - - - Real Part - - - - - Imaginary Part - - - - - Envelope generator (ADSR) - - - - - Envelope State - - - - - Idle - - - - - Attack - - - - - Decay - - - - - Sustain - - - - - Release - - - - - Creates and Initializes an Envelope Generator - - - - - Attack Rate (seconds * SamplesPerSecond) - - - - - Decay Rate (seconds * SamplesPerSecond) - - - - - Release Rate (seconds * SamplesPerSecond) - - - - - Sustain Level (1 = 100%) - - - - - Sets the attack curve - - - - - Sets the decay release curve - - - - - Read the next volume multiplier from the envelope generator - - A volume multiplier - - - - Trigger the gate - - If true, enter attack phase, if false enter release phase (unless already idle) - - - - Current envelope state - - - - - Reset to idle state - - - - - Get the current output level - - - - - Summary description for FastFourierTransform. - - - - - This computes an in-place complex-to-complex FFT - x and y are the real and imaginary arrays of 2^m points. - - - - - Applies a Hamming Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hamming window - - - - Applies a Hann Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hann window - - - - Applies a Blackman-Harris Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Blackmann-Harris window - - - - Summary description for ImpulseResponseConvolution. - - - - - A very simple mono convolution algorithm - - - This will be very slow - - - - - This is actually a downwards normalize for data that will clip - - - - - SMB Pitch Shifter - - - - - Pitch Shift - - - - - Pitch Shift - - - - - Short Time Fourier Transform - - - - - Fully managed resampler, based on Cockos WDL Resampler - - - - - Creates a new Resampler - - - - - sets the mode - if sinc set, it overrides interp or filtercnt - - - - - Sets the filter parameters - used for filtercnt>0 but not sinc - - - - - Set feed mode - - if true, that means the first parameter to ResamplePrepare will specify however much input you have, not how much you want - - - - Reset - - - - - Prepare - note that it is safe to call ResamplePrepare without calling ResampleOut (the next call of ResamplePrepare will function as normal) - nb inbuffer was WDL_ResampleSample **, returning a place to put the in buffer, so we return a buffer and offset - - req_samples is output samples desired if !wantInputDriven, or if wantInputDriven is input samples that we have - - - - returns number of samples desired (put these into *inbuffer) - - - - Channel Mode - - - - - Stereo - - - - - Joint Stereo - - - - - Dual Channel - - - - - Mono - - - - - An ID3v2 Tag - - - - - Reads an ID3v2 tag from a stream - - - - - Creates a new ID3v2 tag from a collection of key-value pairs. - - A collection of key-value pairs containing the tags to include in the ID3v2 tag. - A new ID3v2 tag - - - - Convert the frame size to a byte array. - - The frame body size. - - - - - Creates an ID3v2 frame for the given key-value pair. - - - - - - - - Gets the Id3v2 Header size. The size is encoded so that only 7 bits per byte are actually used. - - - - - - - Creates the Id3v2 tag header and returns is as a byte array. - - The Id3v2 frames that will be included in the file. This is used to calculate the ID3v2 tag size. - - - - - Creates the Id3v2 tag for the given key-value pairs and returns it in the a stream. - - - - - - - Raw data from this tag - - - - - Interface for MP3 frame by frame decoder - - - - - Decompress a single MP3 frame - - Frame to decompress - Output buffer - Offset within output buffer - Bytes written to output buffer - - - - Tell the decoder that we have repositioned - - - - - PCM format that we are converting into - - - - - Represents an MP3 Frame - - - - - Reads an MP3 frame from a stream - - input stream - A valid MP3 frame, or null if none found - - - Reads an MP3Frame from a stream - http://mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm has some good info - also see http://www.codeproject.com/KB/audio-video/mpegaudioinfo.aspx - - A valid MP3 frame, or null if none found - - - - Constructs an MP3 frame - - - - - checks if the four bytes represent a valid header, - if they are, will parse the values into Mp3Frame - - - - - Sample rate of this frame - - - - - Frame length in bytes - - - - - Bit Rate - - - - - Raw frame data (includes header bytes) - - - - - MPEG Version - - - - - MPEG Layer - - - - - Channel Mode - - - - - The number of samples in this frame - - - - - The channel extension bits - - - - - The bitrate index (directly from the header) - - - - - Whether the Copyright bit is set - - - - - Whether a CRC is present - - - - - Not part of the MP3 frame itself - indicates where in the stream we found this header - - - - - MP3 Frame Decompressor using ACM - - - - - Creates a new ACM frame decompressor - - The MP3 source format - - - - Output format (PCM) - - - - - Decompresses a frame - - The MP3 frame - destination buffer - Offset within destination buffer - Bytes written into destination buffer - - - - Resets the MP3 Frame Decompressor after a reposition operation - - - - - Disposes of this MP3 frame decompressor - - - - - Finalizer ensuring that resources get released properly - - - - - MPEG Layer flags - - - - - Reserved - - - - - Layer 3 - - - - - Layer 2 - - - - - Layer 1 - - - - - MPEG Version Flags - - - - - Version 2.5 - - - - - Reserved - - - - - Version 2 - - - - - Version 1 - - - - - Represents a Xing VBR header - - - - - Load Xing Header - - Frame - Xing Header - - - - Sees if a frame contains a Xing header - - - - - Number of frames - - - - - Number of bytes - - - - - VBR Scale property - - - - - The MP3 frame - - - - - ASIO 64 bit value - Unfortunately the ASIO API was implemented it before compiler supported consistently 64 bit - integer types. By using the structure the data layout on a little-endian system like the - Intel x86 architecture will result in a "non native" storage of the 64 bit data. The most - significant 32 bit are stored first in memory, the least significant bits are stored in the - higher memory space. However each 32 bit is stored in the native little-endian fashion - - - - - most significant bits (Bits 32..63) - - - - - least significant bits (Bits 0..31) - - - - - ASIO Callbacks - - - - - ASIO Buffer Switch Callback - - - - - ASIO Sample Rate Did Change Callback - - - - - ASIO Message Callback - - - - - ASIO Buffer Switch Time Info Callback - - - - - Buffer switch callback - void (*bufferSwitch) (long doubleBufferIndex, AsioBool directProcess); - - - - - Sample Rate Changed callback - void (*sampleRateDidChange) (AsioSampleRate sRate); - - - - - ASIO Message callback - long (*asioMessage) (long selector, long value, void* message, double* opt); - - - - - ASIO Buffer Switch Time Info Callback - AsioTime* (*bufferSwitchTimeInfo) (AsioTime* params, long doubleBufferIndex, AsioBool directProcess); - - - - - ASIO Channel Info - - - - - on input, channel index - - - - - Is Input - - - - - Is Active - - - - - Channel Info - - - - - ASIO Sample Type - - - - - Name - - - - - Main AsioDriver Class. To use this class, you need to query first the GetAsioDriverNames() and - then use the GetAsioDriverByName to instantiate the correct AsioDriver. - This is the first AsioDriver binding fully implemented in C#! - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Gets the ASIO driver names installed. - - a list of driver names. Use this name to GetAsioDriverByName - - - - Instantiate a AsioDriver given its name. - - The name of the driver - an AsioDriver instance - - - - Instantiate the ASIO driver by GUID. - - The GUID. - an AsioDriver instance - - - - Inits the AsioDriver.. - - The sys handle. - - - - - Gets the name of the driver. - - - - - - Gets the driver version. - - - - - - Gets the error message. - - - - - - Starts this instance. - - - - - Stops this instance. - - - - - Gets the number of channels. - - The num input channels. - The num output channels. - - - - Gets the latencies (n.b. does not throw an exception) - - The input latency. - The output latency. - - - - Gets the size of the buffer. - - Size of the min. - Size of the max. - Size of the preferred. - The granularity. - - - - Determines whether this instance can use the specified sample rate. - - The sample rate. - - true if this instance [can sample rate] the specified sample rate; otherwise, false. - - - - - Gets the sample rate. - - - - - - Sets the sample rate. - - The sample rate. - - - - Gets the clock sources. - - The clocks. - The num sources. - - - - Sets the clock source. - - The reference. - - - - Gets the sample position. - - The sample pos. - The time stamp. - - - - Gets the channel info. - - The channel number. - if set to true [true for input info]. - Channel Info - - - - Creates the buffers. - - The buffer infos. - The num channels. - Size of the buffer. - The callbacks. - - - - Disposes the buffers. - - - - - Controls the panel. - - - - - Futures the specified selector. - - The selector. - The opt. - - - - Notifies OutputReady to the AsioDriver. - - - - - - Releases this instance. - - - - - Handles the exception. Throws an exception based on the error. - - The error to check. - Method name - - - - Inits the vTable method from GUID. This is a tricky part of this class. - - The ASIO GUID. - - - - Internal VTable structure to store all the delegates to the C++ COM method. - - - - - ASIODriverCapability holds all the information from the AsioDriver. - Use ASIODriverExt to get the Capabilities - - - - - Drive Name - - - - - Number of Input Channels - - - - - Number of Output Channels - - - - - Input Latency - - - - - Output Latency - - - - - Buffer Minimum Size - - - - - Buffer Maximum Size - - - - - Buffer Preferred Size - - - - - Buffer Granularity - - - - - Sample Rate - - - - - Input Channel Info - - - - - Output Channel Info - - - - - Callback used by the AsioDriverExt to get wave data - - - - - AsioDriverExt is a simplified version of the AsioDriver. It provides an easier - way to access the capabilities of the Driver and implement the callbacks necessary - for feeding the driver. - Implementation inspired from Rob Philpot's with a managed C++ ASIO wrapper BlueWave.Interop.Asio - http://www.codeproject.com/KB/mcpp/Asio.Net.aspx - - Contributor: Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Initializes a new instance of the class based on an already - instantiated AsioDriver instance. - - A AsioDriver already instantiated. - - - - Allows adjustment of which is the first output channel we write to - - Output Channel offset - Input Channel offset - - - - Gets the driver used. - - The ASIOdriver. - - - - Starts playing the buffers. - - - - - Stops playing the buffers. - - - - - Shows the control panel. - - - - - Releases this instance. - - - - - Determines whether the specified sample rate is supported. - - The sample rate. - - true if [is sample rate supported]; otherwise, false. - - - - - Sets the sample rate. - - The sample rate. - - - - Gets or sets the fill buffer callback. - - The fill buffer callback. - - - - Gets the capabilities of the AsioDriver. - - The capabilities. - - - - Creates the buffers for playing. - - The number of outputs channels. - The number of input channel. - if set to true [use max buffer size] else use Prefered size - - - - Builds the capabilities internally. - - - - - Callback called by the AsioDriver on fill buffer demand. Redirect call to external callback. - - Index of the double buffer. - if set to true [direct process]. - - - - Callback called by the AsioDriver on event "Samples rate changed". - - The sample rate. - - - - Asio message call back. - - The selector. - The value. - The message. - The opt. - - - - - Buffers switch time info call back. - - The asio time param. - Index of the double buffer. - if set to true [direct process]. - - - - - ASIO Error Codes - - - - - This value will be returned whenever the call succeeded - - - - - unique success return value for ASIOFuture calls - - - - - hardware input or output is not present or available - - - - - hardware is malfunctioning (can be returned by any ASIO function) - - - - - input parameter invalid - - - - - hardware is in a bad mode or used in a bad mode - - - - - hardware is not running when sample position is inquired - - - - - sample clock or rate cannot be determined or is not present - - - - - not enough memory for completing the request - - - - - ASIO Message Selector - - - - - selector in <value>, returns 1L if supported, - - - - - returns engine (host) asio implementation version, - - - - - request driver reset. if accepted, this - - - - - not yet supported, will currently always return 0L. - - - - - the driver went out of sync, such that - - - - - the drivers latencies have changed. The engine - - - - - if host returns true here, it will expect the - - - - - supports timecode - - - - - unused - value: number of commands, message points to mmc commands - - - - - kAsioSupportsXXX return 1 if host supports this - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - unused and undefined - - - - - driver detected an overload - - - - - This class stores convertors for different interleaved WaveFormat to ASIOSampleType separate channel - format. - - - - - Selects the sample convertor based on the input WaveFormat and the output ASIOSampleTtype. - - The wave format. - The type. - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor Float to INT - - - - - Optimized convertor for 2 channels INT to INT - - - - - Generic convertor INT to INT - - - - - Optimized convertor for 2 channels INT to SHORT - - - - - Generic convertor INT to SHORT - - - - - Generic convertor INT to FLOAT - - - - - Optimized convertor for 2 channels SHORT - - - - - Generic convertor for SHORT - - - - - Optimized convertor for 2 channels FLOAT - - - - - Generic convertor SHORT - - - - - Generic converter 24 LSB - - - - - Generic convertor for float - - - - - ASIO Sample Type - - - - - Int 16 MSB - - - - - Int 24 MSB (used for 20 bits as well) - - - - - Int 32 MSB - - - - - IEEE 754 32 bit float - - - - - IEEE 754 64 bit double float - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - Int 16 LSB - - - - - Int 24 LSB - used for 20 bits as well - - - - - Int 32 LSB - - - - - IEEE 754 32 bit float, as found on Intel x86 architecture - - - - - IEEE 754 64 bit double float, as found on Intel x86 architecture - - - - - 32 bit data with 16 bit alignment - - - - - 32 bit data with 18 bit alignment - - - - - 32 bit data with 20 bit alignment - - - - - 32 bit data with 24 bit alignment - - - - - DSD 1 bit data, 8 samples per byte. First sample in Least significant bit. - - - - - DSD 1 bit data, 8 samples per byte. First sample in Most significant bit. - - - - - DSD 8 bit data, 1 sample per byte. No Endianness required. - - - - - ASIO common Exception. - - - - - Gets the name of the error. - - The error. - the name of the error - - - - Represents an installed ACM Driver - - - - - Helper function to determine whether a particular codec is installed - - The short name of the function - Whether the codec is installed - - - - Attempts to add a new ACM driver from a file - - Full path of the .acm or dll file containing the driver - Handle to the driver - - - - Removes a driver previously added using AddLocalDriver - - Local driver to remove - - - - Show Format Choose Dialog - - Owner window handle, can be null - Window title - Enumeration flags. None to get everything - Enumeration format. Only needed with certain enumeration flags - The selected format - Textual description of the selected format - Textual description of the selected format tag - True if a format was selected - - - - Gets the maximum size needed to store a WaveFormat for ACM interop functions - - - - - Finds a Driver by its short name - - Short Name - The driver, or null if not found - - - - Gets a list of the ACM Drivers installed - - - - - The callback for acmDriverEnum - - - - - Creates a new ACM Driver object - - Driver handle - - - - The short name of this driver - - - - - The full name of this driver - - - - - The driver ID - - - - - ToString - - - - - The list of FormatTags for this ACM Driver - - - - - Gets all the supported formats for a given format tag - - Format tag - Supported formats - - - - Opens this driver - - - - - Closes this driver - - - - - Dispose - - - - - Flags for use with acmDriverAdd - - - - - ACM_DRIVERADDF_LOCAL - - - - - ACM_DRIVERADDF_GLOBAL - - - - - ACM_DRIVERADDF_FUNCTION - - - - - ACM_DRIVERADDF_NOTIFYHWND - - - - - Interop structure for ACM driver details (ACMDRIVERDETAILS) - http://msdn.microsoft.com/en-us/library/dd742889%28VS.85%29.aspx - - - - - DWORD cbStruct - - - - - FOURCC fccType - - - - - FOURCC fccComp - - - - - WORD wMid; - - - - - WORD wPid - - - - - DWORD vdwACM - - - - - DWORD vdwDriver - - - - - DWORD fdwSupport; - - - - - DWORD cFormatTags - - - - - DWORD cFilterTags - - - - - HICON hicon - - - - - TCHAR szShortName[ACMDRIVERDETAILS_SHORTNAME_CHARS]; - - - - - TCHAR szLongName[ACMDRIVERDETAILS_LONGNAME_CHARS]; - - - - - TCHAR szCopyright[ACMDRIVERDETAILS_COPYRIGHT_CHARS]; - - - - - TCHAR szLicensing[ACMDRIVERDETAILS_LICENSING_CHARS]; - - - - - TCHAR szFeatures[ACMDRIVERDETAILS_FEATURES_CHARS]; - - - - - ACMDRIVERDETAILS_SHORTNAME_CHARS - - - - - ACMDRIVERDETAILS_LONGNAME_CHARS - - - - - ACMDRIVERDETAILS_COPYRIGHT_CHARS - - - - - ACMDRIVERDETAILS_LICENSING_CHARS - - - - - ACMDRIVERDETAILS_FEATURES_CHARS - - - - - Flags indicating what support a particular ACM driver has - - - - ACMDRIVERDETAILS_SUPPORTF_CODEC - Codec - - - ACMDRIVERDETAILS_SUPPORTF_CONVERTER - Converter - - - ACMDRIVERDETAILS_SUPPORTF_FILTER - Filter - - - ACMDRIVERDETAILS_SUPPORTF_HARDWARE - Hardware - - - ACMDRIVERDETAILS_SUPPORTF_ASYNC - Async - - - ACMDRIVERDETAILS_SUPPORTF_LOCAL - Local - - - ACMDRIVERDETAILS_SUPPORTF_DISABLED - Disabled - - - - ACM_DRIVERENUMF_NOLOCAL, Only global drivers should be included in the enumeration - - - - - ACM_DRIVERENUMF_DISABLED, Disabled ACM drivers should be included in the enumeration - - - - - ACM Format - - - - - Format Index - - - - - Format Tag - - - - - Support Flags - - - - - WaveFormat - - - - - WaveFormat Size - - - - - Format Description - - - - - ACMFORMATCHOOSE - http://msdn.microsoft.com/en-us/library/dd742911%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD fdwStyle; - - - - - HWND hwndOwner; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - LPCTSTR pszTitle; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - LPTSTR pszName; - n.b. can be written into - - - - - DWORD cchName - Should be at least 128 unless name is zero - - - - - DWORD fdwEnum; - - - - - LPWAVEFORMATEX pwfxEnum; - - - - - HINSTANCE hInstance; - - - - - LPCTSTR pszTemplateName; - - - - - LPARAM lCustData; - - - - - ACMFORMATCHOOSEHOOKPROC pfnHook; - - - - - None - - - - - ACMFORMATCHOOSE_STYLEF_SHOWHELP - - - - - ACMFORMATCHOOSE_STYLEF_ENABLEHOOK - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATE - - - - - ACMFORMATCHOOSE_STYLEF_ENABLETEMPLATEHANDLE - - - - - ACMFORMATCHOOSE_STYLEF_INITTOWFXSTRUCT - - - - - ACMFORMATCHOOSE_STYLEF_CONTEXTHELP - - - - - ACMFORMATDETAILS - http://msdn.microsoft.com/en-us/library/dd742913%28VS.85%29.aspx - - - - - DWORD cbStruct; - - - - - DWORD dwFormatIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD fdwSupport; - - - - - LPWAVEFORMATEX pwfx; - - - - - DWORD cbwfx; - - - - - TCHAR szFormat[ACMFORMATDETAILS_FORMAT_CHARS]; - - - - - ACMFORMATDETAILS_FORMAT_CHARS - - - - - Format Enumeration Flags - - - - - None - - - - - ACM_FORMATENUMF_CONVERT - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will only enumerate destination formats that can be converted from the given pwfx format. - - - - - ACM_FORMATENUMF_HARDWARE - The enumerator should only enumerate formats that are supported as native input or output formats on one or more of the installed waveform-audio devices. This flag provides a way for an application to choose only formats native to an installed waveform-audio device. This flag must be used with one or both of the ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT flags. Specifying both ACM_FORMATENUMF_INPUT and ACM_FORMATENUMF_OUTPUT will enumerate only formats that can be opened for input or output. This is true regardless of whether this flag is specified. - - - - - ACM_FORMATENUMF_INPUT - Enumerator should enumerate only formats that are supported for input (recording). - - - - - ACM_FORMATENUMF_NCHANNELS - The nChannels member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_NSAMPLESPERSEC - The nSamplesPerSec member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_OUTPUT - Enumerator should enumerate only formats that are supported for output (playback). - - - - - ACM_FORMATENUMF_SUGGEST - The WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate all suggested destination formats for the given pwfx format. This mechanism can be used instead of the acmFormatSuggest function to allow an application to choose the best suggested format for conversion. The dwFormatIndex member will always be set to zero on return. - - - - - ACM_FORMATENUMF_WBITSPERSAMPLE - The wBitsPerSample member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. - - - - - ACM_FORMATENUMF_WFORMATTAG - The wFormatTag member of the WAVEFORMATEX structure pointed to by the pwfx member of the ACMFORMATDETAILS structure is valid. The enumerator will enumerate only a format that conforms to this attribute. The dwFormatTag member of the ACMFORMATDETAILS structure must be equal to the wFormatTag member. - - - - - ACM_FORMATSUGGESTF_WFORMATTAG - - - - - ACM_FORMATSUGGESTF_NCHANNELS - - - - - ACM_FORMATSUGGESTF_NSAMPLESPERSEC - - - - - ACM_FORMATSUGGESTF_WBITSPERSAMPLE - - - - - ACM_FORMATSUGGESTF_TYPEMASK - - - - - ACM Format Tag - - - - - Format Tag Index - - - - - Format Tag - - - - - Format Size - - - - - Support Flags - - - - - Standard Formats Count - - - - - Format Description - - - - - DWORD cbStruct; - - - - - DWORD dwFormatTagIndex; - - - - - DWORD dwFormatTag; - - - - - DWORD cbFormatSize; - - - - - DWORD fdwSupport; - - - - - DWORD cStandardFormats; - - - - - TCHAR szFormatTag[ACMFORMATTAGDETAILS_FORMATTAG_CHARS]; - - - - - ACMFORMATTAGDETAILS_FORMATTAG_CHARS - - - - - Interop definitions for Windows ACM (Audio Compression Manager) API - - - - - http://msdn.microsoft.com/en-us/library/dd742910%28VS.85%29.aspx - UINT ACMFORMATCHOOSEHOOKPROC acmFormatChooseHookProc( - HWND hwnd, - UINT uMsg, - WPARAM wParam, - LPARAM lParam - - - - - A version with pointers for troubleshooting - - - - - AcmStream encapsulates an Audio Compression Manager Stream - used to convert audio from one format to another - - - - - Creates a new ACM stream to convert one format to another. Note that - not all conversions can be done in one step - - The source audio format - The destination audio format - - - - Creates a new ACM stream to convert one format to another, using a - specified driver identifier and wave filter - - the driver identifier - the source format - the wave filter - - - - Returns the number of output bytes for a given number of input bytes - - Number of input bytes - Number of output bytes - - - - Returns the number of source bytes for a given number of destination bytes - - Number of destination bytes - Number of source bytes - - - - Suggests an appropriate PCM format that the compressed format can be converted - to in one step - - The compressed format - The PCM format - - - - Returns the Source Buffer. Fill this with data prior to calling convert - - - - - Returns the Destination buffer. This will contain the converted data - after a successful call to Convert - - - - - Report that we have repositioned in the source stream - - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of source bytes actually converted - The number of converted bytes in the DestinationBuffer - - - - Converts the contents of the SourceBuffer into the DestinationBuffer - - The number of bytes in the SourceBuffer - that need to be converted - The number of converted bytes in the DestinationBuffer - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - Frees resources associated with this ACM Stream - - - - - ACMSTREAMHEADER_STATUSF_DONE - - - - - ACMSTREAMHEADER_STATUSF_PREPARED - - - - - ACMSTREAMHEADER_STATUSF_INQUEUE - - - - - Interop structure for ACM stream headers. - ACMSTREAMHEADER - http://msdn.microsoft.com/en-us/library/dd742926%28VS.85%29.aspx - - - - - ACM_STREAMOPENF_QUERY, ACM will be queried to determine whether it supports the given conversion. A conversion stream will not be opened, and no handle will be returned in the phas parameter. - - - - - ACM_STREAMOPENF_ASYNC, Stream conversion should be performed asynchronously. If this flag is specified, the application can use a callback function to be notified when the conversion stream is opened and closed and after each buffer is converted. In addition to using a callback function, an application can examine the fdwStatus member of the ACMSTREAMHEADER structure for the ACMSTREAMHEADER_STATUSF_DONE flag. - - - - - ACM_STREAMOPENF_NONREALTIME, ACM will not consider time constraints when converting the data. By default, the driver will attempt to convert the data in real time. For some formats, specifying this flag might improve the audio quality or other characteristics. - - - - - CALLBACK_TYPEMASK, callback type mask - - - - - CALLBACK_NULL, no callback - - - - - CALLBACK_WINDOW, dwCallback is a HWND - - - - - CALLBACK_TASK, dwCallback is a HTASK - - - - - CALLBACK_FUNCTION, dwCallback is a FARPROC - - - - - CALLBACK_THREAD, thread ID replaces 16 bit task - - - - - CALLBACK_EVENT, dwCallback is an EVENT Handle - - - - - ACM_STREAMSIZEF_SOURCE - - - - - ACM_STREAMSIZEF_DESTINATION - - - - - Summary description for WaveFilter. - - - - - cbStruct - - - - - dwFilterTag - - - - - fdwFilter - - - - - reserved - - - - ACM_METRIC_COUNT_DRIVERS - - - ACM_METRIC_COUNT_CODECS - - - ACM_METRIC_COUNT_CONVERTERS - - - ACM_METRIC_COUNT_FILTERS - - - ACM_METRIC_COUNT_DISABLED - - - ACM_METRIC_COUNT_HARDWARE - - - ACM_METRIC_COUNT_LOCAL_DRIVERS - - - ACM_METRIC_COUNT_LOCAL_CODECS - - - ACM_METRIC_COUNT_LOCAL_CONVERTERS - - - ACM_METRIC_COUNT_LOCAL_FILTERS - - - ACM_METRIC_COUNT_LOCAL_DISABLED - - - ACM_METRIC_HARDWARE_WAVE_INPUT - - - ACM_METRIC_HARDWARE_WAVE_OUTPUT - - - ACM_METRIC_MAX_SIZE_FORMAT - - - ACM_METRIC_MAX_SIZE_FILTER - - - ACM_METRIC_DRIVER_SUPPORT - - - ACM_METRIC_DRIVER_PRIORITY - - - - ACM_STREAMCONVERTF_BLOCKALIGN - - - - - ACM_STREAMCONVERTF_START - - - - - ACM_STREAMCONVERTF_END - - - - - Wave Callback Strategy - - - - - Use a function - - - - - Create a new window (should only be done if on GUI thread) - - - - - Use an existing window handle - - - - - Use an event handle - - - - - WaveHeader interop structure (WAVEHDR) - http://msdn.microsoft.com/en-us/library/dd743837%28VS.85%29.aspx - - - - pointer to locked data buffer (lpData) - - - length of data buffer (dwBufferLength) - - - used for input only (dwBytesRecorded) - - - for client's use (dwUser) - - - assorted flags (dwFlags) - - - loop control counter (dwLoops) - - - PWaveHdr, reserved for driver (lpNext) - - - reserved for driver - - - - Wave Header Flags enumeration - - - - - WHDR_BEGINLOOP - This buffer is the first buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_DONE - Set by the device driver to indicate that it is finished with the buffer and is returning it to the application. - - - - - WHDR_ENDLOOP - This buffer is the last buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_INQUEUE - Set by Windows to indicate that the buffer is queued for playback. - - - - - WHDR_PREPARED - Set by Windows to indicate that the buffer has been prepared with the waveInPrepareHeader or waveOutPrepareHeader function. - - - - - WaveInCapabilities structure (based on WAVEINCAPS2 from mmsystem.h) - http://msdn.microsoft.com/en-us/library/ms713726(VS.85).aspx - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Number of channels supported - - - - - The product name - - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - Event Args for WaveInStream event - - - - - Creates new WaveInEventArgs - - - - - Buffer containing recorded data. Note that it might not be completely - full. - - - - - The number of recorded bytes in Buffer. - - - - - MME Wave function interop - - - - - CALLBACK_NULL - No callback - - - - - CALLBACK_FUNCTION - dwCallback is a FARPROC - - - - - CALLBACK_EVENT - dwCallback is an EVENT handle - - - - - CALLBACK_WINDOW - dwCallback is a HWND - - - - - CALLBACK_THREAD - callback is a thread ID - - - - - WIM_OPEN - - - - - WIM_CLOSE - - - - - WIM_DATA - - - - - WOM_CLOSE - - - - - WOM_DONE - - - - - WOM_OPEN - - - - - WaveOutCapabilities structure (based on WAVEOUTCAPS2 from mmsystem.h) - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/multimed/htm/_win32_waveoutcaps_str.asp - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Optional functionality supported by the device - - - - - Number of channels supported - - - - - Whether playback control is supported - - - - - The product name - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Supported wave formats for WaveOutCapabilities - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Flags indicating what features this WaveOut device supports - - - - supports pitch control (WAVECAPS_PITCH) - - - supports playback rate control (WAVECAPS_PLAYBACKRATE) - - - supports volume control (WAVECAPS_VOLUME) - - - supports separate left-right volume control (WAVECAPS_LRVOLUME) - - - (WAVECAPS_SYNC) - - - (WAVECAPS_SAMPLEACCURATE) - - - - Sample provider interface to make WaveChannel32 extensible - Still a bit ugly, hence internal at the moment - and might even make these into - bit depth converting WaveProviders - - - - - ADSR sample provider allowing you to specify attack, decay, sustain and release values - - - - - Creates a new AdsrSampleProvider with default values - - - - - Attack time in seconds - - - - - Release time in seconds - - - - - Reads audio from this sample provider - - - - - Enters the Release phase - - - - - The output WaveFormat - - - - - Sample Provider to concatenate multiple sample providers together - - - - - Creates a new ConcatenatingSampleProvider - - The source providers to play one after the other. Must all share the same sample rate and channel count - - - - The WaveFormat of this Sample Provider - - - - - Read Samples from this sample provider - - - - - Sample Provider to allow fading in and out - - - - - Creates a new FadeInOutSampleProvider - - The source stream with the audio to be faded in or out - If true, we start faded out - - - - Requests that a fade-in begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Requests that a fade-out begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Reads samples from this sample provider - - Buffer to read into - Offset within buffer to write to - Number of samples desired - Number of samples read - - - - WaveFormat of this SampleProvider - - - - - Simple SampleProvider that passes through audio unchanged and raises - an event every n samples with the maximum sample value from the period - for metering purposes - - - - - Number of Samples per notification - - - - - Raised periodically to inform the user of the max volume - - - - - Initialises a new instance of MeteringSampleProvider that raises 10 stream volume - events per second - - Source sample provider - - - - Initialises a new instance of MeteringSampleProvider - - source sampler provider - Number of samples between notifications - - - - The WaveFormat of this sample provider - - - - - Reads samples from this Sample Provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Event args for aggregated stream volume - - - - - Max sample values array (one for each channel) - - - - - A sample provider mixer, allowing inputs to be added and removed - - - - - Creates a new MixingSampleProvider, with no inputs, but a specified WaveFormat - - The WaveFormat of this mixer. All inputs must be in this format - - - - Creates a new MixingSampleProvider, based on the given inputs - - Mixer inputs - must all have the same waveformat, and must - all be of the same WaveFormat. There must be at least one input - - - - Returns the mixer inputs (read-only - use AddMixerInput to add an input - - - - - When set to true, the Read method always returns the number - of samples requested, even if there are no inputs, or if the - current inputs reach their end. Setting this to true effectively - makes this a never-ending sample provider, so take care if you plan - to write it out to a file. - - - - - Adds a WaveProvider as a Mixer input. - Must be PCM or IEEE float already - - IWaveProvider mixer input - - - - Adds a new mixer input - - Mixer input - - - - Raised when a mixer input has been removed because it has ended - - - - - Removes a mixer input - - Mixer input to remove - - - - Removes all mixer inputs - - - - - The output WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - SampleProvider event args - - - - - Constructs a new SampleProviderEventArgs - - - - - The Sample Provider - - - - - No nonsense mono to stereo provider, no volume adjustment, - just copies input to left and right. - - - - - Initializes a new instance of MonoToStereoSampleProvider - - Source sample provider - - - - WaveFormat of this provider - - - - - Reads samples from this provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Multiplier for left channel (default is 1.0) - - - - - Multiplier for right channel (default is 1.0) - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing sample provider, allowing re-patching of input channels to different - output channels - - Input sample providers. Must all be of the same sample rate, but can have any number of channels - Desired number of output channels. - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads samples from this sample provider - - Buffer to be filled with sample data - Offset into buffer to start writing to, usually 0 - Number of samples required - Number of samples read - - - - The output WaveFormat for this SampleProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Simple class that raises an event on every sample - - - - - Initializes a new instance of NotifyingSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Sample notifier - - - - - Allows you to: - 1. insert a pre-delay of silence before the source begins - 2. skip over a certain amount of the beginning of the source - 3. only play a set amount from the source - 4. insert silence at the end after the source is complete - - - - - Number of samples of silence to insert before playing source - - - - - Amount of silence to insert before playing - - - - - Number of samples in source to discard - - - - - Amount of audio to skip over from the source before beginning playback - - - - - Number of samples to read from source (if 0, then read it all) - - - - - Amount of audio to take from the source (TimeSpan.Zero means play to end) - - - - - Number of samples of silence to insert after playing source - - - - - Amount of silence to insert after playing source - - - - - Creates a new instance of offsetSampleProvider - - The Source Sample Provider to read from - - - - The WaveFormat of this SampleProvider - - - - - Reads from this sample provider - - Sample buffer - Offset within sample buffer to read to - Number of samples required - Number of samples read - - - - Converts a mono sample provider to stereo, with a customisable pan strategy - - - - - Initialises a new instance of the PanningSampleProvider - - Source sample provider, must be mono - - - - Pan value, must be between -1 (left) and 1 (right) - - - - - The pan strategy currently in use - - - - - The WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Pair of floating point values, representing samples or multipliers - - - - - Left value - - - - - Right value - - - - - Required Interface for a Panning Strategy - - - - - Gets the left and right multipliers for a given pan value - - Pan value from -1 to 1 - Left and right multipliers in a stereo sample pair - - - - Simplistic "balance" control - treating the mono input as if it was stereo - In the centre, both channels full volume. Opposite channel decays linearly - as balance is turned to to one side - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Square Root Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Sinus Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Linear Pan - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Converts an IWaveProvider containing 16 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm16BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Samples required - Number of samples read - - - - Converts an IWaveProvider containing 24 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm24BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 32 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm32BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 8 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm8BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples to read - Number of samples read - - - - Utility class that takes an IWaveProvider input at any bit depth - and exposes it as an ISampleProvider. Can turn mono inputs into stereo, - and allows adjusting of volume - (The eventual successor to WaveChannel32) - This class also serves as an example of how you can link together several simple - Sample Providers to form a more useful class. - - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - force mono inputs to become stereo - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - The WaveFormat of this Sample Provider - - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Raised periodically to inform the user of the max volume - (before the volume meter) - - - - - Helper base class for classes converting to ISampleProvider - - - - - Source Wave Provider - - - - - Source buffer (to avoid constantly creating small buffers during playback) - - - - - Initialises a new instance of SampleProviderConverterBase - - Source Wave provider - - - - Wave format of this wave provider - - - - - Reads samples from the source wave provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Ensure the source buffer exists and is big enough - - Bytes required - - - - Utility class for converting to SampleProvider - - - - - Helper function to go from IWaveProvider to a SampleProvider - Must already be PCM or IEEE float - - The WaveProvider to convert - A sample provider - - - - Helper class for when you need to convert back to an IWaveProvider from - an ISampleProvider. Keeps it as IEEE float - - - - - Initializes a new instance of the WaveProviderFloatToWaveProvider class - - Source wave provider - - - - Reads from this provider - - - - - The waveformat of this WaveProvider (same as the source) - - - - - Converts a sample provider to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts a sample provider to 24 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream, clipping if necessary - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - The Format of this IWaveProvider - - - - - - Volume of this channel. 1.0 = full scale, 0.0 to mute - - - - - Signal Generator - Sin, Square, Triangle, SawTooth, White Noise, Pink Noise, Sweep. - - - Posibility to change ISampleProvider - Example : - --------- - WaveOut _waveOutGene = new WaveOut(); - WaveGenerator wg = new SignalGenerator(); - wg.Type = ... - wg.Frequency = ... - wg ... - _waveOutGene.Init(wg); - _waveOutGene.Play(); - - - - - Initializes a new instance for the Generator (Default :: 44.1Khz, 2 channels, Sinus, Frequency = 440, Gain = 1) - - - - - Initializes a new instance for the Generator (UserDef SampleRate & Channels) - - Desired sample rate - Number of channels - - - - The waveformat of this WaveProvider (same as the source) - - - - - Frequency for the Generator. (20.0 - 20000.0 Hz) - Sin, Square, Triangle, SawTooth, Sweep (Start Frequency). - - - - - Return Log of Frequency Start (Read only) - - - - - End Frequency for the Sweep Generator. (Start Frequency in Frequency) - - - - - Return Log of Frequency End (Read only) - - - - - Gain for the Generator. (0.0 to 1.0) - - - - - Channel PhaseReverse - - - - - Type of Generator. - - - - - Length Seconds for the Sweep Generator. - - - - - Reads from this provider. - - - - - Private :: Random for WhiteNoise & Pink Noise (Value form -1 to 1) - - Random value from -1 to +1 - - - - Signal Generator type - - - - - Pink noise - - - - - White noise - - - - - Sweep - - - - - Sine wave - - - - - Square wave - - - - - Triangle Wave - - - - - Sawtooth wave - - - - - Author: Freefall - Date: 05.08.16 - Based on: the port of Stephan M. Bernsee´s pitch shifting class - Port site: https://sites.google.com/site/mikescoderama/pitch-shifting - Test application and github site: https://github.com/Freefall63/NAudio-Pitchshifter - - NOTE: I strongly advice to add a Limiter for post-processing. - For my needs the FastAttackCompressor1175 provides acceptable results: - https://github.com/Jiyuu/SkypeFX/blob/master/JSNet/FastAttackCompressor1175.cs - - UPDATE: Added a simple Limiter based on the pydirac implementation. - https://github.com/echonest/remix/blob/master/external/pydirac225/source/Dirac_LE.cpp - - - - - - Creates a new SMB Pitch Shifting Sample Provider with default settings - - Source provider - - - - Creates a new SMB Pitch Shifting Sample Provider with custom settings - - Source provider - FFT Size (any power of two <= 4096: 4096, 2048, 1024, 512, ...) - Oversampling (number of overlapping windows) - Initial pitch (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - Read from this sample provider - - - - - WaveFormat - - - - - Pitch Factor (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - - Takes a stereo input and turns it to mono - - - - - Creates a new mono ISampleProvider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this SampleProvider - - - - - Very simple sample provider supporting adjustable gain - - - - - Initializes a new instance of VolumeSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Helper class turning an already 32 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Helper class turning an already 64 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Fully managed resampling sample provider, based on the WDL Resampler - - - - - Constructs a new resampler - - Source to resample - Desired output sample rate - - - - Reads from this sample provider - - - - - Output WaveFormat - - - - - Useful extension methods to make switching between WaveAndSampleProvider easier - - - - - Converts a WaveProvider into a SampleProvider (only works for PCM) - - WaveProvider to convert - - - - - Allows sending a SampleProvider directly to an IWavePlayer without needing to convert - back to an IWaveProvider - - The WavePlayer - - - - - - Turns WaveFormatExtensible into a standard waveformat if possible - - Input wave format - A standard PCM or IEEE waveformat, or the original waveformat - - - - Converts a ISampleProvider to a IWaveProvider but still 32 bit float - - SampleProvider to convert - An IWaveProvider - - - - Converts a ISampleProvider to a IWaveProvider but and convert to 16 bit - - SampleProvider to convert - A 16 bit IWaveProvider - - - - Concatenates one Sample Provider on the end of another - - The sample provider to play first - The sample provider to play next - A single sampleprovider to play one after the other - - - - Concatenates one Sample Provider on the end of another with silence inserted - - The sample provider to play first - Silence duration to insert between the two - The sample provider to play next - A single sample provider - - - - Skips over a specified amount of time (by consuming source stream) - - Source sample provider - Duration to skip over - A sample provider that skips over the specified amount of time - - - - Takes a specified amount of time from the source stream - - Source sample provider - Duration to take - A sample provider that reads up to the specified amount of time - - - - Converts a Stereo Sample Provider to mono, allowing mixing of channel volume - - Stereo Source Provider - Amount of left channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - Amount of right channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - A mono SampleProvider - - - - Converts a Mono ISampleProvider to stereo - - Mono Source Provider - Amount to mix to left channel (1.0 is full volume) - Amount to mix to right channel (1.0 is full volume) - - - - - Microsoft ADPCM - See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm - - - - - Empty constructor needed for marshalling from a pointer - - - - - Samples per block - - - - - Number of coefficients - - - - - Coefficients - - - - - Microsoft ADPCM - - Sample Rate - Channels - - - - Serializes this wave format - - Binary writer - - - - String Description of this WaveFormat - - - - - GSM 610 - - - - - Creates a GSM 610 WaveFormat - For now hardcoded to 13kbps - - - - - Samples per block - - - - - Writes this structure to a BinaryWriter - - - - - IMA/DVI ADPCM Wave Format - Work in progress - - - - - parameterless constructor for Marshalling - - - - - Creates a new IMA / DVI ADPCM Wave Format - - Sample Rate - Number of channels - Bits Per Sample - - - - MP3 WaveFormat, MPEGLAYER3WAVEFORMAT from mmreg.h - - - - - Wave format ID (wID) - - - - - Padding flags (fdwFlags) - - - - - Block Size (nBlockSize) - - - - - Frames per block (nFramesPerBlock) - - - - - Codec Delay (nCodecDelay) - - - - - Creates a new MP3 WaveFormat - - - - - Wave Format Padding Flags - - - - - MPEGLAYER3_FLAG_PADDING_ISO - - - - - MPEGLAYER3_FLAG_PADDING_ON - - - - - MPEGLAYER3_FLAG_PADDING_OFF - - - - - Wave Format ID - - - - MPEGLAYER3_ID_UNKNOWN - - - MPEGLAYER3_ID_MPEG - - - MPEGLAYER3_ID_CONSTANTFRAMESIZE - - - - DSP Group TrueSpeech - - - - - DSP Group TrueSpeech WaveFormat - - - - - Writes this structure to a BinaryWriter - - - - - Represents a Wave file format - - - - format type - - - number of channels - - - sample rate - - - for buffer estimation - - - block size of data - - - number of bits per sample of mono data - - - number of following bytes - - - - Creates a new PCM 44.1Khz stereo 16 bit format - - - - - Creates a new 16 bit wave format with the specified sample - rate and channel count - - Sample Rate - Number of channels - - - - Gets the size of a wave buffer equivalent to the latency in milliseconds. - - The milliseconds. - - - - - Creates a WaveFormat with custom members - - The encoding - Sample Rate - Number of channels - Average Bytes Per Second - Block Align - Bits Per Sample - - - - - Creates an A-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a Mu-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a new PCM format with the specified sample rate, bit depth and channels - - - - - Creates a new 32 bit IEEE floating point wave format - - sample rate - number of channels - - - - Helper function to retrieve a WaveFormat structure from a pointer - - WaveFormat structure - - - - - Helper function to marshal WaveFormat to an IntPtr - - WaveFormat - IntPtr to WaveFormat structure (needs to be freed by callee) - - - - Reads in a WaveFormat (with extra data) from a fmt chunk (chunk identifier and - length should already have been read) - - Binary reader - Format chunk length - A WaveFormatExtraData - - - - Reads a new WaveFormat object from a stream - - A binary reader that wraps the stream - - - - Reports this WaveFormat as a string - - String describing the wave format - - - - Compares with another WaveFormat object - - Object to compare to - True if the objects are the same - - - - Provides a Hashcode for this WaveFormat - - A hashcode - - - - Returns the encoding type used - - - - - Writes this WaveFormat object to a stream - - the output stream - - - - Returns the number of channels (1=mono,2=stereo etc) - - - - - Returns the sample rate (samples per second) - - - - - Returns the average number of bytes used per second - - - - - Returns the block alignment - - - - - Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) - Can be 0 for some codecs - - - - - Returns the number of extra bytes used by this waveformat. Often 0, - except for compressed formats which store extra data after the WAVEFORMATEX header - - - - - Summary description for WaveFormatEncoding. - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - - - - - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - WAVE_FORMAT_EXTENSIBLE - - - - - - - WaveFormatExtensible - http://www.microsoft.com/whdc/device/audio/multichaud.mspx - - - - - Parameterless constructor for marshalling - - - - - Creates a new WaveFormatExtensible for PCM or IEEE - - - - - WaveFormatExtensible for PCM or floating point can be awkward to work with - This creates a regular WaveFormat structure representing the same audio format - Returns the WaveFormat unchanged for non PCM or IEEE float - - - - - - SubFormat (may be one of AudioMediaSubtypes) - - - - - Serialize - - - - - - String representation - - - - - This class used for marshalling from unmanaged code - - - - - Allows the extra data to be read - - - - - parameterless constructor for marshalling - - - - - Reads this structure from a BinaryReader - - - - - Writes this structure to a BinaryWriter - - - - - The WMA wave format. - May not be much use because WMA codec is a DirectShow DMO not an ACM - - - - - Generic interface for wave recording - - - - - Recording WaveFormat - - - - - Start Recording - - - - - Stop Recording - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - WASAPI Loopback Capture - based on a contribution from "Pygmy" - http://naudio.codeplex.com/discussions/203605 - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Gets the default audio loopback capture device - - The default audio loopback capture device - - - - Capturing wave format - - - - - Specify loopback - - - - - Recording using waveIn api with event callbacks. - Use this for recording in non-gui applications - Events are raised as recorded buffers are made available - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Prepares a Wave input device for recording - - - - - Returns the number of Wave In devices available in the system - - - - - Retrieves the capabilities of a waveIn device - - Device to test - The WaveIn device capabilities - - - - Milliseconds for the buffer. Recommended value is 100ms - - - - - Number of Buffers to use (usually 2 or 3) - - - - - The device number to use - - - - - Start recording - - - - - Stop recording - - - - - Gets the current position in bytes from the wave input device. - it calls directly into waveInGetPosition) - - Position in bytes - - - - WaveFormat we are recording in - - - - - Dispose pattern - - - - - Microphone Level - - - - - Dispose method - - - - - This class writes audio data to a .aif file on disk - - - - - Creates an Aiff file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Aiff File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - AiffFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new AiffFileWriter - - The filename to write to - The Wave Format of the output data - - - - The aiff file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this aiff file - - - - - Returns false: Cannot read from a AiffFileWriter - - - - - Returns true: Can write to a AiffFileWriter - - - - - Returns false: Cannot seek within a AiffFileWriter - - - - - Read is not supported for a AiffFileWriter - - - - - Seek is not supported for a AiffFileWriter - - - - - SetLength is not supported for AiffFileWriter - - - - - - Gets the Position in the AiffFile (i.e. number of bytes written so far) - - - - - Appends bytes to the AiffFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Aiff file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Aiff file - They will be converted to the appropriate bit depth depending on the WaveFormat of the AIF file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Aiff file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this AiffFileWriter - - - - - Raised when ASIO data has been recorded. - It is important to handle this as quickly as possible as it is in the buffer callback - - - - - Initialises a new instance of AsioAudioAvailableEventArgs - - Pointers to the ASIO buffers for each channel - Pointers to the ASIO buffers for each channel - Number of samples in each buffer - Audio format within each buffer - - - - Pointer to a buffer per input channel - - - - - Pointer to a buffer per output channel - Allows you to write directly to the output buffers - If you do so, set SamplesPerBuffer = true, - and make sure all buffers are written to with valid data - - - - - Set to true if you have written to the output buffers - If so, AsioOut will not read from its source - - - - - Number of samples in each buffer - - - - - Converts all the recorded audio into a buffer of 32 bit floating point samples, interleaved by channel - - The samples as 32 bit floating point, interleaved - - - - Audio format within each buffer - Most commonly this will be one of, Int32LSB, Int16LSB, Int24LSB or Float32LSB - - - - - Gets as interleaved samples, allocating a float array - - The samples as 32 bit floating point values - - - - ASIO Out Player. New implementation using an internal C# binding. - - This implementation is only supporting Short16Bit and Float32Bit formats and is optimized - for 2 outputs channels . - SampleRate is supported only if AsioDriver is supporting it - - This implementation is probably the first AsioDriver binding fully implemented in C#! - - Original Contributor: Mark Heath - New Contributor to C# binding : Alexandre Mutel - email: alexandre_mutel at yahoo.fr - - - - - Playback Stopped - - - - - When recording, fires whenever recorded audio is available - - - - - Initializes a new instance of the class with the first - available ASIO Driver. - - - - - Initializes a new instance of the class with the driver name. - - Name of the device. - - - - Opens an ASIO output device - - Device number (zero based) - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Dispose - - - - - Gets the names of the installed ASIO Driver. - - an array of driver names - - - - Determines whether ASIO is supported. - - - true if ASIO is supported; otherwise, false. - - - - - Inits the driver from the asio driver name. - - Name of the driver. - - - - Shows the control panel - - - - - Starts playback - - - - - Stops playback - - - - - Pauses playback - - - - - Initialises to play - - Source wave provider - - - - Initialises to play, with optional recording - - Source wave provider - set to null for record only - Number of channels to record - Specify sample rate here if only recording, ignored otherwise - - - - driver buffer update callback to fill the wave buffer. - - The input channels. - The output channels. - - - - Gets the latency (in ms) of the playback driver - - - - - Automatically stop when the end of the input stream is reached - Disable this if auto-stop is causing hanging issues - - - - - A flag to let you know that we have reached the end of the input file - Useful if AutoStop is set to false - You can monitor this yourself and call Stop when it is true - - - - - Playback State - - - - - Driver Name - - - - - The number of output channels we are currently using for playback - (Must be less than or equal to DriverOutputChannelCount) - - - - - The number of input channels we are currently recording from - (Must be less than or equal to DriverInputChannelCount) - - - - - The maximum number of input channels this ASIO driver supports - - - - - The maximum number of output channels this ASIO driver supports - - - - - The number of samples per channel, per buffer. - - - - - By default the first channel on the input WaveProvider is sent to the first ASIO output. - This option sends it to the specified channel number. - Warning: make sure you don't set it higher than the number of available output channels - - the number of source channels. - n.b. Future NAudio may modify this - - - - - Input channel offset (used when recording), allowing you to choose to record from just one - specific input rather than them all - - - - - Sets the volume (1.0 is unity gain) - Not supported for ASIO Out. Set the volume on the input stream instead - - - - - Get the input channel name - - channel index (zero based) - channel name - - - - Get the output channel name - - channel index (zero based) - channel name - - - - https://tech.ebu.ch/docs/tech/tech3285.pdf - - - - - Constructs a new BextChunkInfo - - - - - Description (max 256 chars) - - - - - Originator (max 32 chars) - - - - - Originator Reference (max 32 chars) - - - - - Originator Date Time - - - - - Origination Date as string - - - - - Origination as time - - - - - Time reference (first sample count since midnight) - - - - - version 2 has loudness stuff which we don't know so using version 1 - - - - - 64 bytes http://en.wikipedia.org/wiki/UMID - - - - - for version 2 = 180 bytes (10 before are loudness values), using version 1 = 190 bytes - - - - - Coding history arbitrary length string at end of structure - http://www.ebu.ch/CMSimages/fr/tec_text_r98-1999_tcm7-4709.pdf - A=PCM,F=48000,W=16,M=stereo,T=original,CR/LF - - - - - Broadcast WAVE File Writer - - - - - Createa a new BwfWriter - - Rarget filename - WaveFormat - Chunk information - - - - Write audio data to this BWF - - - - - Flush writer, and fix up header sizes - - - - - Disposes this writer - - - - - A wave file writer that adds cue support - - - - - Writes a wave file, including a cues chunk - - - - - Adds a cue to the Wave file - - Sample position - Label text - - - - Updates the header, and writes the cues out - - - - - NativeDirectSoundOut using DirectSound COM interop. - Contact author: Alexandre Mutel - alexandre_mutel at yahoo.fr - Modified by: Graham "Gee" Plumb - - - - - Playback Stopped - - - - - Gets the DirectSound output devices in the system - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - (40ms seems to work under Vista). - - The latency. - Selected device - - - - Releases unmanaged resources and performs other cleanup operations before the - is reclaimed by garbage collection. - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets the current position from the wave output device. - - - - - Initialise playback - - The waveprovider to be played - - - - Current playback state - - - - - - The volume 1.0 is full scale - - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Determines whether the SecondaryBuffer is lost. - - - true if [is buffer lost]; otherwise, false. - - - - - Convert ms to bytes size according to WaveFormat - - The ms - number of byttes - - - - Processes the samples in a separate thread. - - - - - Stop playback - - - - - Clean up the SecondaryBuffer - - - - In DirectSound, when playback is started, - the rest of the sound that was played last time is played back as noise. - This happens even if the secondary buffer is completely silenced, - so it seems that the buffer in the primary buffer or higher is not cleared. - - - To solve this problem fill the secondary buffer with silence data when stop playback. - - - - - - Feeds the SecondaryBuffer with the WaveStream - - number of bytes to feed - - - - IDirectSound interface - - - - - IDirectSoundBuffer interface - - - - - IDirectSoundNotify interface - - - - - Instanciate DirectSound from the DLL - - The GUID. - The direct sound. - The p unk outer. - - - - DirectSound default playback device GUID - - - - - DirectSound default capture device GUID - - - - - DirectSound default device for voice playback - - - - - DirectSound default device for voice capture - - - - - The DSEnumCallback function is an application-defined callback function that enumerates the DirectSound drivers. - The system calls this function in response to the application's call to the DirectSoundEnumerate or DirectSoundCaptureEnumerate function. - - Address of the GUID that identifies the device being enumerated, or NULL for the primary device. This value can be passed to the DirectSoundCreate8 or DirectSoundCaptureCreate8 function to create a device object for that driver. - Address of a null-terminated string that provides a textual description of the DirectSound device. - Address of a null-terminated string that specifies the module name of the DirectSound driver corresponding to this device. - Address of application-defined data. This is the pointer passed to DirectSoundEnumerate or DirectSoundCaptureEnumerate as the lpContext parameter. - Returns TRUE to continue enumerating drivers, or FALSE to stop. - - - - The DirectSoundEnumerate function enumerates the DirectSound drivers installed in the system. - - callback function - User context - - - - Gets the HANDLE of the desktop window. - - HANDLE of the Desktop window - - - - Class for enumerating DirectSound devices - - - - - The device identifier - - - - - Device description - - - - - Device module name - - - - - IWaveBuffer interface use to store wave datas. - Data can be manipulated with arrays (,, - , ) that are pointing to the same memory buffer. - This is a requirement for all subclasses. - - Use the associated Count property based on the type of buffer to get the number of data in the - buffer. - - for the standard implementation using C# unions. - - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets the byte buffer count. - - The byte buffer count. - - - - Gets the float buffer count. - - The float buffer count. - - - - Gets the short buffer count. - - The short buffer count. - - - - Gets the int buffer count. - - The int buffer count. - - - - Represents the interface to a device that can play a WaveFile - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Initialise playback - - The waveprovider to be played - - - - The volume - 1.0f is full scale - Note that not all implementations necessarily support volume changes - - - - - Current playback state - - - - - Indicates that playback has gone into a stopped state due to - reaching the end of the input stream or an error has been encountered during playback - - - - - Interface for IWavePlayers that can report position - - - - - Position (in terms of bytes played - does not necessarily translate directly to the position within the source audio file) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Generic interface for all WaveProviders. - - - - - Gets the WaveFormat of this WaveProvider. - - The wave format. - - - - Fill the specified buffer with wave data. - - The buffer to fill of wave data. - Offset into buffer - The number of bytes to read - the number of bytes written to the buffer. - - - - Like IWaveProvider, but makes it much simpler to put together a 32 bit floating - point mixing engine - - - - - Gets the WaveFormat of this Sample Provider. - - The wave format. - - - - Fill the specified buffer with 32 bit floating point samples - - The buffer to fill with samples. - Offset into buffer - The number of samples to read - the number of samples written to the buffer. - - - - Media Foundation Encoder class allows you to use Media Foundation to encode an IWaveProvider - to any supported encoding format - - - - - Queries the available bitrates for a given encoding output type, sample rate and number of channels - - Audio subtype - a value from the AudioSubtypes class - The sample rate of the PCM to encode - The number of channels of the PCM to encode - An array of available bitrates in average bits per second - - - - Gets all the available media types for a particular - - Audio subtype - a value from the AudioSubtypes class - An array of available media types that can be encoded with this subtype - - - - Helper function to simplify encoding Window Media Audio - Should be supported on Vista and above (not tested) - - Input provider, must be PCM - Output file path, should end with .wma - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to MP3 - By default, will only be available on Windows 8 and above - - Input provider, must be PCM - Output file path, should end with .mp3 - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Helper function to simplify encoding to AAC - By default, will only be available on Windows 7 and above - - Input provider, must be PCM - Output file path, should end with .mp4 (or .aac on Windows 8) - Desired bitrate. Use GetEncodeBitrates to find the possibilities for your input type - - - - Tries to find the encoding media type with the closest bitrate to that specified - - Audio subtype, a value from AudioSubtypes - Your encoder input format (used to check sample rate and channel count) - Your desired bitrate - The closest media type, or null if none available - - - - Creates a new encoder that encodes to the specified output media type - - Desired output media type - - - - Encodes a file - - Output filename (container type is deduced from the filename) - Input provider (should be PCM, some encoders will also allow IEEE float) - - - - Disposes this instance - - - - - - Disposes this instance - - - - - Finalizer - - - - - Playback State - - - - - Stopped - - - - - Playing - - - - - Paused - - - - - Stopped Event Args - - - - - Initializes a new instance of StoppedEventArgs - - An exception to report (null if no exception) - - - - An exception. Will be null if the playback or record operation stopped due to - the user requesting stop or reached the end of the input audio - - - - - Support for playback using Wasapi - - - - - Playback Stopped - - - - - WASAPI Out shared mode, default - - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - Desired latency in milliseconds - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Creates a new WASAPI Output - - Device to use - - true if sync is done with event. false use sleep. - Desired latency in milliseconds - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Begin Playback - - - - - Stop playback and flush buffers - - - - - Stop playback without flushing buffers - - - - - Initialize for playing the specified wave stream - - IWaveProvider to play - - - - Playback State - - - - - Volume - - - - - Retrieve the AudioStreamVolume object for this audio stream - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Dispose - - - - - WaveBuffer class use to store wave datas. Data can be manipulated with arrays - (,,, ) that are pointing to the - same memory buffer. Use the associated Count property based on the type of buffer to get the number of - data in the buffer. - Implicit casting is now supported to float[], byte[], int[], short[]. - You must not use Length on returned arrays. - - n.b. FieldOffset is 8 now to allow it to work natively on 64 bit - - - - - Number of Bytes - - - - - Initializes a new instance of the class. - - The number of bytes. The size of the final buffer will be aligned on 4 Bytes (upper bound) - - - - Initializes a new instance of the class binded to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Binds this WaveBuffer instance to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets or sets the byte buffer count. - - The byte buffer count. - - - - Gets or sets the float buffer count. - - The float buffer count. - - - - Gets or sets the short buffer count. - - The short buffer count. - - - - Gets or sets the int buffer count. - - The int buffer count. - - - - Clears the associated buffer. - - - - - Copy this WaveBuffer to a destination buffer up to ByteBufferCount bytes. - - - - - Checks the validity of the count parameters. - - Name of the arg. - The value. - The size of value. - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - Writes to a stream by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The stream the method will output to - The source WaveProvider - - - - WaveFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new WaveFileWriter - - The filename to write to - The Wave Format of the output data - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - Total time (calculated from Length and average bytes per second) - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriter - - - - - Returns true: Can write to a WaveFileWriter - - - - - Returns false: Cannot seek within a WaveFileWriter - - - - - Read is not supported for a WaveFileWriter - - - - - Seek is not supported for a WaveFileWriter - - - - - SetLength is not supported for WaveFileWriter - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - Also updates header, so that WAV file will be valid up to the point currently written - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriter - - - - - Alternative WaveOut class, making use of the Event callback - - - - - Indicates playback has stopped automatically - - - - - Gets or sets the desired latency in milliseconds - Should be set before a call to Init - - - - - Gets or sets the number of buffers used - Should be set before a call to Init - - - - - Gets or sets the device number - Should be set before a call to Init - This must be between -1 and DeviceCount - 1. - -1 means stick to default device even default device is changed - - - - - Opens a WaveOut device - - - - - Initialises the WaveOut device - - WaveProvider to play - - - - Start playing the audio from the WaveStream - - - - - Pause the audio - - - - - Resume playing after a pause from the same position - - - - - Stop and reset the WaveOut device - - - - - Gets the current position in bytes from the wave output device. - (n.b. this is not the same thing as the position within your reader - stream - it calls directly into waveOutGetPosition) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Playback State - - - - - Volume for this device 1.0 is full scale - - - - - Closes this WaveOut device - - - - - Closes the WaveOut device and disposes of buffers - - True if called from Dispose - - - - Finalizer. Only called when user forgets to call Dispose - - - - - Provides a buffered store of samples - Read method will return queued samples or fill buffer with zeroes - Now backed by a circular buffer - - - - - Creates a new buffered WaveProvider - - WaveFormat - - - - If true, always read the amount of data requested, padding with zeroes if necessary - By default is set to true - - - - - Buffer length in bytes - - - - - Buffer duration - - - - - If true, when the buffer is full, start throwing away data - if false, AddSamples will throw an exception when buffer is full - - - - - The number of buffered bytes - - - - - Buffered Duration - - - - - Gets the WaveFormat - - - - - Adds samples. Takes a copy of buffer, so that buffer can be reused if necessary - - - - - Reads from this WaveProvider - Will always return count bytes, since we will zero-fill the buffer if not enough available - - - - - Discards all audio from the buffer - - - - - Provide WaveProvider that can apply effects in real time using DMO. - - If the audio thread is running on the STA thread, please generate and operate from the same thread. - If the audio thread is running on the MTA thread, please operate on any MTA thread. - - Types of DMO effectors to use - Parameters of the effect to be used - - - - Create a new DmoEffectWaveProvider - - Input Stream - - - - Stream Wave Format - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Get Effector Parameters - - - - - Dispose - - - - - The Media Foundation Resampler Transform - - - - - Creates the Media Foundation Resampler, allowing modifying of sample rate, bit depth and channel count - - Source provider, must be PCM - Output format, must also be PCM - - - - Creates a resampler with a specified target output sample rate - - Source provider - Output sample rate - - - - Creates and configures the actual Resampler transform - - A newly created and configured resampler MFT - - - - Gets or sets the Resampler quality. n.b. set the quality before starting to resample. - 1 is lowest quality (linear interpolation) and 60 is best quality - - - - - Disposes this resampler - - - - - WaveProvider that can mix together multiple 32 bit floating point input provider - All channels must have the same number of inputs and same sample rate - n.b. Work in Progress - not tested yet - - - - - Creates a new MixingWaveProvider32 - - - - - Creates a new 32 bit MixingWaveProvider32 - - inputs - must all have the same format. - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove an input from the mixer - - waveProvider to remove - - - - The number of inputs to this mixer - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Converts from mono to stereo, allowing freedom to route all, some, or none of the incoming signal to left or right channels - - - - - Creates a new stereo waveprovider based on a mono input - - Mono 16 bit PCM input - - - - 1.0 to copy the mono stream to the left channel without adjusting volume - - - - - 1.0 to copy the mono stream to the right channel without adjusting volume - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels. Number of outputs is equal to total number of channels in inputs - - Input wave providers. Must all be of the same format, but can have any number of channels - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels - - Input wave providers. Must all be of the same format, but can have any number of channels - Desired number of output channels. (-1 means use total number of input channels) - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads data from this WaveProvider - - Buffer to be filled with sample data - Offset to write to within buffer, usually 0 - Number of bytes required - Number of bytes read - - - - The WaveFormat of this WaveProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Silence producing wave provider - Useful for playing silence when doing a WASAPI Loopback Capture - - - - - Creates a new silence producing wave provider - - Desired WaveFormat (should be PCM / IEE float - - - - Read silence from into the buffer - - - - - WaveFormat of this silence producing wave provider - - - - - Takes a stereo 16 bit input and turns it mono, allowing you to select left or right channel only or mix them together - - - - - Creates a new mono waveprovider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Helper class allowing us to modify the volume of a 16 bit stream without converting to IEEE float - - - - - Constructs a new VolumeWaveProvider16 - - Source provider, must be 16 bit PCM - - - - Gets or sets volume. - 1.0 is full scale, 0.0 is silence, anything over 1.0 will amplify but potentially clip - - - - - WaveFormat of this WaveProvider - - - - - Read bytes from this WaveProvider - - Buffer to read into - Offset within buffer to read to - Bytes desired - Bytes read - - - - Converts 16 bit PCM to IEEE float, optionally adjusting volume along the way - - - - - Creates a new Wave16toFloatProvider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts IEEE float to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Creates a new WaveFloatTo16Provider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Buffered WaveProvider taking source data from WaveIn - - - - - Creates a new WaveInProvider - n.b. Should make sure the WaveFormat is set correctly on IWaveIn before calling - - The source of wave data - - - - Reads data from the WaveInProvider - - - - - The WaveFormat - - - - - Base class for creating a 16 bit wave provider - - - - - Initializes a new instance of the WaveProvider16 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider16 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a short array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Base class for creating a 32 bit floating point wave provider - Can also be used as a base class for an ISampleProvider that can - be plugged straight into anything requiring an IWaveProvider - - - - - Initializes a new instance of the WaveProvider32 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider32 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a float array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Utility class to intercept audio from an IWaveProvider and - save it to disk - - - - - Constructs a new WaveRecorder - - The location to write the WAV file to - The Source Wave Provider - - - - Read simply returns what the source returns, but writes to disk along the way - - - - - The WaveFormat - - - - - Closes the WAV file - - - - A read-only stream of AIFF data based on an aiff file - with an associated WaveFormat - originally contributed to NAudio by Giawa - - - - Supports opening a AIF file - The AIF is of similar nastiness to the WAV format. - This supports basic reading of uncompressed PCM AIF files, - with 8, 16, 24 and 32 bit PCM data. - - - - - Creates an Aiff File Reader based on an input stream - - The input stream containing a AIF file including header - - - - Ensures valid AIFF header and then finds data offset. - - The stream, positioned at the start of audio data - The format found - The position of the data chunk - The length of the data chunk - Additional chunks found - - - - Cleans up the resources associated with this AiffFileReader - - - - - - - - - - - - - - - Number of Samples (if possible to calculate) - - - - - Position in the AIFF file - - - - - - Reads bytes from the AIFF File - - - - - - AIFF Chunk - - - - - Chunk Name - - - - - Chunk Length - - - - - Chunk start - - - - - Creates a new AIFF Chunk - - - - - AudioFileReader simplifies opening an audio file in NAudio - Simply pass in the filename, and it will attempt to open the - file and set up a conversion path that turns into PCM IEEE float. - ACM codecs will be used for conversion. - It provides a volume property and implements both WaveStream and - ISampleProvider, making it possibly the only stage in your audio - pipeline necessary for simple playback scenarios - - - - - Initializes a new instance of AudioFileReader - - The file to open - - - - Creates the reader stream, supporting all filetypes in the core NAudio library, - and ensuring we are in PCM format - - File Name - - - - File Name - - - - - WaveFormat of this stream - - - - - Length of this stream (in bytes) - - - - - Position of this stream (in bytes) - - - - - Reads from this wave stream - - Audio buffer - Offset into buffer - Number of bytes required - Number of bytes read - - - - Reads audio from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Gets or Sets the Volume of this AudioFileReader. 1.0f is full volume - - - - - Helper to convert source to dest bytes - - - - - Helper to convert dest to source bytes - - - - - Disposes this AudioFileReader - - True if called from Dispose - - - - Helper stream that lets us read from compressed audio files with large block alignment - as though we could read any amount and reposition anywhere - - - - - Creates a new BlockAlignReductionStream - - the input stream - - - - Block alignment of this stream - - - - - Wave Format - - - - - Length of this Stream - - - - - Current position within stream - - - - - Disposes this WaveStream - - - - - Reads data from this stream - - - - - - - - - Implementation of Com IStream - - - - - Holds information on a cue: a labeled position within a Wave file - - - - - Cue position in samples - - - - - Label of the cue - - - - - Creates a Cue based on a sample position and label - - - - - - - Holds a list of cues - - - The specs for reading and writing cues from the cue and list RIFF chunks - are from http://www.sonicspot.com/guide/wavefiles.html and http://www.wotsit.org/ - ------------------------------ - The cues are stored like this: - ------------------------------ - struct CuePoint - { - Int32 dwIdentifier; - Int32 dwPosition; - Int32 fccChunk; - Int32 dwChunkStart; - Int32 dwBlockStart; - Int32 dwSampleOffset; - } - - struct CueChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwCuePoints; - CuePoint[] points; - } - ------------------------------ - Labels look like this: - ------------------------------ - struct ListHeader - { - Int32 listID; /* 'list' */ - Int32 chunkSize; /* includes the Type ID below */ - Int32 typeID; /* 'adtl' */ - } - - struct LabelChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwIdentifier; - Char[] dwText; /* Encoded with extended ASCII */ - } LabelChunk; - - - - - Creates an empty cue list - - - - - Adds an item to the list - - Cue - - - - Gets sample positions for the embedded cues - - Array containing the cue positions - - - - Gets labels for the embedded cues - - Array containing the labels - - - - Creates a cue list from the cue RIFF chunk and the list RIFF chunk - - The data contained in the cue chunk - The data contained in the list chunk - - - - Gets the cues as the concatenated cue and list RIFF chunks. - - RIFF chunks containing the cue data - - - - Number of cues - - - - - Accesses the cue at the specified index - - - - - - - Checks if the cue and list chunks exist and if so, creates a cue list - - - - - A wave file reader supporting cue reading - - - - - Loads a wavefile and supports reading cues - - - - - - Loads a wave from a stream and supports reading cues - - - - - - Cue List (can be null if cues not present) - - - - - An interface for WaveStreams which can report notification of individual samples - - - - - A sample has been detected - - - - - Sample event arguments - - - - - Left sample - - - - - Right sample - - - - - Constructor - - - - - Class for reading any file that Media Foundation can play - Will only work in Windows Vista and above - Automatically converts to PCM - If it is a video file with multiple audio streams, it will pick out the first audio stream - - - - - Allows customisation of this reader class - - - - - Sets up the default settings for MediaFoundationReader - - - - - Allows us to request IEEE float output (n.b. no guarantee this will be accepted) - - - - - If true, the reader object created in the constructor is used in Read - Should only be set to true if you are working entirely on an STA thread, or - entirely with MTA threads. - - - - - If true, the reposition does not happen immediately, but waits until the - next call to read to be processed. - - - - - Default constructor - - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename (can also be a URL e.g. http:// mms:// file://) - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename - Advanced settings - - - - Initializes - - - - - Creates the reader (overridable by ) - - - - - Reads from this wave stream - - Buffer to read into - Offset in buffer - Bytes required - Number of bytes read; 0 indicates end of stream - - - - WaveFormat of this stream (n.b. this is after converting to PCM) - - - - - The bytesRequired of this stream in bytes (n.b may not be accurate) - - - - - Current position within this stream - - - - - Cleans up after finishing with this reader - - true if called from Dispose - - - - WaveFormat has changed - - - - - Class for reading from MP3 files - - - - - The MP3 wave format (n.b. NOT the output format of this stream - see the WaveFormat property) - - - - Supports opening a MP3 file - - - Supports opening a MP3 file - MP3 File name - Factory method to build a frame decompressor - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - - - - Opens MP3 from a stream rather than a file - Will not dispose of this stream itself - - The incoming stream containing MP3 data - Factory method to build a frame decompressor - - - - Function that can create an MP3 Frame decompressor - - A WaveFormat object describing the MP3 file format - An MP3 Frame decompressor - - - - Creates an ACM MP3 Frame decompressor. This is the default with NAudio - - A WaveFormat object based - - - - - Gets the total length of this file in milliseconds. - - - - - ID3v2 tag if present - - - - - ID3v1 tag if present - - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - Reads the next mp3 frame - - Next mp3 frame, or null if EOF - - - - This is the length in bytes of data available to be read out from the Read method - (i.e. the decompressed MP3 length) - n.b. this may return 0 for files whose length is unknown - - - - - - - - - - - - - - - Reads decompressed PCM data from our MP3 file. - - - - - Xing header if present - - - - - Disposes this WaveStream - - - - - WaveStream that simply passes on data from its source stream - (e.g. a MemoryStream) - - - - - Initialises a new instance of RawSourceWaveStream - - The source stream containing raw audio - The waveformat of the audio in the source stream - - - - Initialises a new instance of RawSourceWaveStream - - The buffer containing raw audio - Offset in the source buffer to read from - Number of bytes to read in the buffer - The waveformat of the audio in the source stream - - - - The WaveFormat of this stream - - - - - The length in bytes of this stream (if supported) - - - - - The current position in this stream - - - - - Reads data from the stream - - - - - Wave Stream for converting between sample rates - - - - - WaveStream to resample using the DMO Resampler - - Input Stream - Desired Output Format - - - - Stream Wave Format - - - - - Stream length in bytes - - - - - Stream position in bytes - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Dispose - - True if disposing (not from finalizer) - - - - Holds information about a RIFF file chunk - - - - - Creates a RiffChunk object - - - - - The chunk identifier - - - - - The chunk identifier converted to a string - - - - - The chunk length - - - - - The stream position this chunk is located at - - - - - A simple compressor - - - - - Create a new simple compressor stream - - Source stream - - - - Make-up Gain - - - - - Threshold - - - - - Ratio - - - - - Attack time - - - - - Release time - - - - - Turns gain on or off - - - - - Gets the WaveFormat of this stream - - - - - Reads bytes from this stream - - Buffer to read into - Offset in array to read into - Number of bytes to read - Number of bytes read - - - - MediaFoundationReader supporting reading from a stream - - - - - Constructs a new media foundation reader from a stream - - - - - Creates the reader - - - - - WaveStream that converts 32 bit audio back down to 16 bit, clipping if necessary - - - - - The method reuses the same buffer to prevent - unnecessary allocations. - - - - - Creates a new Wave32To16Stream - - the source stream - - - - Sets the volume for this stream. 1.0f is full scale - - - - - - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - Destination buffer - Offset into destination buffer - - Number of bytes read. - - - - Conversion to 16 bit and clipping - - - - - - - - - - Clip indicator. Can be reset. - - - - - Disposes this WaveStream - - - - - Represents Channel for the WaveMixerStream - 32 bit output and 16 bit input - It's output is always stereo - The input stream can be panned - - - - - Creates a new WaveChannel32 - - the source stream - stream volume (1 is 0dB) - pan control (-1 to 1) - - - - Creates a WaveChannel32 with default settings - - The source stream - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - If true, Read always returns the number of bytes requested - - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Pan of this channel (from -1 to 1) - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - Sample - - - - - Raise the sample event (no check for null because it has already been done) - - - - This class supports the reading of WAV files, - providing a repositionable WaveStream that returns the raw data - contained in the WAV file - - - - Supports opening a WAV file - The WAV file format is a real mess, but we will only - support the basic WAV file format which actually covers the vast - majority of WAV files out there. For more WAV file format information - visit www.wotsit.org. If you have a WAV file that can't be read by - this class, email it to the NAudio project and we will probably - fix this reader to support it - - - - - Creates a Wave File Reader based on an input stream - - The input stream containing a WAV file including header - - - - Gets a list of the additional chunks found in this file - - - - - Gets the data for the specified chunk - - - - - Cleans up the resources associated with this WaveFileReader - - - - - - - - - - This is the length of audio data contained in this WAV file, in bytes - (i.e. the byte length of the data chunk, not the length of the WAV file itself) - - - - - - Number of Sample Frames (if possible to calculate) - This currently does not take into account number of channels - Multiply number of channels if you want the total number of samples - - - - - Position in the WAV data chunk. - - - - - - Reads bytes from the Wave File - - - - - - Attempts to read the next sample or group of samples as floating point normalised into the range -1.0f to 1.0f - - An array of samples, 1 for mono, 2 for stereo etc. Null indicates end of file reached - - - - - Attempts to read a sample into a float. n.b. only applicable for uncompressed formats - Will normalise the value read into the range -1.0f to 1.0f if it comes from a PCM encoding - - False if the end of the WAV data chunk was reached - - - - IWaveProvider that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source Provider - - - - Gets the WaveFormat of this stream - - - - - Indicates that a reposition has taken place, and internal buffers should be reset - - - - - Reads bytes from this stream - - Buffer to read into - Offset in buffer to read into - Number of bytes to read - Number of bytes read - - - - Disposes this stream - - true if the user called this - - - - Disposes this resource - - - - - Finalizer - - - - - WaveStream that passes through an ACM Codec - - - - - Create a new WaveFormat conversion stream - - Desired output format - Source stream - - - - Creates a stream that can convert to PCM - - The source stream - A PCM stream - - - - Gets or sets the current position in the stream - - - - - Converts source bytes to destination bytes - - - - - Converts destination bytes to source bytes - - - - - Returns the stream length - - - - - Gets the WaveFormat of this stream - - - - - - - Buffer to read into - Offset within buffer to write to - Number of bytes to read - Bytes read - - - - Disposes this stream - - true if the user called this - - - - A buffer of Wave samples - - - - - creates a new wavebuffer - - WaveIn device to write to - Buffer size in bytes - - - - Place this buffer back to record more audio - - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - - Provides access to the actual record buffer (for reading only) - - - - - Indicates whether the Done flag is set on this buffer - - - - - Indicates whether the InQueue flag is set on this buffer - - - - - Number of bytes recorded - - - - - The buffer size in bytes - - - - - WaveStream that can mix together multiple 32 bit input streams - (Normally used with stereo input channels) - All channels must have the same number of inputs - - - - - Creates a new 32 bit WaveMixerStream - - - - - Creates a new 32 bit WaveMixerStream - - An Array of WaveStreams - must all have the same format. - Use WaveChannel is designed for this purpose. - Automatically stop when all inputs have been read - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove a WaveStream from the mixer - - waveStream to remove - - - - The number of inputs to this mixer - - - - - Automatically stop when all inputs have been read - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Length of this Wave Stream (in bytes) - - - - - - Position within this Wave Stream (in bytes) - - - - - - - - - - - Disposes this WaveStream - - - - - Simply shifts the input stream in time, optionally - clipping its start and end. - (n.b. may include looping in the future) - - - - - Creates a new WaveOffsetStream - - the source stream - the time at which we should start reading from the source stream - amount to trim off the front of the source stream - length of time to play from source stream - - - - Creates a WaveOffsetStream with default settings (no offset or pre-delay, - and whole length of source stream) - - The source stream - - - - The length of time before which no audio will be played - - - - - An offset into the source stream from which to start playing - - - - - Length of time to read from the source stream - - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - A buffer of Wave samples for streaming to a Wave Output device - - - - - creates a new wavebuffer - - WaveOut device to write to - Buffer size in bytes - Stream to provide more data - Lock to protect WaveOut API's from being called on >1 thread - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - this is called by the WAVE callback and should be used to refill the buffer - - - - Whether the header's in queue flag is set - - - - - The buffer size in bytes - - - - - Base class for all WaveStream classes. Derives from stream. - - - - - Retrieves the WaveFormat for this stream - - - - - We can read from this stream - - - - - We can seek within this stream - - - - - We can't write to this stream - - - - - Flush does not need to do anything - See - - - - - An alternative way of repositioning. - See - - - - - Sets the length of the WaveStream. Not Supported. - - - - - - Writes to the WaveStream. Not Supported. - - - - - The block alignment for this wavestream. Do not modify the Position - to anything that is not a whole multiple of this value - - - - - Moves forward or backwards the specified number of seconds in the stream - - Number of seconds to move, can be negative - - - - The current position in the stream in Time format - - - - - Total length in real-time of the stream (may be an estimate for compressed files) - - - - - Whether the WaveStream has non-zero sample data at the current position for the - specified count - - Number of bytes to read - - - - MP3 Frame decompressor using the Windows Media MP3 Decoder DMO object - - - - - Initializes a new instance of the DMO MP3 Frame decompressor - - - - - - Converted PCM WaveFormat - - - - - Decompress a single frame of MP3 - - - - - Alerts us that a reposition has occured so the MP3 decoder needs to reset its state - - - - - Dispose of this obejct and clean up resources - - - - - http://tech.ebu.ch/docs/tech/tech3306-2009.pdf - - - - - WaveFormat - - - - - Data Chunk Position - - - - - Data Chunk Length - - - - - Riff Chunks - - - - - Soundfont generator - - - - - Gets the generator type - - - - - Generator amount as an unsigned short - - - - - Generator amount as a signed short - - - - - Low byte amount - - - - - High byte amount - - - - - Instrument - - - - - Sample Header - - - - - - - - - - Generator types - - - - Start address offset - - - End address offset - - - Start loop address offset - - - End loop address offset - - - Start address coarse offset - - - Modulation LFO to pitch - - - Vibrato LFO to pitch - - - Modulation envelope to pitch - - - Initial filter cutoff frequency - - - Initial filter Q - - - Modulation LFO to filter Cutoff frequency - - - Modulation envelope to filter cutoff frequency - - - End address coarse offset - - - Modulation LFO to volume - - - Unused - - - Chorus effects send - - - Reverb effects send - - - Pan - - - Unused - - - Unused - - - Unused - - - Delay modulation LFO - - - Frequency modulation LFO - - - Delay vibrato LFO - - - Frequency vibrato LFO - - - Delay modulation envelope - - - Attack modulation envelope - - - Hold modulation envelope - - - Decay modulation envelope - - - Sustain modulation envelop - - - Release modulation envelope - - - Key number to modulation envelope hold - - - Key number to modulation envelope decay - - - Delay volume envelope - - - Attack volume envelope - - - Hold volume envelope - - - Decay volume envelope - - - Sustain volume envelope - - - Release volume envelope - - - Key number to volume envelope hold - - - Key number to volume envelope decay - - - Instrument - - - Reserved - - - Key range - - - Velocity range - - - Start loop address coarse offset - - - Key number - - - Velocity - - - Initial attenuation - - - Reserved - - - End loop address coarse offset - - - Coarse tune - - - Fine tune - - - Sample ID - - - Sample modes - - - Reserved - - - Scale tuning - - - Exclusive class - - - Overriding root key - - - Unused - - - Unused - - - - A soundfont info chunk - - - - - SoundFont Version - - - - - WaveTable sound engine - - - - - Bank name - - - - - Data ROM - - - - - Creation Date - - - - - Author - - - - - Target Product - - - - - Copyright - - - - - Comments - - - - - Tools - - - - - ROM Version - - - - - - - - - - SoundFont instrument - - - - - instrument name - - - - - Zones - - - - - - - - - - Instrument Builder - - - - - Transform Types - - - - - Linear - - - - - Modulator - - - - - Source Modulation data type - - - - - Destination generator type - - - - - Amount - - - - - Source Modulation Amount Type - - - - - Source Transform Type - - - - - - - - - - Controller Sources - - - - - No Controller - - - - - Note On Velocity - - - - - Note On Key Number - - - - - Poly Pressure - - - - - Channel Pressure - - - - - Pitch Wheel - - - - - Pitch Wheel Sensitivity - - - - - Source Types - - - - - Linear - - - - - Concave - - - - - Convex - - - - - Switch - - - - - Modulator Type - - - - - - - - - - - A SoundFont Preset - - - - - Preset name - - - - - Patch Number - - - - - Bank number - 0 - 127, GM percussion bank is 128 - - - - - Zones - - - - - - - - - - Class to read the SoundFont file presets chunk - - - - - The Presets contained in this chunk - - - - - The instruments contained in this chunk - - - - - The sample headers contained in this chunk - - - - - - - - - - just reads a chunk ID at the current position - - chunk ID - - - - reads a chunk at the current position - - - - - creates a new riffchunk from current position checking that we're not - at the end of this chunk first - - the new chunk - - - - useful for chunks that just contain a string - - chunk as string - - - - A SoundFont Sample Header - - - - - The sample name - - - - - Start offset - - - - - End offset - - - - - Start loop point - - - - - End loop point - - - - - Sample Rate - - - - - Original pitch - - - - - Pitch correction - - - - - Sample Link - - - - - SoundFont Sample Link Type - - - - - - - - - - SoundFont sample modes - - - - - No loop - - - - - Loop Continuously - - - - - Reserved no loop - - - - - Loop and continue - - - - - Sample Link Type - - - - - Mono Sample - - - - - Right Sample - - - - - Left Sample - - - - - Linked Sample - - - - - ROM Mono Sample - - - - - ROM Right Sample - - - - - ROM Left Sample - - - - - ROM Linked Sample - - - - - SoundFont Version Structure - - - - - Major Version - - - - - Minor Version - - - - - Builds a SoundFont version - - - - - Reads a SoundFont Version structure - - - - - Writes a SoundFont Version structure - - - - - Gets the length of this structure - - - - - Represents a SoundFont - - - - - Loads a SoundFont from a file - - Filename of the SoundFont - - - - Loads a SoundFont from a stream - - stream - - - - The File Info Chunk - - - - - The Presets - - - - - The Instruments - - - - - The Sample Headers - - - - - The Sample Data - - - - - - - - - - base class for structures that can read themselves - - - - - A SoundFont zone - - - - - - - - - - Modulators for this Zone - - - - - Generators for this Zone - - - - - Audio Subtype GUIDs - http://msdn.microsoft.com/en-us/library/windows/desktop/aa372553%28v=vs.85%29.aspx - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - μ-law coding - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Adaptive delta pulse code modulation (ADPCM) - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Dolby Digital Plus formatted for HDMI output. - http://msdn.microsoft.com/en-us/library/windows/hardware/ff538392(v=vs.85).aspx - Reference : internet - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - IMFActivate, defined in mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Creates the object associated with this activation object. - - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - - - Provides a generic way to store key/value pairs on an object. - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms704598%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - IMFByteStream - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms698720%28v=vs.85%29.aspx - - - - - Retrieves the characteristics of the byte stream. - virtual HRESULT STDMETHODCALLTYPE GetCapabilities(/*[out]*/ __RPC__out DWORD *pdwCapabilities) = 0; - - - - - Retrieves the length of the stream. - virtual HRESULT STDMETHODCALLTYPE GetLength(/*[out]*/ __RPC__out QWORD *pqwLength) = 0; - - - - - Sets the length of the stream. - virtual HRESULT STDMETHODCALLTYPE SetLength(/*[in]*/ QWORD qwLength) = 0; - - - - - Retrieves the current read or write position in the stream. - virtual HRESULT STDMETHODCALLTYPE GetCurrentPosition(/*[out]*/ __RPC__out QWORD *pqwPosition) = 0; - - - - - Sets the current read or write position. - virtual HRESULT STDMETHODCALLTYPE SetCurrentPosition(/*[in]*/ QWORD qwPosition) = 0; - - - - - Queries whether the current position has reached the end of the stream. - virtual HRESULT STDMETHODCALLTYPE IsEndOfStream(/*[out]*/ __RPC__out BOOL *pfEndOfStream) = 0; - - - - - Reads data from the stream. - virtual HRESULT STDMETHODCALLTYPE Read(/*[size_is][out]*/ __RPC__out_ecount_full(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbRead) = 0; - - - - - Begins an asynchronous read operation from the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginRead(/*[out]*/ _Out_writes_bytes_(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous read operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndRead(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbRead) = 0; - - - - - Writes data to the stream. - virtual HRESULT STDMETHODCALLTYPE Write(/*[size_is][in]*/ __RPC__in_ecount_full(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbWritten) = 0; - - - - - Begins an asynchronous write operation to the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginWrite(/*[in]*/ _In_reads_bytes_(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous write operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndWrite(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbWritten) = 0; - - - - - Moves the current position in the stream by a specified offset. - virtual HRESULT STDMETHODCALLTYPE Seek(/*[in]*/ MFBYTESTREAM_SEEK_ORIGIN SeekOrigin, /*[in]*/ LONGLONG llSeekOffset, /*[in]*/ DWORD dwSeekFlags, /*[out]*/ __RPC__out QWORD *pqwCurrentPosition) = 0; - - - - - Clears any internal buffers used by the stream. - virtual HRESULT STDMETHODCALLTYPE Flush( void) = 0; - - - - - Closes the stream and releases any resources associated with the stream. - virtual HRESULT STDMETHODCALLTYPE Close( void) = 0; - - - - - Represents a generic collection of IUnknown pointers. - - - - - Retrieves the number of objects in the collection. - - - - - Retrieves an object in the collection. - - - - - Adds an object to the collection. - - - - - Removes an object from the collection. - - - - - Removes an object from the collection. - - - - - Removes all items from the collection. - - - - - IMFMediaBuffer - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms696261%28v=vs.85%29.aspx - - - - - Gives the caller access to the memory in the buffer. - - - - - Unlocks a buffer that was previously locked. - - - - - Retrieves the length of the valid data in the buffer. - - - - - Sets the length of the valid data in the buffer. - - - - - Retrieves the allocated size of the buffer. - - - - - IMFMediaEvent - Represents an event generated by a Media Foundation object. Use this interface to get information about the event. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms702249%28v=vs.85%29.aspx - Mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the event type. - - - virtual HRESULT STDMETHODCALLTYPE GetType( - /* [out] */ __RPC__out MediaEventType *pmet) = 0; - - - - - Retrieves the extended type of the event. - - - virtual HRESULT STDMETHODCALLTYPE GetExtendedType( - /* [out] */ __RPC__out GUID *pguidExtendedType) = 0; - - - - - Retrieves an HRESULT that specifies the event status. - - - virtual HRESULT STDMETHODCALLTYPE GetStatus( - /* [out] */ __RPC__out HRESULT *phrStatus) = 0; - - - - - Retrieves the value associated with the event, if any. - - - virtual HRESULT STDMETHODCALLTYPE GetValue( - /* [out] */ __RPC__out PROPVARIANT *pvValue) = 0; - - - - - Represents a description of a media format. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms704850%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the major type of the format. - - - - - Queries whether the media type is a compressed format. - - - - - Compares two media types and determines whether they are identical. - - - - - Retrieves an alternative representation of the media type. - - - - - Frees memory that was allocated by the GetRepresentation method. - - - - - Creates an instance of either the sink writer or the source reader. - - - - - Creates an instance of the sink writer or source reader, given a URL. - - - - - Creates an instance of the sink writer or source reader, given an IUnknown pointer. - - - - - CLSID_MFReadWriteClassFactory - - - - - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms702192%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves flags associated with the sample. - - - - - Sets flags associated with the sample. - - - - - Retrieves the presentation time of the sample. - - - - - Sets the presentation time of the sample. - - - - - Retrieves the duration of the sample. - - - - - Sets the duration of the sample. - - - - - Retrieves the number of buffers in the sample. - - - - - Retrieves a buffer from the sample. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - - - - Adds a buffer to the end of the list of buffers in the sample. - - - - - Removes a buffer at a specified index from the sample. - - - - - Removes all buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. - - - - - Copies the sample data to a buffer. - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Adds a stream to the sink writer. - - - - - Sets the input format for a stream on the sink writer. - - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - - - Indicates a gap in an input stream. - - - - - Places a marker in the specified stream. - - - - - Notifies the media sink that a stream has reached the end of a segment. - - - - - Flushes one or more streams. - - - - - (Finalize) Completes all writing operations on the sink writer. - - - - - Queries the underlying media sink or encoder for an interface. - - - - - Gets statistics about the performance of the sink writer. - - - - - IMFSourceReader interface - http://msdn.microsoft.com/en-us/library/windows/desktop/dd374655%28v=vs.85%29.aspx - - - - - Queries whether a stream is selected. - - - - - Selects or deselects one or more streams. - - - - - Gets a format that is supported natively by the media source. - - - - - Gets the current media type for a stream. - - - - - Sets the media type for a stream. - - - - - Seeks to a new position in the media source. - - - - - Reads the next sample from the media source. - - - - - Flushes one or more streams. - - - - - Queries the underlying media source or decoder for an interface. - - - - - Gets an attribute from the underlying media source. - - - - - Contains flags that indicate the status of the IMFSourceReader::ReadSample method - http://msdn.microsoft.com/en-us/library/windows/desktop/dd375773(v=vs.85).aspx - - - - - No Error - - - - - An error occurred. If you receive this flag, do not make any further calls to IMFSourceReader methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the IMFSourceReader::GetCurrentMediaType method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. - - - - - IMFTransform, defined in mftransform.h - - - - - Retrieves the minimum and maximum number of input and output streams. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamLimits( - /* [out] */ __RPC__out DWORD *pdwInputMinimum, - /* [out] */ __RPC__out DWORD *pdwInputMaximum, - /* [out] */ __RPC__out DWORD *pdwOutputMinimum, - /* [out] */ __RPC__out DWORD *pdwOutputMaximum) = 0; - - - - - Retrieves the current number of input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamCount( - /* [out] */ __RPC__out DWORD *pcInputStreams, - /* [out] */ __RPC__out DWORD *pcOutputStreams) = 0; - - - - - Retrieves the stream identifiers for the input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamIDs( - DWORD dwInputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwInputIDArraySize) DWORD *pdwInputIDs, - DWORD dwOutputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwOutputIDArraySize) DWORD *pdwOutputIDs) = 0; - - - - - Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamInfo( - DWORD dwInputStreamID, - /* [out] */ __RPC__out MFT_INPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamInfo( - DWORD dwOutputStreamID, - /* [out] */ __RPC__out MFT_OUTPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the global attribute store for this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetAttributes( - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an input stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamAttributes( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamAttributes( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Removes an input stream from this MFT. - - - virtual HRESULT STDMETHODCALLTYPE DeleteInputStream( - DWORD dwStreamID) = 0; - - - - - Adds one or more new input streams to this MFT. - - - virtual HRESULT STDMETHODCALLTYPE AddInputStreams( - DWORD cStreams, - /* [in] */ __RPC__in DWORD *adwStreamIDs) = 0; - - - - - Gets an available media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputAvailableType( - DWORD dwInputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Retrieves an available media type for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputAvailableType( - DWORD dwOutputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetInputType( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetOutputType( - DWORD dwOutputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Gets the current media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputCurrentType( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Gets the current media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputCurrentType( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStatus( - DWORD dwInputStreamID, - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Queries whether the Media Foundation transform (MFT) is ready to produce output data. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStatus( - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Sets the range of time stamps the client needs for output. - - - virtual HRESULT STDMETHODCALLTYPE SetOutputBounds( - LONGLONG hnsLowerBound, - LONGLONG hnsUpperBound) = 0; - - - - - Sends an event to an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessEvent( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaEvent *pEvent) = 0; - - - - - Sends a message to the Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessMessage( - MFT_MESSAGE_TYPE eMessage, - ULONG_PTR ulParam) = 0; - - - - - Delivers data to an input stream on this Media Foundation transform (MFT). - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessInput( - DWORD dwInputStreamID, - IMFSample *pSample, - DWORD dwFlags) = 0; - - - - - Generates output from the current input data. - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessOutput( - DWORD dwFlags, - DWORD cOutputBufferCount, - /* [size_is][out][in] */ MFT_OUTPUT_DATA_BUFFER *pOutputSamples, - /* [out] */ DWORD *pdwStatus) = 0; - - - - - See mfobjects.h - - - - - Unknown event type. - - - - - Signals a serious error. - - - - - Custom event type. - - - - - A non-fatal error occurred during streaming. - - - - - Session Unknown - - - - - Raised after the IMFMediaSession::SetTopology method completes asynchronously - - - - - Raised by the Media Session when the IMFMediaSession::ClearTopologies method completes asynchronously. - - - - - Raised when the IMFMediaSession::Start method completes asynchronously. - - - - - Raised when the IMFMediaSession::Pause method completes asynchronously. - - - - - Raised when the IMFMediaSession::Stop method completes asynchronously. - - - - - Raised when the IMFMediaSession::Close method completes asynchronously. - - - - - Raised by the Media Session when it has finished playing the last presentation in the playback queue. - - - - - Raised by the Media Session when the playback rate changes. - - - - - Raised by the Media Session when it completes a scrubbing request. - - - - - Raised by the Media Session when the session capabilities change. - - - - - Raised by the Media Session when the status of a topology changes. - - - - - Raised by the Media Session when a new presentation starts. - - - - - Raised by a media source a new presentation is ready. - - - - - License acquisition is about to begin. - - - - - License acquisition is complete. - - - - - Individualization is about to begin. - - - - - Individualization is complete. - - - - - Signals the progress of a content enabler object. - - - - - A content enabler object's action is complete. - - - - - Raised by a trusted output if an error occurs while enforcing the output policy. - - - - - Contains status information about the enforcement of an output policy. - - - - - A media source started to buffer data. - - - - - A media source stopped buffering data. - - - - - The network source started opening a URL. - - - - - The network source finished opening a URL. - - - - - Raised by a media source at the start of a reconnection attempt. - - - - - Raised by a media source at the end of a reconnection attempt. - - - - - Raised by the enhanced video renderer (EVR) when it receives a user event from the presenter. - - - - - Raised by the Media Session when the format changes on a media sink. - - - - - Source Unknown - - - - - Raised when a media source starts without seeking. - - - - - Raised by a media stream when the source starts without seeking. - - - - - Raised when a media source seeks to a new position. - - - - - Raised by a media stream after a call to IMFMediaSource::Start causes a seek in the stream. - - - - - Raised by a media source when it starts a new stream. - - - - - Raised by a media source when it restarts or seeks a stream that is already active. - - - - - Raised by a media source when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media source when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media source when a presentation ends. - - - - - Raised by a media stream when the stream ends. - - - - - Raised when a media stream delivers a new sample. - - - - - Signals that a media stream does not have data available at a specified time. - - - - - Raised by a media stream when it starts or stops thinning the stream. - - - - - Raised by a media stream when the media type of the stream changes. - - - - - Raised by a media source when the playback rate changes. - - - - - Raised by the sequencer source when a segment is completed and is followed by another segment. - - - - - Raised by a media source when the source's characteristics change. - - - - - Raised by a media source to request a new playback rate. - - - - - Raised by a media source when it updates its metadata. - - - - - Raised by the sequencer source when the IMFSequencerSource::UpdateTopology method completes asynchronously. - - - - - Sink Unknown - - - - - Raised by a stream sink when it completes the transition to the running state. - - - - - Raised by a stream sink when it completes the transition to the stopped state. - - - - - Raised by a stream sink when it completes the transition to the paused state. - - - - - Raised by a stream sink when the rate has changed. - - - - - Raised by a stream sink to request a new media sample from the pipeline. - - - - - Raised by a stream sink after the IMFStreamSink::PlaceMarker method is called. - - - - - Raised by a stream sink when the stream has received enough preroll data to begin rendering. - - - - - Raised by a stream sink when it completes a scrubbing request. - - - - - Raised by a stream sink when the sink's media type is no longer valid. - - - - - Raised by the stream sinks of the EVR if the video device changes. - - - - - Provides feedback about playback quality to the quality manager. - - - - - Raised when a media sink becomes invalid. - - - - - The audio session display name changed. - - - - - The volume or mute state of the audio session changed - - - - - The audio device was removed. - - - - - The Windows audio server system was shut down. - - - - - The grouping parameters changed for the audio session. - - - - - The audio session icon changed. - - - - - The default audio format for the audio device changed. - - - - - The audio session was disconnected from a Windows Terminal Services session - - - - - The audio session was preempted by an exclusive-mode connection. - - - - - Trust Unknown - - - - - The output policy for a stream changed. - - - - - Content protection message - - - - - The IMFOutputTrustAuthority::SetPolicy method completed. - - - - - DRM License Backup Completed - - - - - DRM License Backup Progress - - - - - DRM License Restore Completed - - - - - DRM License Restore Progress - - - - - DRM License Acquisition Completed - - - - - DRM Individualization Completed - - - - - DRM Individualization Progress - - - - - DRM Proximity Completed - - - - - DRM License Store Cleaned - - - - - DRM Revocation Download Completed - - - - - Transform Unknown - - - - - Sent by an asynchronous MFT to request a new input sample. - - - - - Sent by an asynchronous MFT when new output data is available from the MFT. - - - - - Sent by an asynchronous Media Foundation transform (MFT) when a drain operation is complete. - - - - - Sent by an asynchronous MFT in response to an MFT_MESSAGE_COMMAND_MARKER message. - - - - - Media Foundation attribute guids - http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - Specifies whether an MFT performs asynchronous processing. - - - - - Enables the use of an asynchronous MFT. - - - - - Contains flags for an MFT activation object. - - - - - Specifies the category for an MFT. - - - - - Contains the class identifier (CLSID) of an MFT. - - - - - Contains the registered input types for a Media Foundation transform (MFT). - - - - - Contains the registered output types for a Media Foundation transform (MFT). - - - - - Contains the symbolic link for a hardware-based MFT. - - - - - Contains the display name for a hardware-based MFT. - - - - - Contains a pointer to the stream attributes of the connected stream on a hardware-based MFT. - - - - - Specifies whether a hardware-based MFT is connected to another hardware-based MFT. - - - - - Specifies the preferred output format for an encoder. - - - - - Specifies whether an MFT is registered only in the application's process. - - - - - Contains configuration properties for an encoder. - - - - - Specifies whether a hardware device source uses the system time for time stamps. - - - - - Contains an IMFFieldOfUseMFTUnlock pointer, which can be used to unlock the MFT. - - - - - Contains the merit value of a hardware codec. - - - - - Specifies whether a decoder is optimized for transcoding rather than for playback. - - - - - Contains a pointer to the proxy object for the application's presentation descriptor. - - - - - Contains a pointer to the presentation descriptor from the protected media path (PMP). - - - - - Specifies the duration of a presentation, in 100-nanosecond units. - - - - - Specifies the total size of the source file, in bytes. - - - - - Specifies the audio encoding bit rate for the presentation, in bits per second. - - - - - Specifies the video encoding bit rate for the presentation, in bits per second. - - - - - Specifies the MIME type of the content. - - - - - Specifies when a presentation was last modified. - - - - - The identifier of the playlist element in the presentation. - - - - - Contains the preferred RFC 1766 language of the media source. - - - - - The time at which the presentation must begin, relative to the start of the media source. - - - - - Specifies whether the audio streams in the presentation have a variable bit rate. - - - - - Media type Major Type - - - - - Media Type subtype - - - - - Audio block alignment - - - - - Audio average bytes per second - - - - - Audio number of channels - - - - - Audio samples per second - - - - - Audio bits per sample - - - - - Enables the source reader or sink writer to use hardware-based Media Foundation transforms (MFTs). - - - - - Contains additional format data for a media type. - - - - - Specifies for a media type whether each sample is independent of the other samples in the stream. - - - - - Specifies for a media type whether the samples have a fixed size. - - - - - Contains a DirectShow format GUID for a media type. - - - - - Specifies the preferred legacy format structure to use when converting an audio media type. - - - - - Specifies for a media type whether the media data is compressed. - - - - - Approximate data rate of the video stream, in bits per second, for a video media type. - - - - - Specifies the payload type of an Advanced Audio Coding (AAC) stream. - 0 - The stream contains raw_data_block elements only - 1 - Audio Data Transport Stream (ADTS). The stream contains an adts_sequence, as defined by MPEG-2. - 2 - Audio Data Interchange Format (ADIF). The stream contains an adif_sequence, as defined by MPEG-2. - 3 - The stream contains an MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream, as defined by ISO/IEC 14496-3. - - - - - Media Foundation Errors - - - - RANGES - 14000 - 14999 = General Media Foundation errors - 15000 - 15999 = ASF parsing errors - 16000 - 16999 = Media Source errors - 17000 - 17999 = MEDIAFOUNDATION Network Error Events - 18000 - 18999 = MEDIAFOUNDATION WMContainer Error Events - 19000 - 19999 = MEDIAFOUNDATION Media Sink Error Events - 20000 - 20999 = Renderer errors - 21000 - 21999 = Topology Errors - 25000 - 25999 = Timeline Errors - 26000 - 26999 = Unused - 28000 - 28999 = Transform errors - 29000 - 29999 = Content Protection errors - 40000 - 40999 = Clock errors - 41000 - 41999 = MF Quality Management Errors - 42000 - 42999 = MF Transcode API Errors - - - - - MessageId: MF_E_PLATFORM_NOT_INITIALIZED - - MessageText: - - Platform not initialized. Please call MFStartup().%0 - - - - - MessageId: MF_E_BUFFERTOOSMALL - - MessageText: - - The buffer was too small to carry out the requested action.%0 - - - - - MessageId: MF_E_INVALIDREQUEST - - MessageText: - - The request is invalid in the current state.%0 - - - - - MessageId: MF_E_INVALIDSTREAMNUMBER - - MessageText: - - The stream number provided was invalid.%0 - - - - - MessageId: MF_E_INVALIDMEDIATYPE - - MessageText: - - The data specified for the media type is invalid, inconsistent, or not supported by this object.%0 - - - - - MessageId: MF_E_NOTACCEPTING - - MessageText: - - The callee is currently not accepting further input.%0 - - - - - MessageId: MF_E_NOT_INITIALIZED - - MessageText: - - This object needs to be initialized before the requested operation can be carried out.%0 - - - - - MessageId: MF_E_UNSUPPORTED_REPRESENTATION - - MessageText: - - The requested representation is not supported by this object.%0 - - - - - MessageId: MF_E_NO_MORE_TYPES - - MessageText: - - An object ran out of media types to suggest therefore the requested chain of streaming objects cannot be completed.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SERVICE - - MessageText: - - The object does not support the specified service.%0 - - - - - MessageId: MF_E_UNEXPECTED - - MessageText: - - An unexpected error has occurred in the operation requested.%0 - - - - - MessageId: MF_E_INVALIDNAME - - MessageText: - - Invalid name.%0 - - - - - MessageId: MF_E_INVALIDTYPE - - MessageText: - - Invalid type.%0 - - - - - MessageId: MF_E_INVALID_FILE_FORMAT - - MessageText: - - The file does not conform to the relevant file format specification. - - - - - MessageId: MF_E_INVALIDINDEX - - MessageText: - - Invalid index.%0 - - - - - MessageId: MF_E_INVALID_TIMESTAMP - - MessageText: - - An invalid timestamp was given.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SCHEME - - MessageText: - - The scheme of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_BYTESTREAM_TYPE - - MessageText: - - The byte stream type of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_TIME_FORMAT - - MessageText: - - The given time format is unsupported.%0 - - - - - MessageId: MF_E_NO_SAMPLE_TIMESTAMP - - MessageText: - - The Media Sample does not have a timestamp.%0 - - - - - MessageId: MF_E_NO_SAMPLE_DURATION - - MessageText: - - The Media Sample does not have a duration.%0 - - - - - MessageId: MF_E_INVALID_STREAM_DATA - - MessageText: - - The request failed because the data in the stream is corrupt.%0\n. - - - - - MessageId: MF_E_RT_UNAVAILABLE - - MessageText: - - Real time services are not available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE - - MessageText: - - The specified rate is not supported.%0 - - - - - MessageId: MF_E_THINNING_UNSUPPORTED - - MessageText: - - This component does not support stream-thinning.%0 - - - - - MessageId: MF_E_REVERSE_UNSUPPORTED - - MessageText: - - The call failed because no reverse playback rates are available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE_TRANSITION - - MessageText: - - The requested rate transition cannot occur in the current state.%0 - - - - - MessageId: MF_E_RATE_CHANGE_PREEMPTED - - MessageText: - - The requested rate change has been pre-empted and will not occur.%0 - - - - - MessageId: MF_E_NOT_FOUND - - MessageText: - - The specified object or value does not exist.%0 - - - - - MessageId: MF_E_NOT_AVAILABLE - - MessageText: - - The requested value is not available.%0 - - - - - MessageId: MF_E_NO_CLOCK - - MessageText: - - The specified operation requires a clock and no clock is available.%0 - - - - - MessageId: MF_S_MULTIPLE_BEGIN - - MessageText: - - This callback and state had already been passed in to this event generator earlier.%0 - - - - - MessageId: MF_E_MULTIPLE_BEGIN - - MessageText: - - This callback has already been passed in to this event generator.%0 - - - - - MessageId: MF_E_MULTIPLE_SUBSCRIBERS - - MessageText: - - Some component is already listening to events on this event generator.%0 - - - - - MessageId: MF_E_TIMER_ORPHANED - - MessageText: - - This timer was orphaned before its callback time arrived.%0 - - - - - MessageId: MF_E_STATE_TRANSITION_PENDING - - MessageText: - - A state transition is already pending.%0 - - - - - MessageId: MF_E_UNSUPPORTED_STATE_TRANSITION - - MessageText: - - The requested state transition is unsupported.%0 - - - - - MessageId: MF_E_UNRECOVERABLE_ERROR_OCCURRED - - MessageText: - - An unrecoverable error has occurred.%0 - - - - - MessageId: MF_E_SAMPLE_HAS_TOO_MANY_BUFFERS - - MessageText: - - The provided sample has too many buffers.%0 - - - - - MessageId: MF_E_SAMPLE_NOT_WRITABLE - - MessageText: - - The provided sample is not writable.%0 - - - - - MessageId: MF_E_INVALID_KEY - - MessageText: - - The specified key is not valid. - - - - - MessageId: MF_E_BAD_STARTUP_VERSION - - MessageText: - - You are calling MFStartup with the wrong MF_VERSION. Mismatched bits? - - - - - MessageId: MF_E_UNSUPPORTED_CAPTION - - MessageText: - - The caption of the given URL is unsupported.%0 - - - - - MessageId: MF_E_INVALID_POSITION - - MessageText: - - The operation on the current offset is not permitted.%0 - - - - - MessageId: MF_E_ATTRIBUTENOTFOUND - - MessageText: - - The requested attribute was not found.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_ALLOWED - - MessageText: - - The specified property type is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_SUPPORTED - - MessageText: - - The specified property type is not supported.%0 - - - - - MessageId: MF_E_PROPERTY_EMPTY - - MessageText: - - The specified property is empty.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_EMPTY - - MessageText: - - The specified property is not empty.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_NOT_ALLOWED - - MessageText: - - The vector property specified is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_REQUIRED - - MessageText: - - A vector property is required in this context.%0 - - - - - MessageId: MF_E_OPERATION_CANCELLED - - MessageText: - - The operation is cancelled.%0 - - - - - MessageId: MF_E_BYTESTREAM_NOT_SEEKABLE - - MessageText: - - The provided bytestream was expected to be seekable and it is not.%0 - - - - - MessageId: MF_E_DISABLED_IN_SAFEMODE - - MessageText: - - The Media Foundation platform is disabled when the system is running in Safe Mode.%0 - - - - - MessageId: MF_E_CANNOT_PARSE_BYTESTREAM - - MessageText: - - The Media Source could not parse the byte stream.%0 - - - - - MessageId: MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS - - MessageText: - - Mutually exclusive flags have been specified to source resolver. This flag combination is invalid.%0 - - - - - MessageId: MF_E_MEDIAPROC_WRONGSTATE - - MessageText: - - MediaProc is in the wrong state%0 - - - - - MessageId: MF_E_RT_THROUGHPUT_NOT_AVAILABLE - - MessageText: - - Real time I/O service can not provide requested throughput.%0 - - - - - MessageId: MF_E_RT_TOO_MANY_CLASSES - - MessageText: - - The workqueue cannot be registered with more classes.%0 - - - - - MessageId: MF_E_RT_WOULDBLOCK - - MessageText: - - This operation cannot succeed because another thread owns this object.%0 - - - - - MessageId: MF_E_NO_BITPUMP - - MessageText: - - Internal. Bitpump not found.%0 - - - - - MessageId: MF_E_RT_OUTOFMEMORY - - MessageText: - - No more RT memory available.%0 - - - - - MessageId: MF_E_RT_WORKQUEUE_CLASS_NOT_SPECIFIED - - MessageText: - - An MMCSS class has not been set for this work queue.%0 - - - - - MessageId: MF_E_INSUFFICIENT_BUFFER - - MessageText: - - Insufficient memory for response.%0 - - - - - MessageId: MF_E_CANNOT_CREATE_SINK - - MessageText: - - Activate failed to create mediasink. Call OutputNode::GetUINT32(MF_TOPONODE_MAJORTYPE) for more information. %0 - - - - - MessageId: MF_E_BYTESTREAM_UNKNOWN_LENGTH - - MessageText: - - The length of the provided bytestream is unknown.%0 - - - - - MessageId: MF_E_SESSION_PAUSEWHILESTOPPED - - MessageText: - - The media session cannot pause from a stopped state.%0 - - - - - MessageId: MF_S_ACTIVATE_REPLACED - - MessageText: - - The activate could not be created in the remote process for some reason it was replaced with empty one.%0 - - - - - MessageId: MF_E_FORMAT_CHANGE_NOT_SUPPORTED - - MessageText: - - The data specified for the media type is supported, but would require a format change, which is not supported by this object.%0 - - - - - MessageId: MF_E_INVALID_WORKQUEUE - - MessageText: - - The operation failed because an invalid combination of workqueue ID and flags was specified.%0 - - - - - MessageId: MF_E_DRM_UNSUPPORTED - - MessageText: - - No DRM support is available.%0 - - - - - MessageId: MF_E_UNAUTHORIZED - - MessageText: - - This operation is not authorized.%0 - - - - - MessageId: MF_E_OUT_OF_RANGE - - MessageText: - - The value is not in the specified or valid range.%0 - - - - - MessageId: MF_E_INVALID_CODEC_MERIT - - MessageText: - - The registered codec merit is not valid.%0 - - - - - MessageId: MF_E_HW_MFT_FAILED_START_STREAMING - - MessageText: - - Hardware MFT failed to start streaming due to lack of hardware resources.%0 - - - - - MessageId: MF_S_ASF_PARSEINPROGRESS - - MessageText: - - Parsing is still in progress and is not yet complete.%0 - - - - - MessageId: MF_E_ASF_PARSINGINCOMPLETE - - MessageText: - - Not enough data have been parsed to carry out the requested action.%0 - - - - - MessageId: MF_E_ASF_MISSINGDATA - - MessageText: - - There is a gap in the ASF data provided.%0 - - - - - MessageId: MF_E_ASF_INVALIDDATA - - MessageText: - - The data provided are not valid ASF.%0 - - - - - MessageId: MF_E_ASF_OPAQUEPACKET - - MessageText: - - The packet is opaque, so the requested information cannot be returned.%0 - - - - - MessageId: MF_E_ASF_NOINDEX - - MessageText: - - The requested operation failed since there is no appropriate ASF index.%0 - - - - - MessageId: MF_E_ASF_OUTOFRANGE - - MessageText: - - The value supplied is out of range for this operation.%0 - - - - - MessageId: MF_E_ASF_INDEXNOTLOADED - - MessageText: - - The index entry requested needs to be loaded before it can be available.%0 - - - - - MessageId: MF_E_ASF_TOO_MANY_PAYLOADS - - MessageText: - - The packet has reached the maximum number of payloads.%0 - - - - - MessageId: MF_E_ASF_UNSUPPORTED_STREAM_TYPE - - MessageText: - - Stream type is not supported.%0 - - - - - MessageId: MF_E_ASF_DROPPED_PACKET - - MessageText: - - One or more ASF packets were dropped.%0 - - - - - MessageId: MF_E_NO_EVENTS_AVAILABLE - - MessageText: - - There are no events available in the queue.%0 - - - - - MessageId: MF_E_INVALID_STATE_TRANSITION - - MessageText: - - A media source cannot go from the stopped state to the paused state.%0 - - - - - MessageId: MF_E_END_OF_STREAM - - MessageText: - - The media stream cannot process any more samples because there are no more samples in the stream.%0 - - - - - MessageId: MF_E_SHUTDOWN - - MessageText: - - The request is invalid because Shutdown() has been called.%0 - - - - - MessageId: MF_E_MP3_NOTFOUND - - MessageText: - - The MP3 object was not found.%0 - - - - - MessageId: MF_E_MP3_OUTOFDATA - - MessageText: - - The MP3 parser ran out of data before finding the MP3 object.%0 - - - - - MessageId: MF_E_MP3_NOTMP3 - - MessageText: - - The file is not really a MP3 file.%0 - - - - - MessageId: MF_E_MP3_NOTSUPPORTED - - MessageText: - - The MP3 file is not supported.%0 - - - - - MessageId: MF_E_NO_DURATION - - MessageText: - - The Media stream has no duration.%0 - - - - - MessageId: MF_E_INVALID_FORMAT - - MessageText: - - The Media format is recognized but is invalid.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_FOUND - - MessageText: - - The property requested was not found.%0 - - - - - MessageId: MF_E_PROPERTY_READ_ONLY - - MessageText: - - The property is read only.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_ALLOWED - - MessageText: - - The specified property is not allowed in this context.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NOT_STARTED - - MessageText: - - The media source is not started.%0 - - - - - MessageId: MF_E_UNSUPPORTED_FORMAT - - MessageText: - - The Media format is recognized but not supported.%0 - - - - - MessageId: MF_E_MP3_BAD_CRC - - MessageText: - - The MPEG frame has bad CRC.%0 - - - - - MessageId: MF_E_NOT_PROTECTED - - MessageText: - - The file is not protected.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_WRONGSTATE - - MessageText: - - The media source is in the wrong state%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED - - MessageText: - - No streams are selected in source presentation descriptor.%0 - - - - - MessageId: MF_E_CANNOT_FIND_KEYFRAME_SAMPLE - - MessageText: - - No key frame sample was found.%0 - - - - - MessageId: MF_E_NETWORK_RESOURCE_FAILURE - - MessageText: - - An attempt to acquire a network resource failed.%0 - - - - - MessageId: MF_E_NET_WRITE - - MessageText: - - Error writing to the network.%0 - - - - - MessageId: MF_E_NET_READ - - MessageText: - - Error reading from the network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_NETWORK - - MessageText: - - Internal. Entry cannot complete operation without network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_ASYNC - - MessageText: - - Internal. Async op is required.%0 - - - - - MessageId: MF_E_NET_BWLEVEL_NOT_SUPPORTED - - MessageText: - - Internal. Bandwidth levels are not supported.%0 - - - - - MessageId: MF_E_NET_STREAMGROUPS_NOT_SUPPORTED - - MessageText: - - Internal. Stream groups are not supported.%0 - - - - - MessageId: MF_E_NET_MANUALSS_NOT_SUPPORTED - - MessageText: - - Manual stream selection is not supported.%0 - - - - - MessageId: MF_E_NET_INVALID_PRESENTATION_DESCRIPTOR - - MessageText: - - Invalid presentation descriptor.%0 - - - - - MessageId: MF_E_NET_CACHESTREAM_NOT_FOUND - - MessageText: - - Cannot find cache stream.%0 - - - - - MessageId: MF_I_MANUAL_PROXY - - MessageText: - - The proxy setting is manual.%0 - - - - duplicate removed - MessageId=17011 Severity=Informational Facility=MEDIAFOUNDATION SymbolicName=MF_E_INVALID_REQUEST - Language=English - The request is invalid in the current state.%0 - . - - MessageId: MF_E_NET_REQUIRE_INPUT - - MessageText: - - Internal. Entry cannot complete operation without input.%0 - - - - - MessageId: MF_E_NET_REDIRECT - - MessageText: - - The client redirected to another server.%0 - - - - - MessageId: MF_E_NET_REDIRECT_TO_PROXY - - MessageText: - - The client is redirected to a proxy server.%0 - - - - - MessageId: MF_E_NET_TOO_MANY_REDIRECTS - - MessageText: - - The client reached maximum redirection limit.%0 - - - - - MessageId: MF_E_NET_TIMEOUT - - MessageText: - - The server, a computer set up to offer multimedia content to other computers, could not handle your request for multimedia content in a timely manner. Please try again later.%0 - - - - - MessageId: MF_E_NET_CLIENT_CLOSE - - MessageText: - - The control socket is closed by the client.%0 - - - - - MessageId: MF_E_NET_BAD_CONTROL_DATA - - MessageText: - - The server received invalid data from the client on the control connection.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_SERVER - - MessageText: - - The server is not a compatible streaming media server.%0 - - - - - MessageId: MF_E_NET_UNSAFE_URL - - MessageText: - - Url.%0 - - - - - MessageId: MF_E_NET_CACHE_NO_DATA - - MessageText: - - Data is not available.%0 - - - - - MessageId: MF_E_NET_EOL - - MessageText: - - End of line.%0 - - - - - MessageId: MF_E_NET_BAD_REQUEST - - MessageText: - - The request could not be understood by the server.%0 - - - - - MessageId: MF_E_NET_INTERNAL_SERVER_ERROR - - MessageText: - - The server encountered an unexpected condition which prevented it from fulfilling the request.%0 - - - - - MessageId: MF_E_NET_SESSION_NOT_FOUND - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_NET_NOCONNECTION - - MessageText: - - There is no connection established with the Windows Media server. The operation failed.%0 - - - - - MessageId: MF_E_NET_CONNECTION_FAILURE - - MessageText: - - The network connection has failed.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_PUSHSERVER - - MessageText: - - The Server service that received the HTTP push request is not a compatible version of Windows Media Services (WMS). This error may indicate the push request was received by IIS instead of WMS. Ensure WMS is started and has the HTTP Server control protocol properly enabled and try again.%0 - - - - - MessageId: MF_E_NET_SERVER_ACCESSDENIED - - MessageText: - - The Windows Media server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_PROXY_ACCESSDENIED - - MessageText: - - The proxy server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_CANNOTCONNECT - - MessageText: - - Unable to establish a connection to the server.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_TEMPLATE - - MessageText: - - The specified push template is invalid.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_PUBLISHING_POINT - - MessageText: - - The specified push publishing point is invalid.%0 - - - - - MessageId: MF_E_NET_BUSY - - MessageText: - - The requested resource is in use.%0 - - - - - MessageId: MF_E_NET_RESOURCE_GONE - - MessageText: - - The Publishing Point or file on the Windows Media Server is no longer available.%0 - - - - - MessageId: MF_E_NET_ERROR_FROM_PROXY - - MessageText: - - The proxy experienced an error while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_PROXY_TIMEOUT - - MessageText: - - The proxy did not receive a timely response while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_SERVER_UNAVAILABLE - - MessageText: - - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.%0 - - - - - MessageId: MF_E_NET_TOO_MUCH_DATA - - MessageText: - - The encoding process was unable to keep up with the amount of supplied data.%0 - - - - - MessageId: MF_E_NET_SESSION_INVALID - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_OFFLINE_MODE - - MessageText: - - The requested URL is not available in offline mode.%0 - - - - - MessageId: MF_E_NET_UDP_BLOCKED - - MessageText: - - A device in the network is blocking UDP traffic.%0 - - - - - MessageId: MF_E_NET_UNSUPPORTED_CONFIGURATION - - MessageText: - - The specified configuration value is not supported.%0 - - - - - MessageId: MF_E_NET_PROTOCOL_DISABLED - - MessageText: - - The networking protocol is disabled.%0 - - - - - MessageId: MF_E_ALREADY_INITIALIZED - - MessageText: - - This object has already been initialized and cannot be re-initialized at this time.%0 - - - - - MessageId: MF_E_BANDWIDTH_OVERRUN - - MessageText: - - The amount of data passed in exceeds the given bitrate and buffer window.%0 - - - - - MessageId: MF_E_LATE_SAMPLE - - MessageText: - - The sample was passed in too late to be correctly processed.%0 - - - - - MessageId: MF_E_FLUSH_NEEDED - - MessageText: - - The requested action cannot be carried out until the object is flushed and the queue is emptied.%0 - - - - - MessageId: MF_E_INVALID_PROFILE - - MessageText: - - The profile is invalid.%0 - - - - - MessageId: MF_E_INDEX_NOT_COMMITTED - - MessageText: - - The index that is being generated needs to be committed before the requested action can be carried out.%0 - - - - - MessageId: MF_E_NO_INDEX - - MessageText: - - The index that is necessary for the requested action is not found.%0 - - - - - MessageId: MF_E_CANNOT_INDEX_IN_PLACE - - MessageText: - - The requested index cannot be added in-place to the specified ASF content.%0 - - - - - MessageId: MF_E_MISSING_ASF_LEAKYBUCKET - - MessageText: - - The ASF leaky bucket parameters must be specified in order to carry out this request.%0 - - - - - MessageId: MF_E_INVALID_ASF_STREAMID - - MessageText: - - The stream id is invalid. The valid range for ASF stream id is from 1 to 127.%0 - - - - - MessageId: MF_E_STREAMSINK_REMOVED - - MessageText: - - The requested Stream Sink has been removed and cannot be used.%0 - - - - - MessageId: MF_E_STREAMSINKS_OUT_OF_SYNC - - MessageText: - - The various Stream Sinks in this Media Sink are too far out of sync for the requested action to take place.%0 - - - - - MessageId: MF_E_STREAMSINKS_FIXED - - MessageText: - - Stream Sinks cannot be added to or removed from this Media Sink because its set of streams is fixed.%0 - - - - - MessageId: MF_E_STREAMSINK_EXISTS - - MessageText: - - The given Stream Sink already exists.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_CANCELED - - MessageText: - - Sample allocations have been canceled.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_EMPTY - - MessageText: - - The sample allocator is currently empty, due to outstanding requests.%0 - - - - - MessageId: MF_E_SINK_ALREADYSTOPPED - - MessageText: - - When we try to sopt a stream sink, it is already stopped %0 - - - - - MessageId: MF_E_ASF_FILESINK_BITRATE_UNKNOWN - - MessageText: - - The ASF file sink could not reserve AVIO because the bitrate is unknown.%0 - - - - - MessageId: MF_E_SINK_NO_STREAMS - - MessageText: - - No streams are selected in sink presentation descriptor.%0 - - - - - MessageId: MF_S_SINK_NOT_FINALIZED - - MessageText: - - The sink has not been finalized before shut down. This may cause sink generate a corrupted content.%0 - - - - - MessageId: MF_E_METADATA_TOO_LONG - - MessageText: - - A metadata item was too long to write to the output container.%0 - - - - - MessageId: MF_E_SINK_NO_SAMPLES_PROCESSED - - MessageText: - - The operation failed because no samples were processed by the sink.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_PROCAMP_HW - - MessageText: - - There is no available procamp hardware with which to perform color correction.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_DEINTERLACE_HW - - MessageText: - - There is no available deinterlacing hardware with which to deinterlace the video stream.%0 - - - - - MessageId: MF_E_VIDEO_REN_COPYPROT_FAILED - - MessageText: - - A video stream requires copy protection to be enabled, but there was a failure in attempting to enable copy protection.%0 - - - - - MessageId: MF_E_VIDEO_REN_SURFACE_NOT_SHARED - - MessageText: - - A component is attempting to access a surface for sharing that is not shared.%0 - - - - - MessageId: MF_E_VIDEO_DEVICE_LOCKED - - MessageText: - - A component is attempting to access a shared device that is already locked by another component.%0 - - - - - MessageId: MF_E_NEW_VIDEO_DEVICE - - MessageText: - - The device is no longer available. The handle should be closed and a new one opened.%0 - - - - - MessageId: MF_E_NO_VIDEO_SAMPLE_AVAILABLE - - MessageText: - - A video sample is not currently queued on a stream that is required for mixing.%0 - - - - - MessageId: MF_E_NO_AUDIO_PLAYBACK_DEVICE - - MessageText: - - No audio playback device was found.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_IN_USE - - MessageText: - - The requested audio playback device is currently in use.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_INVALIDATED - - MessageText: - - The audio playback device is no longer present.%0 - - - - - MessageId: MF_E_AUDIO_SERVICE_NOT_RUNNING - - MessageText: - - The audio service is not running.%0 - - - - - MessageId: MF_E_TOPO_INVALID_OPTIONAL_NODE - - MessageText: - - The topology contains an invalid optional node. Possible reasons are incorrect number of outputs and inputs or optional node is at the beginning or end of a segment. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_FIND_DECRYPTOR - - MessageText: - - No suitable transform was found to decrypt the content. %0 - - - - - MessageId: MF_E_TOPO_CODEC_NOT_FOUND - - MessageText: - - No suitable transform was found to encode or decode the content. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_CONNECT - - MessageText: - - Unable to find a way to connect nodes%0 - - - - - MessageId: MF_E_TOPO_UNSUPPORTED - - MessageText: - - Unsupported operations in topoloader%0 - - - - - MessageId: MF_E_TOPO_INVALID_TIME_ATTRIBUTES - - MessageText: - - The topology or its nodes contain incorrectly set time attributes%0 - - - - - MessageId: MF_E_TOPO_LOOPS_IN_TOPOLOGY - - MessageText: - - The topology contains loops, which are unsupported in media foundation topologies%0 - - - - - MessageId: MF_E_TOPO_MISSING_PRESENTATION_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_STREAM_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a stream descriptor%0 - - - - - MessageId: MF_E_TOPO_STREAM_DESCRIPTOR_NOT_SELECTED - - MessageText: - - A stream descriptor was set on a source stream node but it was not selected on the presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_SOURCE - - MessageText: - - A source stream node in the topology does not have a source%0 - - - - - MessageId: MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED - - MessageText: - - The topology loader does not support sink activates on output nodes.%0 - - - - - MessageId: MF_E_SEQUENCER_UNKNOWN_SEGMENT_ID - - MessageText: - - The sequencer cannot find a segment with the given ID.%0\n. - - - - - MessageId: MF_S_SEQUENCER_CONTEXT_CANCELED - - MessageText: - - The context was canceled.%0\n. - - - - - MessageId: MF_E_NO_SOURCE_IN_CACHE - - MessageText: - - Cannot find source in source cache.%0\n. - - - - - MessageId: MF_S_SEQUENCER_SEGMENT_AT_END_OF_STREAM - - MessageText: - - Cannot update topology flags.%0\n. - - - - - MessageId: MF_E_TRANSFORM_TYPE_NOT_SET - - MessageText: - - A valid type has not been set for this stream or a stream that it depends on.%0 - - - - - MessageId: MF_E_TRANSFORM_STREAM_CHANGE - - MessageText: - - A stream change has occurred. Output cannot be produced until the streams have been renegotiated.%0 - - - - - MessageId: MF_E_TRANSFORM_INPUT_REMAINING - - MessageText: - - The transform cannot take the requested action until all of the input data it currently holds is processed or flushed.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_MISSING - - MessageText: - - The transform requires a profile but no profile was supplied or found.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_INVALID_OR_CORRUPT - - MessageText: - - The transform requires a profile but the supplied profile was invalid or corrupt.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_TRUNCATED - - MessageText: - - The transform requires a profile but the supplied profile ended unexpectedly while parsing.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_PID_NOT_RECOGNIZED - - MessageText: - - The property ID does not match any property supported by the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VARIANT_TYPE_WRONG - - MessageText: - - The variant does not have the type expected for this property ID.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_NOT_WRITEABLE - - MessageText: - - An attempt was made to set the value on a read-only property.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_ARRAY_VALUE_WRONG_NUM_DIM - - MessageText: - - The array property value has an unexpected number of dimensions.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_SIZE_WRONG - - MessageText: - - The array or blob property value has an unexpected size.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_OUT_OF_RANGE - - MessageText: - - The property value is out of range for this transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_INCOMPATIBLE - - MessageText: - - The property value is incompatible with some other property or mediatype set on the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_OUTPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set output mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_INPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set input mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_MEDIATYPE_COMBINATION - - MessageText: - - The requested operation is not supported for the currently set combination of mediatypes.%0 - - - - - MessageId: MF_E_TRANSFORM_CONFLICTS_WITH_OTHER_CURRENTLY_ENABLED_FEATURES - - MessageText: - - The requested feature is not supported in combination with some other currently enabled feature.%0 - - - - - MessageId: MF_E_TRANSFORM_NEED_MORE_INPUT - - MessageText: - - The transform cannot produce output until it gets more input samples.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_SPKR_CONFIG - - MessageText: - - The requested operation is not supported for the current speaker configuration.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING - - MessageText: - - The transform cannot accept mediatype changes in the middle of processing.%0 - - - - - MessageId: MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT - - MessageText: - - The caller should not propagate this event to downstream components.%0 - - - - - MessageId: MF_E_UNSUPPORTED_D3D_TYPE - - MessageText: - - The input type is not supported for D3D device.%0 - - - - - MessageId: MF_E_TRANSFORM_ASYNC_LOCKED - - MessageText: - - The caller does not appear to support this transform's asynchronous capabilities.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_INITIALIZE_ACM_DRIVER - - MessageText: - - An audio compression manager driver could not be initialized by the transform.%0 - - - - - MessageId: MF_E_LICENSE_INCORRECT_RIGHTS - - MessageText: - - You are not allowed to open this file. Contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_OUTOFDATE - - MessageText: - - The license for this media file has expired. Get a new license or contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_REQUIRED - - MessageText: - - You need a license to perform the requested operation on this media file.%0 - - - - - MessageId: MF_E_DRM_HARDWARE_INCONSISTENT - - MessageText: - - The licenses for your media files are corrupted. Contact Microsoft product support.%0 - - - - - MessageId: MF_E_NO_CONTENT_PROTECTION_MANAGER - - MessageText: - - The APP needs to provide IMFContentProtectionManager callback to access the protected media file.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NO_RIGHTS - - MessageText: - - Client does not have rights to restore licenses.%0 - - - - - MessageId: MF_E_BACKUP_RESTRICTED_LICENSE - - MessageText: - - Licenses are restricted and hence can not be backed up.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NEEDS_INDIVIDUALIZATION - - MessageText: - - License restore requires machine to be individualized.%0 - - - - - MessageId: MF_S_PROTECTION_NOT_REQUIRED - - MessageText: - - Protection for stream is not required.%0 - - - - - MessageId: MF_E_COMPONENT_REVOKED - - MessageText: - - Component is revoked.%0 - - - - - MessageId: MF_E_TRUST_DISABLED - - MessageText: - - Trusted functionality is currently disabled on this component.%0 - - - - - MessageId: MF_E_WMDRMOTA_NO_ACTION - - MessageText: - - No Action is set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_ALREADY_SET - - MessageText: - - Action is already set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_HEADER_NOT_AVAILABLE - - MessageText: - - DRM Heaader is not available.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_ENCRYPTION_SCHEME_NOT_SUPPORTED - - MessageText: - - Current encryption scheme is not supported.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_MISMATCH - - MessageText: - - Action does not match with current configuration.%0 - - - - - MessageId: MF_E_WMDRMOTA_INVALID_POLICY - - MessageText: - - Invalid policy for WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_POLICY_UNSUPPORTED - - MessageText: - - The policies that the Input Trust Authority requires to be enforced are unsupported by the outputs.%0 - - - - - MessageId: MF_E_OPL_NOT_SUPPORTED - - MessageText: - - The OPL that the license requires to be enforced are not supported by the Input Trust Authority.%0 - - - - - MessageId: MF_E_TOPOLOGY_VERIFICATION_FAILED - - MessageText: - - The topology could not be successfully verified.%0 - - - - - MessageId: MF_E_SIGNATURE_VERIFICATION_FAILED - - MessageText: - - Signature verification could not be completed successfully for this component.%0 - - - - - MessageId: MF_E_DEBUGGING_NOT_ALLOWED - - MessageText: - - Running this process under a debugger while using protected content is not allowed.%0 - - - - - MessageId: MF_E_CODE_EXPIRED - - MessageText: - - MF component has expired.%0 - - - - - MessageId: MF_E_GRL_VERSION_TOO_LOW - - MessageText: - - The current GRL on the machine does not meet the minimum version requirements.%0 - - - - - MessageId: MF_E_GRL_RENEWAL_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any renewal entries for the specified revocation.%0 - - - - - MessageId: MF_E_GRL_EXTENSIBLE_ENTRY_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any extensible entries for the specified extension GUID.%0 - - - - - MessageId: MF_E_KERNEL_UNTRUSTED - - MessageText: - - The kernel isn't secure for high security level content.%0 - - - - - MessageId: MF_E_PEAUTH_UNTRUSTED - - MessageText: - - The response from protected environment driver isn't valid.%0 - - - - - MessageId: MF_E_NON_PE_PROCESS - - MessageText: - - A non-PE process tried to talk to PEAuth.%0 - - - - - MessageId: MF_E_REBOOT_REQUIRED - - MessageText: - - We need to reboot the machine.%0 - - - - - MessageId: MF_S_WAIT_FOR_POLICY_SET - - MessageText: - - Protection for this stream is not guaranteed to be enforced until the MEPolicySet event is fired.%0 - - - - - MessageId: MF_S_VIDEO_DISABLED_WITH_UNKNOWN_SOFTWARE_OUTPUT - - MessageText: - - This video stream is disabled because it is being sent to an unknown software output.%0 - - - - - MessageId: MF_E_GRL_INVALID_FORMAT - - MessageText: - - The GRL file is not correctly formed, it may have been corrupted or overwritten.%0 - - - - - MessageId: MF_E_GRL_UNRECOGNIZED_FORMAT - - MessageText: - - The GRL file is in a format newer than those recognized by this GRL Reader.%0 - - - - - MessageId: MF_E_ALL_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and required all processes that can run protected media to restart.%0 - - - - - MessageId: MF_E_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and the current process needs to restart.%0 - - - - - MessageId: MF_E_USERMODE_UNTRUSTED - - MessageText: - - The user space is untrusted for protected content play.%0 - - - - - MessageId: MF_E_PEAUTH_SESSION_NOT_STARTED - - MessageText: - - PEAuth communication session hasn't been started.%0 - - - - - MessageId: MF_E_PEAUTH_PUBLICKEY_REVOKED - - MessageText: - - PEAuth's public key is revoked.%0 - - - - - MessageId: MF_E_GRL_ABSENT - - MessageText: - - The GRL is absent.%0 - - - - - MessageId: MF_S_PE_TRUSTED - - MessageText: - - The Protected Environment is trusted.%0 - - - - - MessageId: MF_E_PE_UNTRUSTED - - MessageText: - - The Protected Environment is untrusted.%0 - - - - - MessageId: MF_E_PEAUTH_NOT_STARTED - - MessageText: - - The Protected Environment Authorization service (PEAUTH) has not been started.%0 - - - - - MessageId: MF_E_INCOMPATIBLE_SAMPLE_PROTECTION - - MessageText: - - The sample protection algorithms supported by components are not compatible.%0 - - - - - MessageId: MF_E_PE_SESSIONS_MAXED - - MessageText: - - No more protected environment sessions can be supported.%0 - - - - - MessageId: MF_E_HIGH_SECURITY_LEVEL_CONTENT_NOT_ALLOWED - - MessageText: - - WMDRM ITA does not allow protected content with high security level for this release.%0 - - - - - MessageId: MF_E_TEST_SIGNED_COMPONENTS_NOT_ALLOWED - - MessageText: - - WMDRM ITA cannot allow the requested action for the content as one or more components is not properly signed.%0 - - - - - MessageId: MF_E_ITA_UNSUPPORTED_ACTION - - MessageText: - - WMDRM ITA does not support the requested action.%0 - - - - - MessageId: MF_E_ITA_ERROR_PARSING_SAP_PARAMETERS - - MessageText: - - WMDRM ITA encountered an error in parsing the Secure Audio Path parameters.%0 - - - - - MessageId: MF_E_POLICY_MGR_ACTION_OUTOFBOUNDS - - MessageText: - - The Policy Manager action passed in is invalid.%0 - - - - - MessageId: MF_E_BAD_OPL_STRUCTURE_FORMAT - - MessageText: - - The structure specifying Output Protection Level is not the correct format.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_PROTECTION_GUID - - MessageText: - - WMDRM ITA does not recognize the Explicite Analog Video Output Protection guid specified in the license.%0 - - - - - MessageId: MF_E_NO_PMP_HOST - - MessageText: - - IMFPMPHost object not available.%0 - - - - - MessageId: MF_E_ITA_OPL_DATA_NOT_INITIALIZED - - MessageText: - - WMDRM ITA could not initialize the Output Protection Level data.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Analog Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_DIGITAL_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Digital Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_CLOCK_INVALID_CONTINUITY_KEY - - MessageText: - - The continuity key supplied is not currently valid.%0 - - - - - MessageId: MF_E_CLOCK_NO_TIME_SOURCE - - MessageText: - - No Presentation Time Source has been specified.%0 - - - - - MessageId: MF_E_CLOCK_STATE_ALREADY_SET - - MessageText: - - The clock is already in the requested state.%0 - - - - - MessageId: MF_E_CLOCK_NOT_SIMPLE - - MessageText: - - The clock has too many advanced features to carry out the request.%0 - - - - - MessageId: MF_S_CLOCK_STOPPED - - MessageText: - - Timer::SetTimer returns this success code if called happened while timer is stopped. Timer is not going to be dispatched until clock is running%0 - - - - - MessageId: MF_E_NO_MORE_DROP_MODES - - MessageText: - - The component does not support any more drop modes.%0 - - - - - MessageId: MF_E_NO_MORE_QUALITY_LEVELS - - MessageText: - - The component does not support any more quality levels.%0 - - - - - MessageId: MF_E_DROPTIME_NOT_SUPPORTED - - MessageText: - - The component does not support drop time functionality.%0 - - - - - MessageId: MF_E_QUALITYKNOB_WAIT_LONGER - - MessageText: - - Quality Manager needs to wait longer before bumping the Quality Level up.%0 - - - - - MessageId: MF_E_QM_INVALIDSTATE - - MessageText: - - Quality Manager is in an invalid state. Quality Management is off at this moment.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_CONTAINERTYPE - - MessageText: - - No transcode output container type is specified.%0 - - - - - MessageId: MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS - - MessageText: - - The profile does not have a media type configuration for any selected source streams.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_MATCHING_ENCODER - - MessageText: - - Cannot find an encoder MFT that accepts the user preferred output type.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_INITIALIZED - - MessageText: - - Memory allocator is not initialized.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_COMMITED - - MessageText: - - Memory allocator is not committed yet.%0 - - - - - MessageId: MF_E_ALLOCATOR_ALREADY_COMMITED - - MessageText: - - Memory allocator has already been committed.%0 - - - - - MessageId: MF_E_STREAM_ERROR - - MessageText: - - An error occurred in media stream.%0 - - - - - MessageId: MF_E_INVALID_STREAM_STATE - - MessageText: - - Stream is not in a state to handle the request.%0 - - - - - MessageId: MF_E_HW_STREAM_NOT_CONNECTED - - MessageText: - - Hardware stream is not connected yet.%0 - - - - - Main interface for using Media Foundation with NAudio - - - - - initializes MediaFoundation - only needs to be called once per process - - - - - Enumerate the installed MediaFoundation transforms in the specified category - - A category from MediaFoundationTransformCategories - - - - - uninitializes MediaFoundation - - - - - Creates a Media type - - - - - Creates a media type from a WaveFormat - - - - - Creates a memory buffer of the specified size - - Memory buffer size in bytes - The memory buffer - - - - Creates a sample object - - The sample object - - - - Creates a new attributes store - - Initial size - The attributes store - - - - Creates a media foundation byte stream based on a stream object - (usable with WinRT streams) - - The input stream - A media foundation byte stream - - - - Creates a source reader based on a byte stream - - The byte stream - A media foundation source reader - - - - Interop definitions for MediaFoundation - thanks to Lucian Wischik for the initial work on many of these definitions (also various interfaces) - n.b. the goal is to make as much of this internal as possible, and provide - better .NET APIs using the MediaFoundationApi class instead - - - - - Initializes Microsoft Media Foundation. - - - - - Shuts down the Microsoft Media Foundation platform - - - - - Creates an empty media type. - - - - - Initializes a media type from a WAVEFORMATEX structure. - - - - - Converts a Media Foundation audio media type to a WAVEFORMATEX structure. - - TODO: try making second parameter out WaveFormatExtraData - - - - Creates the source reader from a URL. - - - - - Creates the source reader from a byte stream. - - - - - Creates the sink writer from a URL or byte stream. - - - - - Creates a Microsoft Media Foundation byte stream that wraps an IRandomAccessStream object. - - - - - Gets a list of Microsoft Media Foundation transforms (MFTs) that match specified search criteria. - - - - - Creates an empty media sample. - - - - - Allocates system memory and creates a media buffer to manage it. - - - - - Creates an empty attribute store. - - - - - Gets a list of output formats from an audio encoder. - - - - - All streams - - - - - First audio stream - - - - - First video stream - - - - - Media source - - - - - Media Foundation SDK Version - - - - - Media Foundation API Version - - - - - Media Foundation Version - - - - - An abstract base class for simplifying working with Media Foundation Transforms - You need to override the method that actually creates and configures the transform - - - - - The Source Provider - - - - - The Output WaveFormat - - - - - Constructs a new MediaFoundationTransform wrapper - Will read one second at a time - - The source provider for input data to the transform - The desired output format - - - - To be implemented by overriding classes. Create the transform object, set up its input and output types, - and configure any custom properties in here - - An object implementing IMFTrasform - - - - Disposes this MediaFoundation transform - - - - - Disposes this Media Foundation Transform - - - - - Destructor - - - - - The output WaveFormat of this Media Foundation Transform - - - - - Reads data out of the source, passing it through the transform - - Output buffer - Offset within buffer to write to - Desired byte count - Number of bytes read - - - - Attempts to read from the transform - Some useful info here: - http://msdn.microsoft.com/en-gb/library/windows/desktop/aa965264%28v=vs.85%29.aspx#process_data - - - - - - Indicate that the source has been repositioned and completely drain out the transforms buffers - - - - - Media Foundation Transform Categories - - - - - MFT_CATEGORY_VIDEO_DECODER - - - - - MFT_CATEGORY_VIDEO_ENCODER - - - - - MFT_CATEGORY_VIDEO_EFFECT - - - - - MFT_CATEGORY_MULTIPLEXER - - - - - MFT_CATEGORY_DEMULTIPLEXER - - - - - MFT_CATEGORY_AUDIO_DECODER - - - - - MFT_CATEGORY_AUDIO_ENCODER - - - - - MFT_CATEGORY_AUDIO_EFFECT - - - - - MFT_CATEGORY_VIDEO_PROCESSOR - - - - - MFT_CATEGORY_OTHER - - - - - Media Type helper class, simplifying working with IMFMediaType - (will probably change in the future, to inherit from an attributes class) - Currently does not release the COM object, so you must do that yourself - - - - - Wraps an existing IMFMediaType object - - The IMFMediaType object - - - - Creates and wraps a new IMFMediaType object - - - - - Creates and wraps a new IMFMediaType object based on a WaveFormat - - WaveFormat - - - - Tries to get a UINT32 value, returning a default value if it doesn't exist - - Attribute key - Default value - Value or default if key doesn't exist - - - - The Sample Rate (valid for audio media types) - - - - - The number of Channels (valid for audio media types) - - - - - The number of bits per sample (n.b. not always valid for compressed audio types) - - - - - The average bytes per second (valid for audio media types) - - - - - The Media Subtype. For audio, is a value from the AudioSubtypes class - - - - - The Major type, e.g. audio or video (from the MediaTypes class) - - - - - Access to the actual IMFMediaType object - Use to pass to MF APIs or Marshal.ReleaseComObject when you are finished with it - - - - - Major Media Types - http://msdn.microsoft.com/en-us/library/windows/desktop/aa367377%28v=vs.85%29.aspx - - - - - Default - - - - - Audio - - - - - Video - - - - - Protected Media - - - - - Synchronized Accessible Media Interchange (SAMI) captions. - - - - - Script stream - - - - - Still image stream. - - - - - HTML stream. - - - - - Binary stream. - - - - - A stream that contains data files. - - - - - Contains information about an input stream on a Media Foundation transform (MFT) - - - - - Maximum amount of time between an input sample and the corresponding output sample, in 100-nanosecond units. - - - - - Bitwise OR of zero or more flags from the _MFT_INPUT_STREAM_INFO_FLAGS enumeration. - - - - - The minimum size of each input buffer, in bytes. - - - - - Maximum amount of input data, in bytes, that the MFT holds to perform lookahead. - - - - - The memory alignment required for input buffers. If the MFT does not require a specific alignment, the value is zero. - - - - - Defines messages for a Media Foundation transform (MFT). - - - - - Requests the MFT to flush all stored data. - - - - - Requests the MFT to drain any stored data. - - - - - Sets or clears the Direct3D Device Manager for DirectX Video Accereration (DXVA). - - - - - Drop samples - requires Windows 7 - - - - - Command Tick - requires Windows 8 - - - - - Notifies the MFT that streaming is about to begin. - - - - - Notifies the MFT that streaming is about to end. - - - - - Notifies the MFT that an input stream has ended. - - - - - Notifies the MFT that the first sample is about to be processed. - - - - - Marks a point in the stream. This message applies only to asynchronous MFTs. Requires Windows 7 - - - - - Contains information about an output buffer for a Media Foundation transform. - - - - - Output stream identifier. - - - - - Pointer to the IMFSample interface. - - - - - Before calling ProcessOutput, set this member to zero. - - - - - Before calling ProcessOutput, set this member to NULL. - - - - - Contains information about an output stream on a Media Foundation transform (MFT). - - - - - Bitwise OR of zero or more flags from the _MFT_OUTPUT_STREAM_INFO_FLAGS enumeration. - - - - - Minimum size of each output buffer, in bytes. - - - - - The memory alignment required for output buffers. - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The Media Subtype - - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. - - - - - The time stamp of the most recent sample to be encoded. - - - - - The time stamp of the most recent sample given to the media sink. - - - - - The time stamp of the most recent stream tick. - - - - - The system time of the most recent sample request from the media sink. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Contains flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - - - - - The MFT performs asynchronous data processing in software. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. - - - - - The MFT that must be unlocked by the application before use. - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. - - - - - Bitwise OR of all the flags, excluding MFT_ENUM_FLAG_SORTANDFILTER. - - - - - Indicates the status of an input stream on a Media Foundation transform (MFT). - - - - - None - - - - - The input stream can receive more data at this time. - - - - - Describes an input stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of input data must contain complete, unbroken units of data. - - - - - Each media sample that the client provides as input must contain exactly one unit of data, as defined for the MFT_INPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All input samples must be the same size. - - - - - MTF Input Stream Holds buffers - - - - - The MFT does not hold input samples after the IMFTransform::ProcessInput method returns. - - - - - This input stream can be removed by calling IMFTransform::DeleteInputStream. - - - - - This input stream is optional. - - - - - The MFT can perform in-place processing. - - - - - Defines flags for the IMFTransform::ProcessOutput method. - - - - - None - - - - - The MFT can still generate output from this stream without receiving any more input. - - - - - The format has changed on this output stream, or there is a new preferred format for this stream. - - - - - The MFT has removed this output stream. - - - - - There is no sample ready for this stream. - - - - - Indicates whether a Media Foundation transform (MFT) can produce output data. - - - - - None - - - - - There is a sample available for at least one output stream. - - - - - Describes an output stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of output data from the MFT contains complete, unbroken units of data. - - - - - Each output sample contains exactly one unit of data, as defined for the MFT_OUTPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All output samples are the same size. - - - - - The MFT can discard the output data from this output stream, if requested by the client. - - - - - This output stream is optional. - - - - - The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. - - - - - The MFT can either provide output samples for this stream or it can use samples that the client allocates. - - - - - The MFT does not require the client to process the output for this stream. - - - - - The MFT might remove this output stream during streaming. - - - - - Defines flags for processing output samples in a Media Foundation transform (MFT). - - - - - None - - - - - Do not produce output for streams in which the pSample member of the MFT_OUTPUT_DATA_BUFFER structure is NULL. - - - - - Regenerates the last output sample. - - - - - Process Output Status flags - - - - - None - - - - - The Media Foundation transform (MFT) has created one or more new output streams. - - - - - Defines flags for the setting or testing the media type on a Media Foundation transform (MFT). - - - - - None - - - - - Test the proposed media type, but do not set it. - - - - - Represents a MIDI Channel AfterTouch Event. - - - - - Creates a new ChannelAfterTouchEvent from raw MIDI data - - A binary reader - - - - Creates a new Channel After-Touch Event - - Absolute time - Channel - After-touch pressure - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The aftertouch pressure value - - - - - Represents a MIDI control change event - - - - - Reads a control change event from a MIDI stream - - Binary reader on the MIDI stream - - - - Creates a control change event - - Time - MIDI Channel Number - The MIDI Controller - Controller value - - - - Describes this control change event - - A string describing this event - - - - - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The controller number - - - - - The controller value - - - - - Represents a MIDI key signature event event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new Key signature event with the specified data - - - - - Creates a deep clone of this MIDI event. - - - - - Number of sharps or flats - - - - - Major or Minor key - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event - - - - - Gets the type of this meta event - - - - - Empty constructor - - - - - Custom constructor for use by derived types, who will manage the data themselves - - Meta event type - Meta data length - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Reads a meta-event from a stream - - A binary reader based on the stream of MIDI data - A new MetaEvent object - - - - Describes this meta event - - - - - - - - - - MIDI MetaEvent Type - - - - Track sequence number - - - Text event - - - Copyright - - - Sequence track name - - - Track instrument name - - - Lyric - - - Marker - - - Cue point - - - Program (patch) name - - - Device (port) name - - - MIDI Channel (not official?) - - - MIDI Port (not official?) - - - End track - - - Set tempo - - - SMPTE offset - - - Time signature - - - Key signature - - - Sequencer specific - - - - MIDI command codes - - - - Note Off - - - Note On - - - Key After-touch - - - Control change - - - Patch change - - - Channel after-touch - - - Pitch wheel change - - - Sysex message - - - Eox (comes at end of a sysex message) - - - Timing clock (used when synchronization is required) - - - Start sequence - - - Continue sequence - - - Stop sequence - - - Auto-Sensing - - - Meta-event - - - - MidiController enumeration - http://www.midi.org/techspecs/midimessages.php#3 - - - - Bank Select (MSB) - - - Modulation (MSB) - - - Breath Controller - - - Foot controller (MSB) - - - Main volume - - - Pan - - - Expression - - - Bank Select LSB - - - Sustain - - - Portamento On/Off - - - Sostenuto On/Off - - - Soft Pedal On/Off - - - Legato Footswitch - - - Reset all controllers - - - All notes off - - - - Represents an individual MIDI event - - - - The MIDI command code - - - - Creates a MidiEvent from a raw message received using - the MME MIDI In APIs - - The short MIDI message - A new MIDI Event - - - - Constructs a MidiEvent from a BinaryStream - - The binary stream of MIDI data - The previous MIDI event (pass null for first event) - A new MidiEvent - - - - Converts this MIDI event to a short message (32 bit integer) that - can be sent by the Windows MIDI out short message APIs - Cannot be implemented for all MIDI messages - - A short message - - - - Default constructor - - - - - Creates a MIDI event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - - - - Creates a deep clone of this MIDI event. - - - - - The MIDI Channel Number for this event (1-16) - - - - - The Delta time for this event - - - - - The absolute time for this event - - - - - The command code for this event - - - - - Whether this is a note off event - - - - - Whether this is a note on event - - - - - Determines if this is an end track event - - - - - Displays a summary of the MIDI event - - A string containing a brief description of this MIDI event - - - - Utility function that can read a variable length integer from a binary stream - - The binary stream - The integer read - - - - Writes a variable length integer to a binary stream - - Binary stream - The value to write - - - - Exports this MIDI event's data - Overriden in derived classes, but they should call this version - - Absolute time used to calculate delta. - Is updated ready for the next delta calculation - Stream to write to - - - - A helper class to manage collection of MIDI events - It has the ability to organise them in tracks - - - - - Creates a new Midi Event collection - - Initial file type - Delta Ticks Per Quarter Note - - - - The number of tracks - - - - - The absolute time that should be considered as time zero - Not directly used here, but useful for timeshifting applications - - - - - The number of ticks per quarter note - - - - - Gets events on a specified track - - Track number - The list of events - - - - Gets events on a specific track - - Track number - The list of events - - - - Adds a new track - - The new track event list - - - - Adds a new track - - Initial events to add to the new track - The new track event list - - - - Removes a track - - Track number to remove - - - - Clears all events - - - - - The MIDI file type - - - - - Adds an event to the appropriate track depending on file type - - The event to be added - The original (or desired) track number - When adding events in type 0 mode, the originalTrack parameter - is ignored. If in type 1 mode, it will use the original track number to - store the new events. If the original track was 0 and this is a channel based - event, it will create new tracks if necessary and put it on the track corresponding - to its channel number - - - - Sorts, removes empty tracks and adds end track markers - - - - - Gets an enumerator for the lists of track events - - - - - Gets an enumerator for the lists of track events - - - - - Utility class for comparing MidiEvent objects - - - - - Compares two MidiEvents - Sorts by time, with EndTrack always sorted to the end - - - - - Class able to read a MIDI file - - - - - Opens a MIDI file for reading - - Name of MIDI file - - - - MIDI File format - - - - - Opens a MIDI file for reading - - Name of MIDI file - If true will error on non-paired note events - - - - Opens a MIDI file stream for reading - - The input stream containing a MIDI file - If true will error on non-paired note events - - - - The collection of events in this MIDI file - - - - - Number of tracks in this MIDI file - - - - - Delta Ticks Per Quarter Note - - - - - Describes the MIDI file - - A string describing the MIDI file and its events - - - - Exports a MIDI file - - Filename to export to - Events to export - - - - Represents a MIDI in device - - - - - Called when a MIDI message is received - - - - - An invalid MIDI message - - - - - Gets the number of MIDI input devices available in the system - - - - - Opens a specified MIDI in device - - The device number - - - - Closes this MIDI in device - - - - - Closes this MIDI in device - - - - - Start the MIDI in device - - - - - Stop the MIDI in device - - - - - Reset the MIDI in device - - - - - Gets the MIDI in device info - - - - - Closes the MIDI out device - - True if called from Dispose - - - - Cleanup - - - - - MIDI In Device Capabilities - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name - - - - - Support - Reserved - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - MIDI In Message Information - - - - - Create a new MIDI In Message EventArgs - - - - - - - The Raw message received from the MIDI In API - - - - - The raw message interpreted as a MidiEvent - - - - - The timestamp in milliseconds for this message - - - - - MIM_OPEN - - - - - MIM_CLOSE - - - - - MIM_DATA - - - - - MIM_LONGDATA - - - - - MIM_ERROR - - - - - MIM_LONGERROR - - - - - MIM_MOREDATA - - - - - MOM_OPEN - - - - - MOM_CLOSE - - - - - MOM_DONE - - - - - Represents a MIDI message - - - - - Creates a new MIDI message - - Status - Data parameter 1 - Data parameter 2 - - - - Creates a new MIDI message from a raw message - - A packed MIDI message from an MMIO function - - - - Creates a Note On message - - Note number (0 to 127) - Volume (0 to 127) - MIDI channel (1 to 16) - A new MidiMessage object - - - - Creates a Note Off message - - Note number - Volume - MIDI channel (1-16) - A new MidiMessage object - - - - Creates a patch change message - - The patch number - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Creates a Control Change message - - The controller number to change - The value to set the controller to - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Returns the raw MIDI message data - - - - - Represents a MIDI out device - - - - - Gets the number of MIDI devices available in the system - - - - - Gets the MIDI Out device info - - - - - Opens a specified MIDI out device - - The device number - - - - Closes this MIDI out device - - - - - Closes this MIDI out device - - - - - Gets or sets the volume for this MIDI out device - - - - - Resets the MIDI out device - - - - - Sends a MIDI out message - - Message - Parameter 1 - Parameter 2 - - - - Sends a MIDI message to the MIDI out device - - The message to send - - - - Closes the MIDI out device - - True if called from Dispose - - - - Send a long message, for example sysex. - - The bytes to send. - - - - Cleanup - - - - - class representing the capabilities of a MIDI out device - MIDIOUTCAPS: http://msdn.microsoft.com/en-us/library/dd798467%28VS.85%29.aspx - - - - - MIDICAPS_VOLUME - - - - - separate left-right volume control - MIDICAPS_LRVOLUME - - - - - MIDICAPS_CACHE - - - - - MIDICAPS_STREAM - driver supports midiStreamOut directly - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - Returns the number of supported voices - - - - - Gets the polyphony of the device - - - - - Returns true if the device supports all channels - - - - - Queries whether a particular channel is supported - - Channel number to test - True if the channel is supported - - - - Returns true if the device supports patch caching - - - - - Returns true if the device supports separate left and right volume - - - - - Returns true if the device supports MIDI stream out - - - - - Returns true if the device supports volume control - - - - - Returns the type of technology used by this MIDI out device - - - - - Represents the different types of technology used by a MIDI out device - - from mmsystem.h - - - The device is a MIDI port - - - The device is a MIDI synth - - - The device is a square wave synth - - - The device is an FM synth - - - The device is a MIDI mapper - - - The device is a WaveTable synth - - - The device is a software synth - - - - Represents a note MIDI event - - - - - Reads a NoteEvent from a stream of MIDI data - - Binary Reader for the stream - - - - Creates a MIDI Note Event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - MIDI Note Number - MIDI Note Velocity - - - - - - - - - The MIDI note number - - - - - The note velocity - - - - - The note name - - - - - Describes the Note Event - - Note event as a string - - - - - - - - - Represents a MIDI note on event - - - - - Reads a new Note On event from a stream of MIDI data - - Binary reader on the MIDI data stream - - - - Creates a NoteOn event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI note number - MIDI note velocity - MIDI note duration - - - - Creates a deep clone of this MIDI event. - - - - - The associated Note off event - - - - - Get or set the Note Number, updating the off event at the same time - - - - - Get or set the channel, updating the off event at the same time - - - - - The duration of this note - - - There must be a note off event - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI patch change event - - - - - Gets the default MIDI instrument names - - - - - Reads a new patch change event from a MIDI stream - - Binary reader for the MIDI stream - - - - Creates a new patch change event - - Time of the event - Channel number - Patch number - - - - The Patch Number - - - - - Describes this patch change event - - String describing the patch change event - - - - Gets as a short message for sending with the midiOutShortMsg API - - short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI pitch wheel change event - - - - - Reads a pitch wheel change event from a MIDI stream - - The MIDI stream to read from - - - - Creates a new pitch wheel change event - - Absolute event time - Channel - Pitch wheel value - - - - Describes this pitch wheel change event - - String describing this pitch wheel change event - - - - Pitch Wheel Value 0 is minimum, 0x2000 (8192) is default, 0x3FFF (16383) is maximum - - - - - Gets a short message - - Integer to sent as short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event with raw data - - - - - Raw data contained in the meta event - - - - - Creates a meta event with raw data - - - - - Creates a deep clone of this MIDI event. - - - - - Describes this meta event - - - - - - - - - - Represents a Sequencer Specific event - - - - - Reads a new sequencer specific event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new Sequencer Specific event - - The sequencer specific data - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this sequencer specific - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - SMPTE Offset Event - - - - - Creates a new time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a deep clone of this MIDI event. - - - - - Hours - - - - - Minutes - - - - - Seconds - - - - - Frames - - - - - SubFrames - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI sysex message - - - - - Reads a sysex message from a MIDI stream - - Stream of MIDI data - a new sysex message - - - - Creates a deep clone of this MIDI event. - - - - - Describes this sysex message - - A string describing the sysex message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI tempo event - - - - - Reads a new tempo event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new tempo event with specified settings - - Microseconds per quarter note - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Describes this tempo event - - String describing the tempo event - - - - Microseconds per quarter note - - - - - Tempo - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI text event - - - - - Reads a new text event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TextEvent - - The text in this type - MetaEvent type (must be one that is - associated with text data) - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this text event - - - - - The raw contents of this text event - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TimeSignatureEvent - - Time at which to create this event - Numerator - Denominator - Ticks in Metronome Click - No of 32nd Notes in Quarter Click - - - - Creates a deep clone of this MIDI event. - - - - - Numerator (number of beats in a bar) - - - - - Denominator (Beat unit), - 1 means 2, 2 means 4 (crochet), 3 means 8 (quaver), 4 means 16 and 5 means 32 - - - - - Ticks in a metronome click - - - - - Number of 32nd notes in a quarter note - - - - - The time signature - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI track sequence number event event - - - - - Creates a new track sequence number event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a deep clone of this MIDI event. - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Boolean mixer control - - - - - Gets the details for this control - - memory pointer - - - - The current value of the control - - - - - Custom Mixer control - - - - - Get the data for this custom control - - pointer to memory to receive data - - - - List text mixer control - - - - - Get the details for this control - - Memory location to read to - - - Represents a Windows mixer device - - - The number of mixer devices available - - - Connects to the specified mixer - The index of the mixer to use. - This should be between zero and NumberOfDevices - 1 - - - The number of destinations this mixer supports - - - The name of this mixer device - - - The manufacturer code for this mixer device - - - The product identifier code for this mixer device - - - Retrieve the specified MixerDestination object - The ID of the destination to use. - Should be between 0 and DestinationCount - 1 - - - - A way to enumerate the destinations - - - - - A way to enumerate all available devices - - - - - Represents a mixer control - - - - - Mixer Handle - - - - - Number of Channels - - - - - Mixer Handle Type - - - - - Gets all the mixer controls - - Mixer Handle - Mixer Line - Mixer Handle Type - - - - - Gets a specified Mixer Control - - Mixer Handle - Line ID - Control ID - Number of Channels - Flags to use (indicates the meaning of mixerHandle) - - - - - Gets the control details - - - - - Gets the control details - - - - - - Mixer control name - - - - - Mixer control type - - - - - Returns true if this is a boolean control - - Control type - - - - Is this a boolean control - - - - - Determines whether a specified mixer control type is a list text control - - - - - True if this is a list text control - - - - - True if this is a signed control - - - - - True if this is an unsigned control - - - - - True if this is a custom control - - - - - String representation for debug purposes - - - - - Mixer control types - - - - Custom - - - Boolean meter - - - Signed meter - - - Peak meter - - - Unsigned meter - - - Boolean - - - On Off - - - Mute - - - Mono - - - Loudness - - - Stereo Enhance - - - Button - - - Decibels - - - Signed - - - Unsigned - - - Percent - - - Slider - - - Pan - - - Q-sound pan - - - Fader - - - Volume - - - Bass - - - Treble - - - Equaliser - - - Single Select - - - Mux - - - Multiple select - - - Mixer - - - Micro time - - - Milli time - - - - Mixer Interop Flags - - - - - MIXER_OBJECTF_HANDLE = 0x80000000; - - - - - MIXER_OBJECTF_MIXER = 0x00000000; - - - - - MIXER_OBJECTF_HMIXER - - - - - MIXER_OBJECTF_WAVEOUT - - - - - MIXER_OBJECTF_HWAVEOUT - - - - - MIXER_OBJECTF_WAVEIN - - - - - MIXER_OBJECTF_HWAVEIN - - - - - MIXER_OBJECTF_MIDIOUT - - - - - MIXER_OBJECTF_HMIDIOUT - - - - - MIXER_OBJECTF_MIDIIN - - - - - MIXER_OBJECTF_HMIDIIN - - - - - MIXER_OBJECTF_AUX - - - - - MIXER_GETCONTROLDETAILSF_VALUE = 0x00000000; - MIXER_SETCONTROLDETAILSF_VALUE = 0x00000000; - - - - - MIXER_GETCONTROLDETAILSF_LISTTEXT = 0x00000001; - MIXER_SETCONTROLDETAILSF_LISTTEXT = 0x00000001; - - - - - MIXER_GETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_SETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_GETLINECONTROLSF_QUERYMASK = 0x0000000F; - - - - - MIXER_GETLINECONTROLSF_ALL = 0x00000000; - - - - - MIXER_GETLINECONTROLSF_ONEBYID = 0x00000001; - - - - - MIXER_GETLINECONTROLSF_ONEBYTYPE = 0x00000002; - - - - - MIXER_GETLINEINFOF_DESTINATION = 0x00000000; - - - - - MIXER_GETLINEINFOF_SOURCE = 0x00000001; - - - - - MIXER_GETLINEINFOF_LINEID = 0x00000002; - - - - - MIXER_GETLINEINFOF_COMPONENTTYPE = 0x00000003; - - - - - MIXER_GETLINEINFOF_TARGETTYPE = 0x00000004; - - - - - MIXER_GETLINEINFOF_QUERYMASK = 0x0000000F; - - - - - Mixer Line Flags - - - - - Audio line is active. An active line indicates that a signal is probably passing - through the line. - - - - - Audio line is disconnected. A disconnected line's associated controls can still be - modified, but the changes have no effect until the line is connected. - - - - - Audio line is an audio source line associated with a single audio destination line. - If this flag is not set, this line is an audio destination line associated with zero - or more audio source lines. - - - - - BOUNDS structure - - - - - dwMinimum / lMinimum / reserved 0 - - - - - dwMaximum / lMaximum / reserved 1 - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - METRICS structure - - - - - cSteps / reserved[0] - - - - - cbCustomData / reserved[1], number of bytes for control details - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - MIXERCONTROL struct - http://msdn.microsoft.com/en-us/library/dd757293%28VS.85%29.aspx - - - - - Represents a mixer line (source or destination) - - - - - Creates a new mixer destination - - Mixer Handle - Destination Index - Mixer Handle Type - - - - Creates a new Mixer Source For a Specified Source - - Mixer Handle - Destination Index - Source Index - Flag indicating the meaning of mixerHandle - - - - Creates a new Mixer Source - - Wave In Device - - - - Mixer Line Name - - - - - Mixer Line short name - - - - - The line ID - - - - - Component Type - - - - - Mixer destination type description - - - - - Number of channels - - - - - Number of sources - - - - - Number of controls - - - - - Is this destination active - - - - - Is this destination disconnected - - - - - Is this destination a source - - - - - Gets the specified source - - - - - Enumerator for the controls on this Mixer Limne - - - - - Enumerator for the sources on this Mixer Line - - - - - The name of the target output device - - - - - Describes this Mixer Line (for diagnostic purposes) - - - - - Mixer Line Component type enumeration - - - - - Audio line is a destination that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_DST_UNDEFINED - - - - - Audio line is a digital destination (for example, digital input to a DAT or CD audio device). - MIXERLINE_COMPONENTTYPE_DST_DIGITAL - - - - - Audio line is a line level destination (for example, line level input from a CD audio device) that will be the final recording source for the analog-to-digital converter (ADC). Because most audio cards for personal computers provide some sort of gain for the recording audio source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_DST_WAVEIN type. - MIXERLINE_COMPONENTTYPE_DST_LINE - - - - - Audio line is a destination used for a monitor. - MIXERLINE_COMPONENTTYPE_DST_MONITOR - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive speakers. This is the typical component type for the audio output of audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_SPEAKERS - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive headphones. Most audio cards use the same audio destination line for speakers and headphones, in which case the mixer device simply uses the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS type. - MIXERLINE_COMPONENTTYPE_DST_HEADPHONES - - - - - Audio line is a destination that will be routed to a telephone line. - MIXERLINE_COMPONENTTYPE_DST_TELEPHONE - - - - - Audio line is a destination that will be the final recording source for the waveform-audio input (ADC). This line typically provides some sort of gain or attenuation. This is the typical component type for the recording line of most audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_WAVEIN - - - - - Audio line is a destination that will be the final recording source for voice input. This component type is exactly like MIXERLINE_COMPONENTTYPE_DST_WAVEIN but is intended specifically for settings used during voice recording/recognition. Support for this line is optional for a mixer device. Many mixer devices provide only MIXERLINE_COMPONENTTYPE_DST_WAVEIN. - MIXERLINE_COMPONENTTYPE_DST_VOICEIN - - - - - Audio line is a source that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_SRC_UNDEFINED - - - - - Audio line is a digital source (for example, digital output from a DAT or audio CD). - MIXERLINE_COMPONENTTYPE_SRC_DIGITAL - - - - - Audio line is a line-level source (for example, line-level input from an external stereo) that can be used as an optional recording source. Because most audio cards for personal computers provide some sort of gain for the recording source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY type. - MIXERLINE_COMPONENTTYPE_SRC_LINE - - - - - Audio line is a microphone recording source. Most audio cards for personal computers provide at least two types of recording sources: an auxiliary audio line and microphone input. A microphone audio line typically provides some sort of gain. Audio cards that use a single input for use with a microphone or auxiliary audio line should use the MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE component type. - MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE - - - - - Audio line is a source originating from the output of an internal synthesizer. Most audio cards for personal computers provide some sort of MIDI synthesizer (for example, an Adlib®-compatible or OPL/3 FM synthesizer). - MIXERLINE_COMPONENTTYPE_SRC_SYNTHESIZER - - - - - Audio line is a source originating from the output of an internal audio CD. This component type is provided for audio cards that provide an audio source line intended to be connected to an audio CD (or CD-ROM playing an audio CD). - MIXERLINE_COMPONENTTYPE_SRC_COMPACTDISC - - - - - Audio line is a source originating from an incoming telephone line. - MIXERLINE_COMPONENTTYPE_SRC_TELEPHONE - - - - - Audio line is a source originating from personal computer speaker. Several audio cards for personal computers provide the ability to mix what would typically be played on the internal speaker with the output of an audio card. Some audio cards support the ability to use this output as a recording source. - MIXERLINE_COMPONENTTYPE_SRC_PCSPEAKER - - - - - Audio line is a source originating from the waveform-audio output digital-to-analog converter (DAC). Most audio cards for personal computers provide this component type as a source to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination. Some cards also allow this source to be routed to the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_WAVEOUT - - - - - Audio line is a source originating from the auxiliary audio line. This line type is intended as a source with gain or attenuation that can be routed to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination and/or recorded from the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY - - - - - Audio line is an analog source (for example, analog output from a video-cassette tape). - MIXERLINE_COMPONENTTYPE_SRC_ANALOG - - - - - Represents a signed mixer control - - - - - Gets details for this contrl - - - - - The value of the control - - - - - Minimum value for this control - - - - - Maximum value for this control - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - - Represents an unsigned mixer control - - - - - Gets the details for this control - - - - - The control value - - - - - The control's minimum value - - - - - The control's maximum value - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - Helper methods for working with audio buffers - - - - - Ensures the buffer is big enough - - - - - - - - Ensures the buffer is big enough - - - - - - - - these will become extension methods once we move to .NET 3.5 - - - - - Checks if the buffer passed in is entirely full of nulls - - - - - Converts to a string containing the buffer described in hex - - - - - Decodes the buffer using the specified encoding, stopping at the first null - - - - - Concatenates the given arrays into a single array. - - The arrays to concatenate - The concatenated resulting array. - - - - An encoding for use with file types that have one byte per character - - - - - The one and only instance of this class - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Chunk Identifier helpers - - - - - Chunk identifier to Int32 (replaces mmioStringToFOURCC) - - four character chunk identifier - Chunk identifier as int 32 - - - - A very basic circular buffer implementation - - - - - Create a new circular buffer - - Max buffer size in bytes - - - - Write data to the buffer - - Data to write - Offset into data - Number of bytes to write - number of bytes written - - - - Read from the buffer - - Buffer to read into - Offset into read buffer - Bytes to read - Number of bytes actually read - - - - Maximum length of this circular buffer - - - - - Number of bytes currently stored in the circular buffer - - - - - Resets the buffer - - - - - Advances the buffer, discarding bytes - - Bytes to advance - - - - A util class for conversions - - - - - linear to dB conversion - - linear value - decibel value - - - - dB to linear conversion - - decibel value - linear value - - - - Allows us to add descriptions to interop members - - - - - The description - - - - - Field description - - - - - String representation - - - - - - Helper to get descriptions - - - - - Describes the Guid by looking for a FieldDescription attribute on the specified class - - - - - HResult - - - - - S_OK - - - - - S_FALSE - - - - - E_INVALIDARG (from winerror.h) - - - - - MAKE_HRESULT macro - - - - - Helper to deal with the fact that in Win Store apps, - the HResult property name has changed - - COM Exception - The HResult - - - - Methods for converting between IEEE 80-bit extended double precision - and standard C# double precision. - - - - - Converts a C# double precision number to an 80-bit - IEEE extended double precision number (occupying 10 bytes). - - The double precision number to convert to IEEE extended. - An array of 10 bytes containing the IEEE extended number. - - - - Converts an IEEE 80-bit extended precision number to a - C# double precision number. - - The 80-bit IEEE extended number (as an array of 10 bytes). - A C# double precision number that is a close representation of the IEEE extended number. - - - - Pass-through stream that ignores Dispose - Useful for dealing with MemoryStreams that you want to re-use - - - - - The source stream all other methods fall through to - - - - - If true the Dispose will be ignored, if false, will pass through to the SourceStream - Set to true by default - - - - - Creates a new IgnoreDisposeStream - - The source stream - - - - Can Read - - - - - Can Seek - - - - - Can write to the underlying stream - - - - - Flushes the underlying stream - - - - - Gets the length of the underlying stream - - - - - Gets or sets the position of the underlying stream - - - - - Reads from the underlying stream - - - - - Seeks on the underlying stream - - - - - Sets the length of the underlying stream - - - - - Writes to the underlying stream - - - - - Dispose - by default (IgnoreDispose = true) will do nothing, - leaving the underlying stream undisposed - - - - - Support for Marshal Methods in both UWP and .NET 3.5 - - - - - SizeOf a structure - - - - - Offset of a field in a structure - - - - - Pointer to Structure - - - - - In-place and stable implementation of MergeSort - - - - - MergeSort a list of comparable items - - - - - MergeSort a list - - - - - General purpose native methods for internal NAudio use - - - - - WavePosition extension methods - - - - - Get Position as timespan - - - - - Manufacturer codes from mmreg.h - - - - Microsoft Corporation - - - Creative Labs, Inc - - - Media Vision, Inc. - - - Fujitsu Corp. - - - Artisoft, Inc. - - - Turtle Beach, Inc. - - - IBM Corporation - - - Vocaltec LTD. - - - Roland - - - DSP Solutions, Inc. - - - NEC - - - ATI - - - Wang Laboratories, Inc - - - Tandy Corporation - - - Voyetra - - - Antex Electronics Corporation - - - ICL Personal Systems - - - Intel Corporation - - - Advanced Gravis - - - Video Associates Labs, Inc. - - - InterActive Inc - - - Yamaha Corporation of America - - - Everex Systems, Inc - - - Echo Speech Corporation - - - Sierra Semiconductor Corp - - - Computer Aided Technologies - - - APPS Software International - - - DSP Group, Inc - - - microEngineering Labs - - - Computer Friends, Inc. - - - ESS Technology - - - Audio, Inc. - - - Motorola, Inc. - - - Canopus, co., Ltd. - - - Seiko Epson Corporation - - - Truevision - - - Aztech Labs, Inc. - - - Videologic - - - SCALACS - - - Korg Inc. - - - Audio Processing Technology - - - Integrated Circuit Systems, Inc. - - - Iterated Systems, Inc. - - - Metheus - - - Logitech, Inc. - - - Winnov, Inc. - - - NCR Corporation - - - EXAN - - - AST Research Inc. - - - Willow Pond Corporation - - - Sonic Foundry - - - Vitec Multimedia - - - MOSCOM Corporation - - - Silicon Soft, Inc. - - - Supermac - - - Audio Processing Technology - - - Speech Compression - - - Ahead, Inc. - - - Dolby Laboratories - - - OKI - - - AuraVision Corporation - - - Ing C. Olivetti & C., S.p.A. - - - I/O Magic Corporation - - - Matsushita Electric Industrial Co., LTD. - - - Control Resources Limited - - - Xebec Multimedia Solutions Limited - - - New Media Corporation - - - Natural MicroSystems - - - Lyrrus Inc. - - - Compusic - - - OPTi Computers Inc. - - - Adlib Accessories Inc. - - - Compaq Computer Corp. - - - Dialogic Corporation - - - InSoft, Inc. - - - M.P. Technologies, Inc. - - - Weitek - - - Lernout & Hauspie - - - Quanta Computer Inc. - - - Apple Computer, Inc. - - - Digital Equipment Corporation - - - Mark of the Unicorn - - - Workbit Corporation - - - Ositech Communications Inc. - - - miro Computer Products AG - - - Cirrus Logic - - - ISOLUTION B.V. - - - Horizons Technology, Inc - - - Computer Concepts Ltd - - - Voice Technologies Group, Inc. - - - Radius - - - Rockwell International - - - Co. XYZ for testing - - - Opcode Systems - - - Voxware Inc - - - Northern Telecom Limited - - - APICOM - - - Grande Software - - - ADDX - - - Wildcat Canyon Software - - - Rhetorex Inc - - - Brooktree Corporation - - - ENSONIQ Corporation - - - FAST Multimedia AG - - - NVidia Corporation - - - OKSORI Co., Ltd. - - - DiAcoustics, Inc. - - - Gulbransen, Inc. - - - Kay Elemetrics, Inc. - - - Crystal Semiconductor Corporation - - - Splash Studios - - - Quarterdeck Corporation - - - TDK Corporation - - - Digital Audio Labs, Inc. - - - Seer Systems, Inc. - - - PictureTel Corporation - - - AT&T Microelectronics - - - Osprey Technologies, Inc. - - - Mediatrix Peripherals - - - SounDesignS M.C.S. Ltd. - - - A.L. Digital Ltd. - - - Spectrum Signal Processing, Inc. - - - Electronic Courseware Systems, Inc. - - - AMD - - - Core Dynamics - - - CANAM Computers - - - Softsound, Ltd. - - - Norris Communications, Inc. - - - Danka Data Devices - - - EuPhonics - - - Precept Software, Inc. - - - Crystal Net Corporation - - - Chromatic Research, Inc - - - Voice Information Systems, Inc - - - Vienna Systems - - - Connectix Corporation - - - Gadget Labs LLC - - - Frontier Design Group LLC - - - Viona Development GmbH - - - Casio Computer Co., LTD - - - Diamond Multimedia - - - S3 - - - Fraunhofer - - - - Summary description for MmException. - - - - - Creates a new MmException - - The result returned by the Windows API call - The name of the Windows API that failed - - - - Helper function to automatically raise an exception on failure - - The result of the API call - The API function name - - - - Returns the Windows API result - - - - - Windows multimedia error codes from mmsystem.h. - - - - no error, MMSYSERR_NOERROR - - - unspecified error, MMSYSERR_ERROR - - - device ID out of range, MMSYSERR_BADDEVICEID - - - driver failed enable, MMSYSERR_NOTENABLED - - - device already allocated, MMSYSERR_ALLOCATED - - - device handle is invalid, MMSYSERR_INVALHANDLE - - - no device driver present, MMSYSERR_NODRIVER - - - memory allocation error, MMSYSERR_NOMEM - - - function isn't supported, MMSYSERR_NOTSUPPORTED - - - error value out of range, MMSYSERR_BADERRNUM - - - invalid flag passed, MMSYSERR_INVALFLAG - - - invalid parameter passed, MMSYSERR_INVALPARAM - - - handle being used simultaneously on another thread (eg callback),MMSYSERR_HANDLEBUSY - - - specified alias not found, MMSYSERR_INVALIDALIAS - - - bad registry database, MMSYSERR_BADDB - - - registry key not found, MMSYSERR_KEYNOTFOUND - - - registry read error, MMSYSERR_READERROR - - - registry write error, MMSYSERR_WRITEERROR - - - registry delete error, MMSYSERR_DELETEERROR - - - registry value not found, MMSYSERR_VALNOTFOUND - - - driver does not call DriverCallback, MMSYSERR_NODRIVERCB - - - more data to be returned, MMSYSERR_MOREDATA - - - unsupported wave format, WAVERR_BADFORMAT - - - still something playing, WAVERR_STILLPLAYING - - - header not prepared, WAVERR_UNPREPARED - - - device is synchronous, WAVERR_SYNC - - - Conversion not possible (ACMERR_NOTPOSSIBLE) - - - Busy (ACMERR_BUSY) - - - Header Unprepared (ACMERR_UNPREPARED) - - - Cancelled (ACMERR_CANCELED) - - - invalid line (MIXERR_INVALLINE) - - - invalid control (MIXERR_INVALCONTROL) - - - invalid value (MIXERR_INVALVALUE) - - - diff --git a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.dll b/packages/NAudio.1.10.0/lib/uap10.0/NAudio.dll deleted file mode 100644 index cbe4ee7..0000000 Binary files a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.dll and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.pri b/packages/NAudio.1.10.0/lib/uap10.0/NAudio.pri deleted file mode 100644 index a61cc63..0000000 Binary files a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.pri and /dev/null differ diff --git a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.xml b/packages/NAudio.1.10.0/lib/uap10.0/NAudio.xml deleted file mode 100644 index 0a77fd9..0000000 --- a/packages/NAudio.1.10.0/lib/uap10.0/NAudio.xml +++ /dev/null @@ -1,19517 +0,0 @@ - - - - NAudio - - - - - a-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts an a-law encoded byte to a 16 bit linear sample - - a-law encoded byte - Linear sample - - - - A-law encoder - - - - - Encodes a single 16 bit sample to a-law - - 16 bit PCM sample - a-law encoded byte - - - - SpanDSP - a series of DSP components for telephony - - g722_decode.c - The ITU G.722 codec, decode part. - - Written by Steve Underwood <steveu@coppice.org> - - Copyright (C) 2005 Steve Underwood - Ported to C# by Mark Heath 2011 - - Despite my general liking of the GPL, I place my own contributions - to this code in the public domain for the benefit of all mankind - - even the slimy ones who might try to proprietize my work and use it - to my detriment. - - Based in part on a single channel G.722 codec which is: - Copyright (c) CMU 1993 - Computer Science, Speech Group - Chengxiang Lu and Alex Hauptmann - - - - - hard limits to 16 bit samples - - - - - Decodes a buffer of G722 - - Codec state - Output buffer (to contain decompressed PCM samples) - - Number of bytes in input G722 data to decode - Number of samples written into output buffer - - - - Encodes a buffer of G722 - - Codec state - Output buffer (to contain encoded G722) - PCM 16 bit samples to encode - Number of samples in the input buffer to encode - Number of encoded bytes written into output buffer - - - - Stores state to be used between calls to Encode or Decode - - - - - ITU Test Mode - TRUE if the operating in the special ITU test mode, with the band split filters disabled. - - - - - TRUE if the G.722 data is packed - - - - - 8kHz Sampling - TRUE if encode from 8k samples/second - - - - - Bits Per Sample - 6 for 48000kbps, 7 for 56000kbps, or 8 for 64000kbps. - - - - - Signal history for the QMF (x) - - - - - Band - - - - - In bit buffer - - - - - Number of bits in InBuffer - - - - - Out bit buffer - - - - - Number of bits in OutBuffer - - - - - Creates a new instance of G722 Codec State for a - new encode or decode session - - Bitrate (typically 64000) - Special options - - - - Band data for G722 Codec - - - - s - - - sp - - - sz - - - r - - - a - - - ap - - - p - - - d - - - b - - - bp - - - sg - - - nb - - - det - - - - G722 Flags - - - - - None - - - - - Using a G722 sample rate of 8000 - - - - - Packed - - - - - mu-law decoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - only 512 bytes required, so just use a lookup - - - - - Converts a mu-law encoded byte to a 16 bit linear sample - - mu-law encoded byte - Linear sample - - - - mu-law encoder - based on code from: - http://hazelware.luggle.com/tutorials/mulawcompression.html - - - - - Encodes a single 16 bit sample to mu-law - - 16 bit PCM sample - mu-law encoded byte - - - - Audio Capture Client - - - - - Gets a pointer to the buffer - - Pointer to the buffer - - - - Gets a pointer to the buffer - - Number of frames to read - Buffer flags - Pointer to the buffer - - - - Gets the size of the next packet - - - - - Release buffer - - Number of frames written - - - - Release the COM object - - - - - Windows CoreAudio AudioClient - - - - - Retrieves the stream format that the audio engine uses for its internal processing of shared-mode streams. - Can be called before initialize - - - - - Initializes the Audio Client - - Share Mode - Stream Flags - Buffer Duration - Periodicity - Wave Format - Audio Session GUID (can be null) - - - - Retrieves the size (maximum capacity) of the audio buffer associated with the endpoint. (must initialize first) - - - - - Retrieves the maximum latency for the current stream and can be called any time after the stream has been initialized. - - - - - Retrieves the number of frames of padding in the endpoint buffer (must initialize first) - - - - - Retrieves the length of the periodic interval separating successive processing passes by the audio engine on the data in the endpoint buffer. - (can be called before initialize) - - - - - Gets the minimum device period - (can be called before initialize) - - - - - Returns the AudioStreamVolume service for this AudioClient. - - - This returns the AudioStreamVolume object ONLY for shared audio streams. - - - This is thrown when an exclusive audio stream is being used. - - - - - Gets the AudioClockClient service - - - - - Gets the AudioRenderClient service - - - - - Gets the AudioCaptureClient service - - - - - Determines whether if the specified output format is supported - - The share mode. - The desired format. - True if the format is supported - - - - Determines if the specified output format is supported in shared mode - - Share Mode - Desired Format - Output The closest match format. - True if the format is supported - - - - Starts the audio stream - - - - - Stops the audio stream. - - - - - Set the Event Handle for buffer synchro. - - The Wait Handle to setup - - - - Resets the audio stream - Reset is a control method that the client calls to reset a stopped audio stream. - Resetting the stream flushes all pending data and resets the audio clock stream - position to 0. This method fails if it is called on a stream that is not stopped - - - - - Dispose - - - - - Audio Client Buffer Flags - - - - - None - - - - - AUDCLNT_BUFFERFLAGS_DATA_DISCONTINUITY - - - - - AUDCLNT_BUFFERFLAGS_SILENT - - - - - AUDCLNT_BUFFERFLAGS_TIMESTAMP_ERROR - - - - - The AudioClientProperties structure is used to set the parameters that describe the properties of the client's audio stream. - - http://msdn.microsoft.com/en-us/library/windows/desktop/hh968105(v=vs.85).aspx - - - - The size of the buffer for the audio stream. - - - - - Boolean value to indicate whether or not the audio stream is hardware-offloaded - - - - - An enumeration that is used to specify the category of the audio stream. - - - - - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - - AUDCLNT_SHAREMODE - - - - - AUDCLNT_SHAREMODE_SHARED, - - - - - AUDCLNT_SHAREMODE_EXCLUSIVE - - - - - AUDCLNT_STREAMFLAGS - - - - - None - - - - - AUDCLNT_STREAMFLAGS_CROSSPROCESS - - - - - AUDCLNT_STREAMFLAGS_LOOPBACK - - - - - AUDCLNT_STREAMFLAGS_EVENTCALLBACK - - - - - AUDCLNT_STREAMFLAGS_NOPERSIST - - - - - Defines values that describe the characteristics of an audio stream. - - - - - No stream options. - - - - - The audio stream is a 'raw' stream that bypasses all signal processing except for endpoint specific, always-on processing in the APO, driver, and hardware. - - - - - Audio Clock Client - - - - - Characteristics - - - - - Frequency - - - - - Get Position - - - - - Adjusted Position - - - - - Can Adjust Position - - - - - Dispose - - - - - Audio Endpoint Volume - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - On Volume Notification - - - - - Volume Range - - - - - Hardware Support - - - - - Step Information - - - - - Channels - - - - - Master Volume Level - - - - - Master Volume Level Scalar - - - - - Mute - - - - - Volume Step Up - - - - - Volume Step Down - - - - - Creates a new Audio endpoint volume - - IAudioEndpointVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Audio Endpoint Volume Channel - - - - - GUID to pass to AudioEndpointVolumeCallback - - - - - Volume Level - - - - - Volume Level Scalar - - - - - Audio Endpoint Volume Channels - - - - - Channel Count - - - - - Indexer - get a specific channel - - - - - Audio Endpoint Volume Notifiaction Delegate - - Audio Volume Notification Data - - - - Audio Endpoint Volume Step Information - - - - - Step - - - - - StepCount - - - - - Audio Endpoint Volume Volume Range - - - - - Minimum Decibels - - - - - Maximum Decibels - - - - - Increment Decibels - - - - - Audio Meter Information - - - - - Peak Values - - - - - Hardware Support - - - - - Master Peak Value - - - - - Audio Meter Information Channels - - - - - Metering Channel Count - - - - - Get Peak value - - Channel index - Peak value - - - - Audio Render Client - - - - - Gets a pointer to the buffer - - Number of frames requested - Pointer to the buffer - - - - Release buffer - - Number of frames written - Buffer flags - - - - Release the COM object - - - - - AudioSessionControl object for information - regarding an audio session - - - - - Constructor. - - - - - - Dispose - - - - - Finalizer - - - - - Audio meter information of the audio session. - - - - - Simple audio volume of the audio session (for volume and mute status). - - - - - The current state of the audio session. - - - - - The name of the audio session. - - - - - the path to the icon shown in the mixer. - - - - - The session identifier of the audio session. - - - - - The session instance identifier of the audio session. - - - - - The process identifier of the audio session. - - - - - Is the session a system sounds session. - - - - - the grouping param for an audio session grouping - - - - - - For chanigng the grouping param and supplying the context of said change - - - - - - - Registers an even client for callbacks - - - - - - Unregisters an event client from receiving callbacks - - - - - - AudioSessionEvents callback implementation - - - - - Constructor. - - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - AudioSessionManager - - Designed to manage audio sessions and in particuar the - SimpleAudioVolume interface to adjust a session volume - - - - - Session created delegate - - - - - Occurs when audio session has been added (for example run another program that use audio playback). - - - - - SimpleAudioVolume object - for adjusting the volume for the user session - - - - - AudioSessionControl object - for registring for callbacks and other session information - - - - - Refresh session of current device. - - - - - Returns list of sessions of current device. - - - - - Dispose. - - - - - Finalizer. - - - - - Specifies the category of an audio stream. - - - - - Other audio stream. - - - - - Media that will only stream when the app is in the foreground. - - - - - Media that can be streamed when the app is in the background. - - - - - Real-time communications, such as VOIP or chat. - - - - - Alert sounds. - - - - - Sound effects. - - - - - Game sound effects. - - - - - Background audio for games. - - - - - Manages the AudioStreamVolume for the . - - - - - Verify that the channel index is valid. - - - - - - - Return the current stream volumes for all channels - - An array of volume levels between 0.0 and 1.0 for each channel in the audio stream. - - - - Returns the current number of channels in this audio stream. - - - - - Return the current volume for the requested channel. - - The 0 based index into the channels. - The volume level for the channel between 0.0 and 1.0. - - - - Set the volume level for each channel of the audio stream. - - An array of volume levels (between 0.0 and 1.0) one for each channel. - - A volume level MUST be supplied for reach channel in the audio stream. - - - Thrown when does not contain elements. - - - - - Sets the volume level for one channel in the audio stream. - - The 0-based index into the channels to adjust the volume of. - The volume level between 0.0 and 1.0 for this channel of the audio stream. - - - - Dispose - - - - - Release/cleanup objects during Dispose/finalization. - - True if disposing and false if being finalized. - - - - Audio Volume Notification Data - - - - - Event Context - - - - - Muted - - - - - Guid that raised the event - - - - - Master Volume - - - - - Channels - - - - - Channel Volume - - - - - Audio Volume Notification Data - - - - - - - - - - Connector - - - - - Connects this connector to a connector in another device-topology object - - - - - Retreives the type of this connector - - - - - Retreives the data flow of this connector - - - - - Disconnects this connector from it's connected connector (if connected) - - - - - Indicates whether this connector is connected to another connector - - - - - Retreives the connector this connector is connected to (if connected) - - - - - Retreives the global ID of the connector this connector is connected to (if connected) - - - - - Retreives the device ID of the audio device this connector is connected to (if connected) - - - - - Connector Type - - - - - The connector is part of a connection of unknown type. - - - - - The connector is part of a physical connection to an auxiliary device that is installed inside the system chassis - - - - - The connector is part of a physical connection to an external device. - - - - - The connector is part of a software-configured I/O connection (typically a DMA channel) between system memory and an audio hardware device on an audio adapter. - - - - - The connector is part of a permanent connection that is fixed and cannot be configured under software control. - - - - - The connector is part of a connection to a network. - - - - - The EDataFlow enumeration defines constants that indicate the direction - in which audio data flows between an audio endpoint device and an application - - - - - Audio rendering stream. - Audio data flows from the application to the audio endpoint device, which renders the stream. - - - - - Audio capture stream. Audio data flows from the audio endpoint device that captures the stream, - to the application - - - - - Audio rendering or capture stream. Audio data can flow either from the application to the audio - endpoint device, or from the audio endpoint device to the application. - - - - - Device State - - - - - DEVICE_STATE_ACTIVE - - - - - DEVICE_STATE_DISABLED - - - - - DEVICE_STATE_NOTPRESENT - - - - - DEVICE_STATE_UNPLUGGED - - - - - DEVICE_STATEMASK_ALL - - - - - Windows CoreAudio DeviceTopology - - - - - Retrieves the number of connections associated with this device-topology object - - - - - Retrieves the connector at the supplied index - - - - - Retrieves the device id of the device represented by this device-topology object - - - - - Endpoint Hardware Support - - - - - Volume - - - - - Mute - - - - - Meter - - - - - Representation of binary large object container. - - - - - Length of binary object. - - - - - Pointer to buffer storing data. - - - - - is defined in WTypes.h - - - - - Audio Client WASAPI Error Codes (HResult) - - - - - AUDCLNT_E_NOT_INITIALIZED - - - - - AUDCLNT_E_UNSUPPORTED_FORMAT - - - - - AUDCLNT_E_DEVICE_IN_USE - - - - - AUDCLNT_E_RESOURCES_INVALIDATED - - - - - Windows CoreAudio IAudioClient interface - Defined in AudioClient.h - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - Defined in AudioClient.h - - - - - Defined in AudioClient.h - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Retrieves the current state of the audio session. - - Receives the current session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the display name for the audio session. - - Receives a string that contains the display name. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display name to the current audio session. - - A string that contains the new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the path for the display icon for the audio session. - - Receives a string that specifies the fully qualified path of the file that contains the icon. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a display icon to the current session. - - A string that specifies the fully qualified path of the file that contains the new icon. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the grouping parameter of the audio session. - - Receives the grouping parameter ID. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Assigns a session to a grouping of sessions. - - The new grouping parameter ID. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Registers the client to receive notifications of session events, including changes in the session state. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Deletes a previous registration by the client to receive notifications. - - A client-implemented interface. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier for the audio session. - - Receives the session identifier. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the identifier of the audio session instance. - - Receives the identifier of a particular instance. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the process identifier of the audio session. - - Receives the process identifier of the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Indicates whether the session is a system sounds session. - - An HRESULT code indicating whether the operation succeeded of failed. - - - - Enables or disables the default stream attenuation experience (auto-ducking) provided by the system. - - A variable that enables or disables system auto-ducking. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Defines constants that indicate the current state of an audio session. - - - MSDN Reference: http://msdn.microsoft.com/en-us/library/dd370792.aspx - - - - - The audio session is inactive. - - - - - The audio session is active. - - - - - The audio session has expired. - - - - - Defines constants that indicate a reason for an audio session being disconnected. - - - MSDN Reference: Unknown - - - - - The user removed the audio endpoint device. - - - - - The Windows audio service has stopped. - - - - - The stream format changed for the device that the audio session is connected to. - - - - - The user logged off the WTS session that the audio session was running in. - - - - - The WTS session that the audio session was running in was disconnected. - - - - - The (shared-mode) audio session was disconnected to make the audio endpoint device available for an exclusive-mode connection. - - - - - Windows CoreAudio IAudioSessionControl interface - Defined in AudioPolicy.h - - - - - Notifies the client that the display name for the session has changed. - - The new display name for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the display icon for the session has changed. - - The path for the new display icon for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level or muting state of the session has changed. - - The new volume level for the audio session. - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the volume level of an audio channel in the session submix has changed. - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the grouping parameter for the session has changed. - - The new grouping parameter for the session. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the stream-activity state of the session has changed. - - The new session state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Notifies the client that the session has been disconnected. - - The reason that the audio session was disconnected. - An HRESULT code indicating whether the operation succeeded of failed. - - - - interface to receive session related events - - - - - notification of volume changes including muting of audio session - - the current volume - the current mute state, true muted, false otherwise - - - - notification of display name changed - - the current display name - - - - notification of icon path changed - - the current icon path - - - - notification of the client that the volume level of an audio channel in the session submix has changed - - The channel count. - An array of volumnes cooresponding with each channel index. - The number of the channel whose volume level changed. - - - - notification of the client that the grouping parameter for the session has changed - - >The new grouping parameter for the session. - - - - notification of the client that the stream-activity state of the session has changed - - The new session state. - - - - notification of the client that the session has been disconnected - - The reason that the audio session was disconnected. - - - - Windows CoreAudio IAudioSessionManager interface - Defined in AudioPolicy.h - - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves an audio session control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves a simple audio volume control. - - A new or existing session ID. - Audio session flags. - Receives an interface for the audio session. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IAudioSessionNotification interface - Defined in AudioPolicy.h - - - - - - - session being added - An HRESULT code indicating whether the operation succeeded of failed. - - - - Windows CoreAudio IConnector interface - Defined in devicetopology.h - - - - - Windows CoreAudio IDeviceTopology interface - Defined in devicetopology.h - - - - - defined in MMDeviceAPI.h - - - - - IMMNotificationClient - - - - - Device State Changed - - - - - Device Added - - - - - Device Removed - - - - - Default Device Changed - - - - - Property Value Changed - - - - - - - Windows CoreAudio IPart interface - Defined in devicetopology.h - - - - - Windows CoreAudio IPartsList interface - Defined in devicetopology.h - - - - - is defined in propsys.h - - - - - Windows CoreAudio ISimpleAudioVolume interface - Defined in AudioClient.h - - - - - Sets the master volume level for the audio session. - - The new volume level expressed as a normalized value between 0.0 and 1.0. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the client volume level for the audio session. - - Receives the volume level expressed as a normalized value between 0.0 and 1.0. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Sets the muting state for the audio session. - - The new muting state. - A user context value that is passed to the notification callback. - An HRESULT code indicating whether the operation succeeded of failed. - - - - Retrieves the current muting state for the audio session. - - Receives the muting state. - An HRESULT code indicating whether the operation succeeded of failed. - - - - implements IMMDeviceEnumerator - - - - - MMDevice STGM enumeration - - - - - Read-only access mode. - - - - - Write-only access mode. - - - - - Read-write access mode. - - - - - from Propidl.h. - http://msdn.microsoft.com/en-us/library/aa380072(VS.85).aspx - contains a union so we have to do an explicit layout - - - - - Value type tag. - - - - - Reserved1. - - - - - Reserved2. - - - - - Reserved3. - - - - - cVal. - - - - - bVal. - - - - - iVal. - - - - - uiVal. - - - - - lVal. - - - - - ulVal. - - - - - intVal. - - - - - uintVal. - - - - - hVal. - - - - - uhVal. - - - - - fltVal. - - - - - dblVal. - - - - - boolVal. - - - - - scode. - - - - - Date time. - - - - - Binary large object. - - - - - Pointer value. - - - - - Creates a new PropVariant containing a long value - - - - - Helper method to gets blob data - - - - - Interprets a blob as an array of structs - - - - - Gets the type of data in this PropVariant - - - - - Property value - - - - - allows freeing up memory, might turn this into a Dispose method? - - - - - Clears with a known pointer - - - - - MM Device - - - - - Initializes the device's property store. - - The storage-access mode to open store for. - Administrative client is required for Write and ReadWrite modes. - - - - Audio Client - Makes a new one each call to allow caller to manage when to dispose - n.b. should probably not be a property anymore - - - - - Audio Meter Information - - - - - Audio Endpoint Volume - - - - - AudioSessionManager instance - - - - - DeviceTopology instance - - - - - Properties - - - - - Friendly name for the endpoint - - - - - Friendly name of device - - - - - Icon path of device - - - - - Device Instance Id of Device - - - - - Device ID - - - - - Data Flow - - - - - Device State - - - - - To string - - - - - Dispose - - - - - Finalizer - - - - - Multimedia Device Collection - - - - - Device count - - - - - Get device by index - - Device index - Device at the specified index - - - - Get Enumerator - - Device enumerator - - - - MM Device Enumerator - - - - - Creates a new MM Device Enumerator - - - - - Enumerate Audio Endpoints - - Desired DataFlow - State Mask - Device Collection - - - - Get Default Endpoint - - Data Flow - Role - Device - - - - Check to see if a default audio end point exists without needing an exception. - - Data Flow - Role - True if one exists, and false if one does not exist. - - - - Get device by ID - - Device ID - Device - - - - Registers a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - Unregisters a call back for Device Events - - Object implementing IMMNotificationClient type casted as IMMNotificationClient interface - - - - - - - - Called to dispose/finalize contained objects. - - True if disposing, false if called from a finalizer. - - - - PROPERTYKEY is defined in wtypes.h - - - - - Format ID - - - - - Property ID - - - - - - - - - - - Property Keys - - - - - PKEY_DeviceInterface_FriendlyName - - - - - PKEY_AudioEndpoint_FormFactor - - - - - PKEY_AudioEndpoint_ControlPanelPageProvider - - - - - PKEY_AudioEndpoint_Association - - - - - PKEY_AudioEndpoint_PhysicalSpeakers - - - - - PKEY_AudioEndpoint_GUID - - - - - PKEY_AudioEndpoint_Disable_SysFx - - - - - PKEY_AudioEndpoint_FullRangeSpeakers - - - - - PKEY_AudioEndpoint_Supports_EventDriven_Mode - - - - - PKEY_AudioEndpoint_JackSubType - - - - - PKEY_AudioEngine_DeviceFormat - - - - - PKEY_AudioEngine_OEMFormat - - - - - PKEY _Devie_FriendlyName - - - - - PKEY _Device_IconPath - - - - - Device description property. - - - - - Id of controller device for endpoint device property. - - - - - Device interface key property. - - - - - System-supplied device instance identification string, assigned by PnP manager, persistent across system restarts. - - - - - Property Store class, only supports reading properties at the moment. - - - - - Property Count - - - - - Gets property by index - - Property index - The property - - - - Contains property guid - - Looks for a specific key - True if found - - - - Indexer by guid - - Property Key - Property or null if not found - - - - Gets property key at sepecified index - - Index - Property key - - - - Gets property value at specified index - - Index - Property value - - - - Sets property value at specified key. - - Key of property to set. - Value to write. - - - - Saves a property change. - - - - - Creates a new property store - - IPropertyStore COM interface - - - - Property Store Property - - - - - Property Key - - - - - Property Value - - - - - The ERole enumeration defines constants that indicate the role - that the system has assigned to an audio endpoint device - - - - - Games, system notification sounds, and voice commands. - - - - - Music, movies, narration, and live music recording - - - - - Voice communications (talking to another person). - - - - - Collection of sessions. - - - - - Returns session at index. - - - - - - - Number of current sessions. - - - - - Windows CoreAudio SimpleAudioVolume - - - - - Creates a new Audio endpoint volume - - ISimpleAudioVolume COM interface - - - - Dispose - - - - - Finalizer - - - - - Allows the user to adjust the volume from - 0.0 to 1.0 - - - - - Mute - - - - - Represents state of a capture device - - - - - Not recording - - - - - Beginning to record - - - - - Recording in progress - - - - - Requesting stop - - - - - Contains the name and CLSID of a DirectX Media Object - - - - - Name - - - - - CLSID - - - - - Initializes a new instance of DmoDescriptor - - - - - DirectX Media Object Enumerator - - - - - Get audio effect names - - Audio effect names - - - - Get audio encoder names - - Audio encoder names - - - - Get audio decoder names - - Audio decoder names - - - - DMO Guids for use with DMOEnum - dmoreg.h - - - - - MediaErr.h - - - - - DMO Inplace Process Flags - - - - - DMO_INPLACE_NORMAL - - - - - DMO_INPLACE_ZERO - - - - - Return value when Process is executed with IMediaObjectInPlace - - - - - Success. There is no remaining data to process. - - - - - Success. There is still data to process. - - - - - DMO Input Data Buffer Flags - - - - - None - - - - - DMO_INPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_INPUT_DATA_BUFFERF_TIME - - - - - DMO_INPUT_DATA_BUFFERF_TIMELENGTH - - - - - http://msdn.microsoft.com/en-us/library/aa929922.aspx - DMO_MEDIA_TYPE - - - - - Major type - - - - - Major type name - - - - - Subtype - - - - - Subtype name - - - - - Fixed size samples - - - - - Sample size - - - - - Format type - - - - - Format type name - - - - - Gets the structure as a Wave format (if it is one) - - - - - Sets this object up to point to a wave format - - Wave format structure - - - - DMO Output Data Buffer - - - - - Creates a new DMO Output Data Buffer structure - - Maximum buffer size - - - - Dispose - - - - - Media Buffer - - - - - Length of data in buffer - - - - - Status Flags - - - - - Timestamp - - - - - Duration - - - - - Retrives the data in this buffer - - Buffer to receive data - Offset into buffer - - - - Is more data available - If true, ProcessOuput should be called again - - - - - DMO Output Data Buffer Flags - - - - - None - - - - - DMO_OUTPUT_DATA_BUFFERF_SYNCPOINT - - - - - DMO_OUTPUT_DATA_BUFFERF_TIME - - - - - DMO_OUTPUT_DATA_BUFFERF_TIMELENGTH - - - - - DMO_OUTPUT_DATA_BUFFERF_INCOMPLETE - - - - - DMO_PARTIAL_MEDIATYPE - - - - - DMO Process Output Flags - - - - - None - - - - - DMO_PROCESS_OUTPUT_DISCARD_WHEN_NO_BUFFER - - - - - IMediaBuffer Interface - - - - - Set Length - - Length - HRESULT - - - - Get Max Length - - Max Length - HRESULT - - - - Get Buffer and Length - - Pointer to variable into which to write the Buffer Pointer - Pointer to variable into which to write the Valid Data Length - HRESULT - - - - defined in mediaobj.h - - - - - defined in mediaobj.h - - - - - defined in Medparam.h - - - - - Windows Media Resampler Props - wmcodecdsp.h - - - - - Range is 1 to 60 - - - - - Specifies the channel matrix. - - - - - Attempting to implement the COM IMediaBuffer interface as a .NET object - Not sure what will happen when I pass this to an unmanaged object - - - - - Creates a new Media Buffer - - Maximum length in bytes - - - - Dispose and free memory for buffer - - - - - Finalizer - - - - - Set length of valid data in the buffer - - length - HRESULT - - - - Gets the maximum length of the buffer - - Max length (output parameter) - HRESULT - - - - Gets buffer and / or length - - Pointer to variable into which buffer pointer should be written - Pointer to variable into which valid data length should be written - HRESULT - - - - Length of data in the media buffer - - - - - Loads data into this buffer - - Data to load - Number of bytes to load - - - - Retrieves the data in the output buffer - - buffer to retrieve into - offset within that buffer - - - - Media Object - - - - - Creates a new Media Object - - Media Object COM interface - - - - Number of input streams - - - - - Number of output streams - - - - - Gets the input media type for the specified input stream - - Input stream index - Input type index - DMO Media Type or null if there are no more input types - - - - Gets the DMO Media Output type - - The output stream - Output type index - DMO Media Type or null if no more available - - - - retrieves the media type that was set for an output stream, if any - - Output stream index - DMO Media Type or null if no more available - - - - Enumerates the supported input types - - Input stream index - Enumeration of input types - - - - Enumerates the output types - - Output stream index - Enumeration of supported output types - - - - Querys whether a specified input type is supported - - Input stream index - Media type to check - true if supports - - - - Sets the input type helper method - - Input stream index - Media type - Flags (can be used to test rather than set) - - - - Sets the input type - - Input stream index - Media Type - - - - Sets the input type to the specified Wave format - - Input stream index - Wave format - - - - Requests whether the specified Wave format is supported as an input - - Input stream index - Wave format - true if supported - - - - Helper function to make a DMO Media Type to represent a particular WaveFormat - - - - - Checks if a specified output type is supported - n.b. you may need to set the input type first - - Output stream index - Media type - True if supported - - - - Tests if the specified Wave Format is supported for output - n.b. may need to set the input type first - - Output stream index - Wave format - True if supported - - - - Helper method to call SetOutputType - - - - - Sets the output type - n.b. may need to set the input type first - - Output stream index - Media type to set - - - - Set output type to the specified wave format - n.b. may need to set input type first - - Output stream index - Wave format - - - - Get Input Size Info - - Input Stream Index - Input Size Info - - - - Get Output Size Info - - Output Stream Index - Output Size Info - - - - Process Input - - Input Stream index - Media Buffer - Flags - Timestamp - Duration - - - - Process Output - - Flags - Output buffer count - Output buffers - - - - Gives the DMO a chance to allocate any resources needed for streaming - - - - - Tells the DMO to free any resources needed for streaming - - - - - Gets maximum input latency - - input stream index - Maximum input latency as a ref-time - - - - Flushes all buffered data - - - - - Report a discontinuity on the specified input stream - - Input Stream index - - - - Is this input stream accepting data? - - Input Stream index - true if accepting data - - - - Experimental code, not currently being called - Not sure if it is necessary anyway - - - - - Media Object InPlace - - - - - Creates a new Media Object InPlace - - Media Object InPlace COM Interface - - - - Processes a block of data. - The application supplies a pointer to a block of input data. The DMO processes the data in place. - - Size of the data, in bytes. - offset into buffer - In/Out Data Buffer - Start time of the data. - DmoInplaceProcessFlags - Return value when Process is executed with IMediaObjectInPlace - - - - Creates a copy of the DMO in its current state. - - Copyed MediaObjectInPlace - - - - Retrieves the latency introduced by this DMO. - - The latency, in 100-nanosecond units - - - - Get Media Object - - Media Object - - - - Dispose code - - - - - Media Object Size Info - - - - - Minimum Buffer Size, in bytes - - - - - Max Lookahead - - - - - Alignment - - - - - Media Object Size Info - - - - - ToString - - - - - MP_PARAMINFO - - - - - MP_TYPE - - - - - MPT_INT - - - - - MPT_FLOAT - - - - - MPT_BOOL - - - - - MPT_ENUM - - - - - MPT_MAX - - - - - MP_CURVE_TYPE - - - - - uuids.h, ksuuids.h - - - - - From wmcodecsdp.h - Implements: - - IMediaObject - - IMFTransform (Media foundation - we will leave this for now as there is loads of MF stuff) - - IPropertyStore - - IWMResamplerProps - Can resample PCM or IEEE - - - - - DMO Resampler - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - implements IMediaObject (DirectX Media Object) - implements IMFTransform (Media Foundation Transform) - On Windows XP, it is always an MM (if present at all) - - - - - Windows Media MP3 Decoder (as a DMO) - WORK IN PROGRESS - DO NOT USE! - - - - - Creates a new Resampler based on the DMO Resampler - - - - - Media Object - - - - - Dispose code - experimental at the moment - Was added trying to track down why Resampler crashes NUnit - This code not currently being called by ResamplerDmoStream - - - - - BiQuad filter - - - - - Passes a single sample through the filter - - Input sample - Output sample - - - - Set this up as a low pass filter - - Sample Rate - Cut-off Frequency - Bandwidth - - - - Set this up as a peaking EQ - - Sample Rate - Centre Frequency - Bandwidth (Q) - Gain in decibels - - - - Set this as a high pass filter - - - - - Create a low pass filter - - - - - Create a High pass filter - - - - - Create a bandpass filter with constant skirt gain - - - - - Create a bandpass filter with constant peak gain - - - - - Creates a notch filter - - - - - Creaes an all pass filter - - - - - Create a Peaking EQ - - - - - H(s) = A * (s^2 + (sqrt(A)/Q)*s + A)/(A*s^2 + (sqrt(A)/Q)*s + 1) - - - - a "shelf slope" parameter (for shelving EQ only). - When S = 1, the shelf slope is as steep as it can be and remain monotonically - increasing or decreasing gain with frequency. The shelf slope, in dB/octave, - remains proportional to S for all other values for a fixed f0/Fs and dBgain. - Gain in decibels - - - - H(s) = A * (A*s^2 + (sqrt(A)/Q)*s + 1)/(s^2 + (sqrt(A)/Q)*s + A) - - - - - - - - - - Type to represent complex number - - - - - Real Part - - - - - Imaginary Part - - - - - Envelope generator (ADSR) - - - - - Envelope State - - - - - Idle - - - - - Attack - - - - - Decay - - - - - Sustain - - - - - Release - - - - - Creates and Initializes an Envelope Generator - - - - - Attack Rate (seconds * SamplesPerSecond) - - - - - Decay Rate (seconds * SamplesPerSecond) - - - - - Release Rate (seconds * SamplesPerSecond) - - - - - Sustain Level (1 = 100%) - - - - - Sets the attack curve - - - - - Sets the decay release curve - - - - - Read the next volume multiplier from the envelope generator - - A volume multiplier - - - - Trigger the gate - - If true, enter attack phase, if false enter release phase (unless already idle) - - - - Current envelope state - - - - - Reset to idle state - - - - - Get the current output level - - - - - Summary description for FastFourierTransform. - - - - - This computes an in-place complex-to-complex FFT - x and y are the real and imaginary arrays of 2^m points. - - - - - Applies a Hamming Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hamming window - - - - Applies a Hann Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Hann window - - - - Applies a Blackman-Harris Window - - Index into frame - Frame size (e.g. 1024) - Multiplier for Blackmann-Harris window - - - - Summary description for ImpulseResponseConvolution. - - - - - A very simple mono convolution algorithm - - - This will be very slow - - - - - This is actually a downwards normalize for data that will clip - - - - - SMB Pitch Shifter - - - - - Pitch Shift - - - - - Pitch Shift - - - - - Short Time Fourier Transform - - - - - Fully managed resampler, based on Cockos WDL Resampler - - - - - Creates a new Resampler - - - - - sets the mode - if sinc set, it overrides interp or filtercnt - - - - - Sets the filter parameters - used for filtercnt>0 but not sinc - - - - - Set feed mode - - if true, that means the first parameter to ResamplePrepare will specify however much input you have, not how much you want - - - - Reset - - - - - Prepare - note that it is safe to call ResamplePrepare without calling ResampleOut (the next call of ResamplePrepare will function as normal) - nb inbuffer was WDL_ResampleSample **, returning a place to put the in buffer, so we return a buffer and offset - - req_samples is output samples desired if !wantInputDriven, or if wantInputDriven is input samples that we have - - - - returns number of samples desired (put these into *inbuffer) - - - - Channel Mode - - - - - Stereo - - - - - Joint Stereo - - - - - Dual Channel - - - - - Mono - - - - - An ID3v2 Tag - - - - - Reads an ID3v2 tag from a stream - - - - - Creates a new ID3v2 tag from a collection of key-value pairs. - - A collection of key-value pairs containing the tags to include in the ID3v2 tag. - A new ID3v2 tag - - - - Convert the frame size to a byte array. - - The frame body size. - - - - - Creates an ID3v2 frame for the given key-value pair. - - - - - - - - Gets the Id3v2 Header size. The size is encoded so that only 7 bits per byte are actually used. - - - - - - - Creates the Id3v2 tag header and returns is as a byte array. - - The Id3v2 frames that will be included in the file. This is used to calculate the ID3v2 tag size. - - - - - Creates the Id3v2 tag for the given key-value pairs and returns it in the a stream. - - - - - - - Raw data from this tag - - - - - Interface for MP3 frame by frame decoder - - - - - Decompress a single MP3 frame - - Frame to decompress - Output buffer - Offset within output buffer - Bytes written to output buffer - - - - Tell the decoder that we have repositioned - - - - - PCM format that we are converting into - - - - - Represents an MP3 Frame - - - - - Reads an MP3 frame from a stream - - input stream - A valid MP3 frame, or null if none found - - - Reads an MP3Frame from a stream - http://mpgedit.org/mpgedit/mpeg_format/mpeghdr.htm has some good info - also see http://www.codeproject.com/KB/audio-video/mpegaudioinfo.aspx - - A valid MP3 frame, or null if none found - - - - Constructs an MP3 frame - - - - - checks if the four bytes represent a valid header, - if they are, will parse the values into Mp3Frame - - - - - Sample rate of this frame - - - - - Frame length in bytes - - - - - Bit Rate - - - - - Raw frame data (includes header bytes) - - - - - MPEG Version - - - - - MPEG Layer - - - - - Channel Mode - - - - - The number of samples in this frame - - - - - The channel extension bits - - - - - The bitrate index (directly from the header) - - - - - Whether the Copyright bit is set - - - - - Whether a CRC is present - - - - - Not part of the MP3 frame itself - indicates where in the stream we found this header - - - - - MPEG Layer flags - - - - - Reserved - - - - - Layer 3 - - - - - Layer 2 - - - - - Layer 1 - - - - - MPEG Version Flags - - - - - Version 2.5 - - - - - Reserved - - - - - Version 2 - - - - - Version 1 - - - - - Represents a Xing VBR header - - - - - Load Xing Header - - Frame - Xing Header - - - - Sees if a frame contains a Xing header - - - - - Number of frames - - - - - Number of bytes - - - - - VBR Scale property - - - - - The MP3 frame - - - - - Wave Callback Strategy - - - - - Use a function - - - - - Create a new window (should only be done if on GUI thread) - - - - - Use an existing window handle - - - - - Use an event handle - - - - - WaveHeader interop structure (WAVEHDR) - http://msdn.microsoft.com/en-us/library/dd743837%28VS.85%29.aspx - - - - pointer to locked data buffer (lpData) - - - length of data buffer (dwBufferLength) - - - used for input only (dwBytesRecorded) - - - for client's use (dwUser) - - - assorted flags (dwFlags) - - - loop control counter (dwLoops) - - - PWaveHdr, reserved for driver (lpNext) - - - reserved for driver - - - - Wave Header Flags enumeration - - - - - WHDR_BEGINLOOP - This buffer is the first buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_DONE - Set by the device driver to indicate that it is finished with the buffer and is returning it to the application. - - - - - WHDR_ENDLOOP - This buffer is the last buffer in a loop. This flag is used only with output buffers. - - - - - WHDR_INQUEUE - Set by Windows to indicate that the buffer is queued for playback. - - - - - WHDR_PREPARED - Set by Windows to indicate that the buffer has been prepared with the waveInPrepareHeader or waveOutPrepareHeader function. - - - - - WaveInCapabilities structure (based on WAVEINCAPS2 from mmsystem.h) - http://msdn.microsoft.com/en-us/library/ms713726(VS.85).aspx - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Number of channels supported - - - - - The product name - - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - Event Args for WaveInStream event - - - - - Creates new WaveInEventArgs - - - - - Buffer containing recorded data. Note that it might not be completely - full. - - - - - The number of recorded bytes in Buffer. - - - - - MME Wave function interop - - - - - CALLBACK_NULL - No callback - - - - - CALLBACK_FUNCTION - dwCallback is a FARPROC - - - - - CALLBACK_EVENT - dwCallback is an EVENT handle - - - - - CALLBACK_WINDOW - dwCallback is a HWND - - - - - CALLBACK_THREAD - callback is a thread ID - - - - - WIM_OPEN - - - - - WIM_CLOSE - - - - - WIM_DATA - - - - - WOM_CLOSE - - - - - WOM_DONE - - - - - WOM_OPEN - - - - - WaveOutCapabilities structure (based on WAVEOUTCAPS2 from mmsystem.h) - http://msdn.microsoft.com/library/default.asp?url=/library/en-us/multimed/htm/_win32_waveoutcaps_str.asp - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name (szPname) - - - - - Supported formats (bit flags) dwFormats - - - - - Supported channels (1 for mono 2 for stereo) (wChannels) - Seems to be set to -1 on a lot of devices - - - - - wReserved1 - - - - - Optional functionality supported by the device - - - - - Number of channels supported - - - - - Whether playback control is supported - - - - - The product name - - - - - Checks to see if a given SupportedWaveFormat is supported - - The SupportedWaveFormat - true if supported - - - - The device name Guid (if provided) - - - - - The product name Guid (if provided) - - - - - The manufacturer guid (if provided) - - - - - Supported wave formats for WaveOutCapabilities - - - - - 11.025 kHz, Mono, 8-bit - - - - - 11.025 kHz, Stereo, 8-bit - - - - - 11.025 kHz, Mono, 16-bit - - - - - 11.025 kHz, Stereo, 16-bit - - - - - 22.05 kHz, Mono, 8-bit - - - - - 22.05 kHz, Stereo, 8-bit - - - - - 22.05 kHz, Mono, 16-bit - - - - - 22.05 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 44.1 kHz, Mono, 8-bit - - - - - 44.1 kHz, Stereo, 8-bit - - - - - 44.1 kHz, Mono, 16-bit - - - - - 44.1 kHz, Stereo, 16-bit - - - - - 48 kHz, Mono, 8-bit - - - - - 48 kHz, Stereo, 8-bit - - - - - 48 kHz, Mono, 16-bit - - - - - 48 kHz, Stereo, 16-bit - - - - - 96 kHz, Mono, 8-bit - - - - - 96 kHz, Stereo, 8-bit - - - - - 96 kHz, Mono, 16-bit - - - - - 96 kHz, Stereo, 16-bit - - - - - Flags indicating what features this WaveOut device supports - - - - supports pitch control (WAVECAPS_PITCH) - - - supports playback rate control (WAVECAPS_PLAYBACKRATE) - - - supports volume control (WAVECAPS_VOLUME) - - - supports separate left-right volume control (WAVECAPS_LRVOLUME) - - - (WAVECAPS_SYNC) - - - (WAVECAPS_SAMPLEACCURATE) - - - - Sample provider interface to make WaveChannel32 extensible - Still a bit ugly, hence internal at the moment - and might even make these into - bit depth converting WaveProviders - - - - - ADSR sample provider allowing you to specify attack, decay, sustain and release values - - - - - Creates a new AdsrSampleProvider with default values - - - - - Attack time in seconds - - - - - Release time in seconds - - - - - Reads audio from this sample provider - - - - - Enters the Release phase - - - - - The output WaveFormat - - - - - Sample Provider to concatenate multiple sample providers together - - - - - Creates a new ConcatenatingSampleProvider - - The source providers to play one after the other. Must all share the same sample rate and channel count - - - - The WaveFormat of this Sample Provider - - - - - Read Samples from this sample provider - - - - - Sample Provider to allow fading in and out - - - - - Creates a new FadeInOutSampleProvider - - The source stream with the audio to be faded in or out - If true, we start faded out - - - - Requests that a fade-in begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Requests that a fade-out begins (will start on the next call to Read) - - Duration of fade in milliseconds - - - - Reads samples from this sample provider - - Buffer to read into - Offset within buffer to write to - Number of samples desired - Number of samples read - - - - WaveFormat of this SampleProvider - - - - - Simple SampleProvider that passes through audio unchanged and raises - an event every n samples with the maximum sample value from the period - for metering purposes - - - - - Number of Samples per notification - - - - - Raised periodically to inform the user of the max volume - - - - - Initialises a new instance of MeteringSampleProvider that raises 10 stream volume - events per second - - Source sample provider - - - - Initialises a new instance of MeteringSampleProvider - - source sampler provider - Number of samples between notifications - - - - The WaveFormat of this sample provider - - - - - Reads samples from this Sample Provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Event args for aggregated stream volume - - - - - Max sample values array (one for each channel) - - - - - A sample provider mixer, allowing inputs to be added and removed - - - - - Creates a new MixingSampleProvider, with no inputs, but a specified WaveFormat - - The WaveFormat of this mixer. All inputs must be in this format - - - - Creates a new MixingSampleProvider, based on the given inputs - - Mixer inputs - must all have the same waveformat, and must - all be of the same WaveFormat. There must be at least one input - - - - Returns the mixer inputs (read-only - use AddMixerInput to add an input - - - - - When set to true, the Read method always returns the number - of samples requested, even if there are no inputs, or if the - current inputs reach their end. Setting this to true effectively - makes this a never-ending sample provider, so take care if you plan - to write it out to a file. - - - - - Adds a WaveProvider as a Mixer input. - Must be PCM or IEEE float already - - IWaveProvider mixer input - - - - Adds a new mixer input - - Mixer input - - - - Raised when a mixer input has been removed because it has ended - - - - - Removes a mixer input - - Mixer input to remove - - - - Removes all mixer inputs - - - - - The output WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - SampleProvider event args - - - - - Constructs a new SampleProviderEventArgs - - - - - The Sample Provider - - - - - No nonsense mono to stereo provider, no volume adjustment, - just copies input to left and right. - - - - - Initializes a new instance of MonoToStereoSampleProvider - - Source sample provider - - - - WaveFormat of this provider - - - - - Reads samples from this provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Multiplier for left channel (default is 1.0) - - - - - Multiplier for right channel (default is 1.0) - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing sample provider, allowing re-patching of input channels to different - output channels - - Input sample providers. Must all be of the same sample rate, but can have any number of channels - Desired number of output channels. - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads samples from this sample provider - - Buffer to be filled with sample data - Offset into buffer to start writing to, usually 0 - Number of samples required - Number of samples read - - - - The output WaveFormat for this SampleProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Simple class that raises an event on every sample - - - - - Initializes a new instance of NotifyingSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Sample notifier - - - - - Allows you to: - 1. insert a pre-delay of silence before the source begins - 2. skip over a certain amount of the beginning of the source - 3. only play a set amount from the source - 4. insert silence at the end after the source is complete - - - - - Number of samples of silence to insert before playing source - - - - - Amount of silence to insert before playing - - - - - Number of samples in source to discard - - - - - Amount of audio to skip over from the source before beginning playback - - - - - Number of samples to read from source (if 0, then read it all) - - - - - Amount of audio to take from the source (TimeSpan.Zero means play to end) - - - - - Number of samples of silence to insert after playing source - - - - - Amount of silence to insert after playing source - - - - - Creates a new instance of offsetSampleProvider - - The Source Sample Provider to read from - - - - The WaveFormat of this SampleProvider - - - - - Reads from this sample provider - - Sample buffer - Offset within sample buffer to read to - Number of samples required - Number of samples read - - - - Converts a mono sample provider to stereo, with a customisable pan strategy - - - - - Initialises a new instance of the PanningSampleProvider - - Source sample provider, must be mono - - - - Pan value, must be between -1 (left) and 1 (right) - - - - - The pan strategy currently in use - - - - - The WaveFormat of this sample provider - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Pair of floating point values, representing samples or multipliers - - - - - Left value - - - - - Right value - - - - - Required Interface for a Panning Strategy - - - - - Gets the left and right multipliers for a given pan value - - Pan value from -1 to 1 - Left and right multipliers in a stereo sample pair - - - - Simplistic "balance" control - treating the mono input as if it was stereo - In the centre, both channels full volume. Opposite channel decays linearly - as balance is turned to to one side - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Square Root Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Sinus Pan, thanks to Yuval Naveh - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Linear Pan - - - - - Gets the left and right channel multipliers for this pan value - - Pan value, between -1 and 1 - Left and right multipliers - - - - Converts an IWaveProvider containing 16 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm16BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Samples required - Number of samples read - - - - Converts an IWaveProvider containing 24 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm24BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 32 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm32BitToSampleProvider - - Source Wave Provider - - - - Reads floating point samples from this sample provider - - sample buffer - offset within sample buffer to write to - number of samples required - number of samples provided - - - - Converts an IWaveProvider containing 8 bit PCM to an - ISampleProvider - - - - - Initialises a new instance of Pcm8BitToSampleProvider - - Source wave provider - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples to read - Number of samples read - - - - Utility class that takes an IWaveProvider input at any bit depth - and exposes it as an ISampleProvider. Can turn mono inputs into stereo, - and allows adjusting of volume - (The eventual successor to WaveChannel32) - This class also serves as an example of how you can link together several simple - Sample Providers to form a more useful class. - - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - - - - Initialises a new instance of SampleChannel - - Source wave provider, must be PCM or IEEE - force mono inputs to become stereo - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - The WaveFormat of this Sample Provider - - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Raised periodically to inform the user of the max volume - (before the volume meter) - - - - - Helper base class for classes converting to ISampleProvider - - - - - Source Wave Provider - - - - - Source buffer (to avoid constantly creating small buffers during playback) - - - - - Initialises a new instance of SampleProviderConverterBase - - Source Wave provider - - - - Wave format of this wave provider - - - - - Reads samples from the source wave provider - - Sample buffer - Offset into sample buffer - Number of samples required - Number of samples read - - - - Ensure the source buffer exists and is big enough - - Bytes required - - - - Utility class for converting to SampleProvider - - - - - Helper function to go from IWaveProvider to a SampleProvider - Must already be PCM or IEEE float - - The WaveProvider to convert - A sample provider - - - - Helper class for when you need to convert back to an IWaveProvider from - an ISampleProvider. Keeps it as IEEE float - - - - - Initializes a new instance of the WaveProviderFloatToWaveProvider class - - Source wave provider - - - - Reads from this provider - - - - - The waveformat of this WaveProvider (same as the source) - - - - - Converts a sample provider to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts a sample provider to 24 bit PCM, optionally clipping and adjusting volume along the way - - - - - Converts from an ISampleProvider (IEEE float) to a 16 bit PCM IWaveProvider. - Number of channels and sample rate remain unchanged. - - The input source provider - - - - Reads bytes from this wave stream, clipping if necessary - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - The Format of this IWaveProvider - - - - - - Volume of this channel. 1.0 = full scale, 0.0 to mute - - - - - Signal Generator - Sin, Square, Triangle, SawTooth, White Noise, Pink Noise, Sweep. - - - Posibility to change ISampleProvider - Example : - --------- - WaveOut _waveOutGene = new WaveOut(); - WaveGenerator wg = new SignalGenerator(); - wg.Type = ... - wg.Frequency = ... - wg ... - _waveOutGene.Init(wg); - _waveOutGene.Play(); - - - - - Initializes a new instance for the Generator (Default :: 44.1Khz, 2 channels, Sinus, Frequency = 440, Gain = 1) - - - - - Initializes a new instance for the Generator (UserDef SampleRate & Channels) - - Desired sample rate - Number of channels - - - - The waveformat of this WaveProvider (same as the source) - - - - - Frequency for the Generator. (20.0 - 20000.0 Hz) - Sin, Square, Triangle, SawTooth, Sweep (Start Frequency). - - - - - Return Log of Frequency Start (Read only) - - - - - End Frequency for the Sweep Generator. (Start Frequency in Frequency) - - - - - Return Log of Frequency End (Read only) - - - - - Gain for the Generator. (0.0 to 1.0) - - - - - Channel PhaseReverse - - - - - Type of Generator. - - - - - Length Seconds for the Sweep Generator. - - - - - Reads from this provider. - - - - - Private :: Random for WhiteNoise & Pink Noise (Value form -1 to 1) - - Random value from -1 to +1 - - - - Signal Generator type - - - - - Pink noise - - - - - White noise - - - - - Sweep - - - - - Sine wave - - - - - Square wave - - - - - Triangle Wave - - - - - Sawtooth wave - - - - - Author: Freefall - Date: 05.08.16 - Based on: the port of Stephan M. Bernsee´s pitch shifting class - Port site: https://sites.google.com/site/mikescoderama/pitch-shifting - Test application and github site: https://github.com/Freefall63/NAudio-Pitchshifter - - NOTE: I strongly advice to add a Limiter for post-processing. - For my needs the FastAttackCompressor1175 provides acceptable results: - https://github.com/Jiyuu/SkypeFX/blob/master/JSNet/FastAttackCompressor1175.cs - - UPDATE: Added a simple Limiter based on the pydirac implementation. - https://github.com/echonest/remix/blob/master/external/pydirac225/source/Dirac_LE.cpp - - - - - - Creates a new SMB Pitch Shifting Sample Provider with default settings - - Source provider - - - - Creates a new SMB Pitch Shifting Sample Provider with custom settings - - Source provider - FFT Size (any power of two <= 4096: 4096, 2048, 1024, 512, ...) - Oversampling (number of overlapping windows) - Initial pitch (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - Read from this sample provider - - - - - WaveFormat - - - - - Pitch Factor (0.5f = octave down, 1.0f = normal, 2.0f = octave up) - - - - - Takes a stereo input and turns it to mono - - - - - Creates a new mono ISampleProvider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this SampleProvider - - - - - Very simple sample provider supporting adjustable gain - - - - - Initializes a new instance of VolumeSampleProvider - - Source Sample Provider - - - - WaveFormat - - - - - Reads samples from this sample provider - - Sample buffer - Offset into sample buffer - Number of samples desired - Number of samples read - - - - Allows adjusting the volume, 1.0f = full volume - - - - - Helper class turning an already 32 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Helper class turning an already 64 bit floating point IWaveProvider - into an ISampleProvider - hopefully not needed for most applications - - - - - Initializes a new instance of the WaveToSampleProvider class - - Source wave provider, must be IEEE float - - - - Reads from this provider - - - - - Fully managed resampling sample provider, based on the WDL Resampler - - - - - Constructs a new resampler - - Source to resample - Desired output sample rate - - - - Reads from this sample provider - - - - - Output WaveFormat - - - - - Useful extension methods to make switching between WaveAndSampleProvider easier - - - - - Converts a WaveProvider into a SampleProvider (only works for PCM) - - WaveProvider to convert - - - - - Turns WaveFormatExtensible into a standard waveformat if possible - - Input wave format - A standard PCM or IEEE waveformat, or the original waveformat - - - - Converts a ISampleProvider to a IWaveProvider but still 32 bit float - - SampleProvider to convert - An IWaveProvider - - - - Converts a ISampleProvider to a IWaveProvider but and convert to 16 bit - - SampleProvider to convert - A 16 bit IWaveProvider - - - - Concatenates one Sample Provider on the end of another - - The sample provider to play first - The sample provider to play next - A single sampleprovider to play one after the other - - - - Concatenates one Sample Provider on the end of another with silence inserted - - The sample provider to play first - Silence duration to insert between the two - The sample provider to play next - A single sample provider - - - - Skips over a specified amount of time (by consuming source stream) - - Source sample provider - Duration to skip over - A sample provider that skips over the specified amount of time - - - - Takes a specified amount of time from the source stream - - Source sample provider - Duration to take - A sample provider that reads up to the specified amount of time - - - - Converts a Stereo Sample Provider to mono, allowing mixing of channel volume - - Stereo Source Provider - Amount of left channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - Amount of right channel to mix in (0 = mute, 1 = full, 0.5 for mixing half from each channel) - A mono SampleProvider - - - - Converts a Mono ISampleProvider to stereo - - Mono Source Provider - Amount to mix to left channel (1.0 is full volume) - Amount to mix to right channel (1.0 is full volume) - - - - - Microsoft ADPCM - See http://icculus.org/SDL_sound/downloads/external_documentation/wavecomp.htm - - - - - Empty constructor needed for marshalling from a pointer - - - - - Samples per block - - - - - Number of coefficients - - - - - Coefficients - - - - - Microsoft ADPCM - - Sample Rate - Channels - - - - Serializes this wave format - - Binary writer - - - - String Description of this WaveFormat - - - - - GSM 610 - - - - - Creates a GSM 610 WaveFormat - For now hardcoded to 13kbps - - - - - Samples per block - - - - - Writes this structure to a BinaryWriter - - - - - IMA/DVI ADPCM Wave Format - Work in progress - - - - - parameterless constructor for Marshalling - - - - - Creates a new IMA / DVI ADPCM Wave Format - - Sample Rate - Number of channels - Bits Per Sample - - - - MP3 WaveFormat, MPEGLAYER3WAVEFORMAT from mmreg.h - - - - - Wave format ID (wID) - - - - - Padding flags (fdwFlags) - - - - - Block Size (nBlockSize) - - - - - Frames per block (nFramesPerBlock) - - - - - Codec Delay (nCodecDelay) - - - - - Creates a new MP3 WaveFormat - - - - - Wave Format Padding Flags - - - - - MPEGLAYER3_FLAG_PADDING_ISO - - - - - MPEGLAYER3_FLAG_PADDING_ON - - - - - MPEGLAYER3_FLAG_PADDING_OFF - - - - - Wave Format ID - - - - MPEGLAYER3_ID_UNKNOWN - - - MPEGLAYER3_ID_MPEG - - - MPEGLAYER3_ID_CONSTANTFRAMESIZE - - - - DSP Group TrueSpeech - - - - - DSP Group TrueSpeech WaveFormat - - - - - Writes this structure to a BinaryWriter - - - - - Represents a Wave file format - - - - format type - - - number of channels - - - sample rate - - - for buffer estimation - - - block size of data - - - number of bits per sample of mono data - - - number of following bytes - - - - Creates a new PCM 44.1Khz stereo 16 bit format - - - - - Creates a new 16 bit wave format with the specified sample - rate and channel count - - Sample Rate - Number of channels - - - - Gets the size of a wave buffer equivalent to the latency in milliseconds. - - The milliseconds. - - - - - Creates a WaveFormat with custom members - - The encoding - Sample Rate - Number of channels - Average Bytes Per Second - Block Align - Bits Per Sample - - - - - Creates an A-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a Mu-law wave format - - Sample Rate - Number of Channels - Wave Format - - - - Creates a new PCM format with the specified sample rate, bit depth and channels - - - - - Creates a new 32 bit IEEE floating point wave format - - sample rate - number of channels - - - - Helper function to retrieve a WaveFormat structure from a pointer - - WaveFormat structure - - - - - Helper function to marshal WaveFormat to an IntPtr - - WaveFormat - IntPtr to WaveFormat structure (needs to be freed by callee) - - - - Reads in a WaveFormat (with extra data) from a fmt chunk (chunk identifier and - length should already have been read) - - Binary reader - Format chunk length - A WaveFormatExtraData - - - - Reads a new WaveFormat object from a stream - - A binary reader that wraps the stream - - - - Reports this WaveFormat as a string - - String describing the wave format - - - - Compares with another WaveFormat object - - Object to compare to - True if the objects are the same - - - - Provides a Hashcode for this WaveFormat - - A hashcode - - - - Returns the encoding type used - - - - - Writes this WaveFormat object to a stream - - the output stream - - - - Returns the number of channels (1=mono,2=stereo etc) - - - - - Returns the sample rate (samples per second) - - - - - Returns the average number of bytes used per second - - - - - Returns the block alignment - - - - - Returns the number of bits per sample (usually 16 or 32, sometimes 24 or 8) - Can be 0 for some codecs - - - - - Returns the number of extra bytes used by this waveformat. Often 0, - except for compressed formats which store extra data after the WAVEFORMATEX header - - - - - Summary description for WaveFormatEncoding. - - - - WAVE_FORMAT_UNKNOWN, Microsoft Corporation - - - WAVE_FORMAT_PCM Microsoft Corporation - - - WAVE_FORMAT_ADPCM Microsoft Corporation - - - WAVE_FORMAT_IEEE_FLOAT Microsoft Corporation - - - WAVE_FORMAT_VSELP Compaq Computer Corp. - - - WAVE_FORMAT_IBM_CVSD IBM Corporation - - - WAVE_FORMAT_ALAW Microsoft Corporation - - - WAVE_FORMAT_MULAW Microsoft Corporation - - - WAVE_FORMAT_DTS Microsoft Corporation - - - WAVE_FORMAT_DRM Microsoft Corporation - - - WAVE_FORMAT_WMAVOICE9 - - - WAVE_FORMAT_OKI_ADPCM OKI - - - WAVE_FORMAT_DVI_ADPCM Intel Corporation - - - WAVE_FORMAT_IMA_ADPCM Intel Corporation - - - WAVE_FORMAT_MEDIASPACE_ADPCM Videologic - - - WAVE_FORMAT_SIERRA_ADPCM Sierra Semiconductor Corp - - - WAVE_FORMAT_G723_ADPCM Antex Electronics Corporation - - - WAVE_FORMAT_DIGISTD DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIFIX DSP Solutions, Inc. - - - WAVE_FORMAT_DIALOGIC_OKI_ADPCM Dialogic Corporation - - - WAVE_FORMAT_MEDIAVISION_ADPCM Media Vision, Inc. - - - WAVE_FORMAT_CU_CODEC Hewlett-Packard Company - - - WAVE_FORMAT_YAMAHA_ADPCM Yamaha Corporation of America - - - WAVE_FORMAT_SONARC Speech Compression - - - WAVE_FORMAT_DSPGROUP_TRUESPEECH DSP Group, Inc - - - WAVE_FORMAT_ECHOSC1 Echo Speech Corporation - - - WAVE_FORMAT_AUDIOFILE_AF36, Virtual Music, Inc. - - - WAVE_FORMAT_APTX Audio Processing Technology - - - WAVE_FORMAT_AUDIOFILE_AF10, Virtual Music, Inc. - - - WAVE_FORMAT_PROSODY_1612, Aculab plc - - - WAVE_FORMAT_LRC, Merging Technologies S.A. - - - WAVE_FORMAT_DOLBY_AC2, Dolby Laboratories - - - WAVE_FORMAT_GSM610, Microsoft Corporation - - - WAVE_FORMAT_MSNAUDIO, Microsoft Corporation - - - WAVE_FORMAT_ANTEX_ADPCME, Antex Electronics Corporation - - - WAVE_FORMAT_CONTROL_RES_VQLPC, Control Resources Limited - - - WAVE_FORMAT_DIGIREAL, DSP Solutions, Inc. - - - WAVE_FORMAT_DIGIADPCM, DSP Solutions, Inc. - - - WAVE_FORMAT_CONTROL_RES_CR10, Control Resources Limited - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_MPEG, Microsoft Corporation - - - - - - - - - WAVE_FORMAT_MPEGLAYER3, ISO/MPEG Layer3 Format Tag - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - WAVE_FORMAT_GSM - - - WAVE_FORMAT_G729 - - - WAVE_FORMAT_G723 - - - WAVE_FORMAT_ACELP - - - - WAVE_FORMAT_RAW_AAC1 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Windows Media Audio, WAVE_FORMAT_WMAUDIO2, Microsoft Corporation - - - - - Windows Media Audio Professional WAVE_FORMAT_WMAUDIO3, Microsoft Corporation - - - - - Windows Media Audio Lossless, WAVE_FORMAT_WMAUDIO_LOSSLESS - - - - - Windows Media Audio Professional over SPDIF WAVE_FORMAT_WMASPDIF (0x0164) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Advanced Audio Coding (AAC) audio in Audio Data Transport Stream (ADTS) format. - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_ADTS_AAC. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral band replication (SBR) or parametric stereo (PS) tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - - Source wmCodec.h - - - - MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - The format block is a WAVEFORMATEX structure with wFormatTag equal to WAVE_FORMAT_MPEG_LOAS. - - - The WAVEFORMATEX structure specifies the core AAC-LC sample rate and number of channels, - prior to applying spectral SBR or PS tools, if present. - No additional data is required after the WAVEFORMATEX structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - NOKIA_MPEG_ADTS_AAC - Source wmCodec.h - - - NOKIA_MPEG_RAW_AAC - Source wmCodec.h - - - VODAFONE_MPEG_ADTS_AAC - Source wmCodec.h - - - VODAFONE_MPEG_RAW_AAC - Source wmCodec.h - - - - High-Efficiency Advanced Audio Coding (HE-AAC) stream. - The format block is an HEAACWAVEFORMAT structure. - - http://msdn.microsoft.com/en-us/library/dd317599%28VS.85%29.aspx - - - WAVE_FORMAT_DVM - - - WAVE_FORMAT_VORBIS1 "Og" Original stream compatible - - - WAVE_FORMAT_VORBIS2 "Pg" Have independent header - - - WAVE_FORMAT_VORBIS3 "Qg" Have no codebook header - - - WAVE_FORMAT_VORBIS1P "og" Original stream compatible - - - WAVE_FORMAT_VORBIS2P "pg" Have independent headere - - - WAVE_FORMAT_VORBIS3P "qg" Have no codebook header - - - WAVE_FORMAT_EXTENSIBLE - - - - - - - WaveFormatExtensible - http://www.microsoft.com/whdc/device/audio/multichaud.mspx - - - - - Parameterless constructor for marshalling - - - - - Creates a new WaveFormatExtensible for PCM or IEEE - - - - - WaveFormatExtensible for PCM or floating point can be awkward to work with - This creates a regular WaveFormat structure representing the same audio format - Returns the WaveFormat unchanged for non PCM or IEEE float - - - - - - SubFormat (may be one of AudioMediaSubtypes) - - - - - Serialize - - - - - - String representation - - - - - This class used for marshalling from unmanaged code - - - - - Allows the extra data to be read - - - - - parameterless constructor for marshalling - - - - - Reads this structure from a BinaryReader - - - - - Writes this structure to a BinaryWriter - - - - - The WMA wave format. - May not be much use because WMA codec is a DirectShow DMO not an ACM - - - - - Generic interface for wave recording - - - - - Recording WaveFormat - - - - - Start Recording - - - - - Stop Recording - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - Audio Capture using Wasapi - See http://msdn.microsoft.com/en-us/library/dd370800%28VS.85%29.aspx - - - - - Indicates recorded data is available - - - - - Indicates that all recorded data has now been received. - - - - - The effective latency in milliseconds - - - - - Initialises a new instance of the WASAPI capture class - - - - - Initialises a new instance of the WASAPI capture class - - Capture device to use - - - - Recording wave format - - - - - Way of enumerating all the audio capture devices available on the system - - - - - - Gets the default audio capture device - - The default audio capture device - - - - Initializes the capture device. Must be called on the UI (STA) thread. - If not called manually then StartRecording() will call it internally. - - - - - To allow overrides to specify different flags (e.g. loopback) - - - - - Start Recording - - - - - Stop Recording - - - - - Dispose - - - - - This class writes audio data to a .aif file on disk - - - - - Creates an Aiff file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Aiff File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - AiffFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new AiffFileWriter - - The filename to write to - The Wave Format of the output data - - - - The aiff file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this aiff file - - - - - Returns false: Cannot read from a AiffFileWriter - - - - - Returns true: Can write to a AiffFileWriter - - - - - Returns false: Cannot seek within a AiffFileWriter - - - - - Read is not supported for a AiffFileWriter - - - - - Seek is not supported for a AiffFileWriter - - - - - SetLength is not supported for AiffFileWriter - - - - - - Gets the Position in the AiffFile (i.e. number of bytes written so far) - - - - - Appends bytes to the AiffFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Aiff file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Aiff file - They will be converted to the appropriate bit depth depending on the WaveFormat of the AIF file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Aiff file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this AiffFileWriter - - - - - https://tech.ebu.ch/docs/tech/tech3285.pdf - - - - - Constructs a new BextChunkInfo - - - - - Description (max 256 chars) - - - - - Originator (max 32 chars) - - - - - Originator Reference (max 32 chars) - - - - - Originator Date Time - - - - - Origination Date as string - - - - - Origination as time - - - - - Time reference (first sample count since midnight) - - - - - version 2 has loudness stuff which we don't know so using version 1 - - - - - 64 bytes http://en.wikipedia.org/wiki/UMID - - - - - for version 2 = 180 bytes (10 before are loudness values), using version 1 = 190 bytes - - - - - Coding history arbitrary length string at end of structure - http://www.ebu.ch/CMSimages/fr/tec_text_r98-1999_tcm7-4709.pdf - A=PCM,F=48000,W=16,M=stereo,T=original,CR/LF - - - - - Broadcast WAVE File Writer - - - - - Createa a new BwfWriter - - Rarget filename - WaveFormat - Chunk information - - - - Write audio data to this BWF - - - - - Flush writer, and fix up header sizes - - - - - Disposes this writer - - - - - A wave file writer that adds cue support - - - - - Writes a wave file, including a cues chunk - - - - - Adds a cue to the Wave file - - Sample position - Label text - - - - Updates the header, and writes the cues out - - - - - IWaveBuffer interface use to store wave datas. - Data can be manipulated with arrays (,, - , ) that are pointing to the same memory buffer. - This is a requirement for all subclasses. - - Use the associated Count property based on the type of buffer to get the number of data in the - buffer. - - for the standard implementation using C# unions. - - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets the byte buffer count. - - The byte buffer count. - - - - Gets the float buffer count. - - The float buffer count. - - - - Gets the short buffer count. - - The short buffer count. - - - - Gets the int buffer count. - - The int buffer count. - - - - Represents the interface to a device that can play a WaveFile - - - - - Begin playback - - - - - Stop playback - - - - - Pause Playback - - - - - Obsolete init method - - - - - - - Initialise playback - - Function to create the waveprovider to be played - Called on the playback thread - - - - Current playback state - - - - - Indicates that playback has gone into a stopped state due to - reaching the end of the input stream or an error has been encountered during playback - - - - - Interface for IWavePlayers that can report position - - - - - Position (in terms of bytes played - does not necessarily translate directly to the position within the source audio file) - - Position in bytes - - - - Gets a instance indicating the format the hardware is using. - - - - - Generic interface for all WaveProviders. - - - - - Gets the WaveFormat of this WaveProvider. - - The wave format. - - - - Fill the specified buffer with wave data. - - The buffer to fill of wave data. - Offset into buffer - The number of bytes to read - the number of bytes written to the buffer. - - - - Like IWaveProvider, but makes it much simpler to put together a 32 bit floating - point mixing engine - - - - - Gets the WaveFormat of this Sample Provider. - - The wave format. - - - - Fill the specified buffer with 32 bit floating point samples - - The buffer to fill with samples. - Offset into buffer - The number of samples to read - the number of samples written to the buffer. - - - - Playback State - - - - - Stopped - - - - - Playing - - - - - Paused - - - - - Stopped Event Args - - - - - Initializes a new instance of StoppedEventArgs - - An exception to report (null if no exception) - - - - An exception. Will be null if the playback or record operation stopped due to - the user requesting stop or reached the end of the input audio - - - - - WASAPI Out for Windows RT - - - - - Playback Stopped - - - - - WASAPI Out using default audio endpoint - - ShareMode - shared or exclusive - Desired latency in milliseconds - - - - Creates a new WASAPI Output - - Device to use - - - - - - Properties of the client's audio stream. - Set before calling init - - - - - Sets the parameters that describe the properties of the client's audio stream. - - Boolean value to indicate whether or not the audio stream is hardware-offloaded. - An enumeration that is used to specify the category of the audio stream. - A bit-field describing the characteristics of the stream. Supported in Windows 8.1 and later. - - - - Begin Playback - - - - - Stop playback and flush buffers - - - - - Stop playback without flushing buffers - - - - - Old init implementation. Use the func one - - - - - - - Initializes with a function to create the provider that is made on the playback thread - - Creates the wave provider - - - - Initialize for playing the specified wave stream - - - - - Playback State - - - - - Dispose - - - - - Some useful native methods for Windows 8/10 support ( https://msdn.microsoft.com/en-us/library/windows/desktop/hh802935(v=vs.85).aspx ) - - - - - Enables Windows Store apps to access preexisting Component Object Model (COM) interfaces in the WASAPI family. - - A device interface ID for an audio device. This is normally retrieved from a DeviceInformation object or one of the methods of the MediaDevice class. - The IID of a COM interface in the WASAPI family, such as IAudioClient. - Interface-specific activation parameters. For more information, see the pActivationParams parameter in IMMDevice::Activate. - - - - - - The GetBufferSize method retrieves the size (maximum capacity) of the endpoint buffer. - - - - - The GetService method accesses additional services from the audio client object. - - The interface ID for the requested service. - Pointer to a pointer variable into which the method writes the address of an instance of the requested interface. - - - - WaveBuffer class use to store wave datas. Data can be manipulated with arrays - (,,, ) that are pointing to the - same memory buffer. Use the associated Count property based on the type of buffer to get the number of - data in the buffer. - Implicit casting is now supported to float[], byte[], int[], short[]. - You must not use Length on returned arrays. - - n.b. FieldOffset is 8 now to allow it to work natively on 64 bit - - - - - Number of Bytes - - - - - Initializes a new instance of the class. - - The number of bytes. The size of the final buffer will be aligned on 4 Bytes (upper bound) - - - - Initializes a new instance of the class binded to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Binds this WaveBuffer instance to a specific byte buffer. - - A byte buffer to bound the WaveBuffer to. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The wave buffer. - The result of the conversion. - - - - Gets the byte buffer. - - The byte buffer. - - - - Gets the float buffer. - - The float buffer. - - - - Gets the short buffer. - - The short buffer. - - - - Gets the int buffer. - - The int buffer. - - - - Gets the max size in bytes of the byte buffer.. - - Maximum number of bytes in the buffer. - - - - Gets or sets the byte buffer count. - - The byte buffer count. - - - - Gets or sets the float buffer count. - - The float buffer count. - - - - Gets or sets the short buffer count. - - The short buffer count. - - - - Gets or sets the int buffer count. - - The int buffer count. - - - - Clears the associated buffer. - - - - - Copy this WaveBuffer to a destination buffer up to ByteBufferCount bytes. - - - - - Checks the validity of the count parameters. - - Name of the arg. - The value. - The size of value. - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - Writes to a stream by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The stream the method will output to - The source WaveProvider - - - - WaveFileWriter that actually writes to a stream - - Stream to be written to - Wave format to use - - - - Creates a new WaveFileWriter - - The filename to write to - The Wave Format of the output data - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - Total time (calculated from Length and average bytes per second) - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriter - - - - - Returns true: Can write to a WaveFileWriter - - - - - Returns false: Cannot seek within a WaveFileWriter - - - - - Read is not supported for a WaveFileWriter - - - - - Seek is not supported for a WaveFileWriter - - - - - SetLength is not supported for WaveFileWriter - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - Also updates header, so that WAV file will be valid up to the point currently written - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriter - - - - - This class writes WAV data to a .wav file on disk - - - - - Creates a 16 bit Wave File from an ISampleProvider - BEWARE: the source provider must not return data indefinitely - - The filename to write to - The source sample provider - - - - Creates a Wave file by reading all the data from a WaveProvider - BEWARE: the WaveProvider MUST return 0 from its Read method when it is finished, - or the Wave File will grow indefinitely. - - The filename to use - The source WaveProvider - - - - WaveFileWriterRT that actually writes to a stream - - Stream to be written to - Wave format to use - - - - The wave file name or null if not applicable - - - - - Number of bytes of audio in the data chunk - - - - - WaveFormat of this wave file - - - - - Returns false: Cannot read from a WaveFileWriterRT - - - - - Returns true: Can write to a WaveFileWriterRT - - - - - Returns false: Cannot seek within a WaveFileWriterRT - - - - - Returns false: Cannot timeout within a WaveFileWriterRT - - - - - CopyToAsync is not supported for a WaveFileWriterRT - - - - - Read is not supported for a WaveFileWriterRT - - - - - ReadAsync is not supported for a WaveFileWriterRT - - - - - ReadByte is not supported for a WaveFileWriterRT - - - - - Seek is not supported for a WaveFileWriterRT - - - - - SetLength is not supported for WaveFileWriterRT - - - - - - Gets the Position in the WaveFile (i.e. number of bytes written so far) - - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - - - - Appends bytes to the WaveFile (assumes they are already in the correct format) - - the buffer containing the wave data - the offset from which to start writing - the number of bytes to write - Cancellation token - - - - WriteByte is not supported for a WaveFileWriterRT - Use instead - - value to write - - - - Writes a single sample to the Wave file - - the sample to write (assumed floating point with 1.0f as max value) - - - - Writes 32 bit floating point samples to the Wave file - They will be converted to the appropriate bit depth depending on the WaveFormat of the WAV file - - The buffer containing the floating point samples - The offset from which to start writing - The number of floating point samples to write - - - - Writes 16 bit samples to the Wave file - - The buffer containing the 16 bit samples - The offset from which to start writing - The number of 16 bit samples to write - - - - Ensures data is written to disk - - - - - Ensures data is written to disk - - - - - Actually performs the close,making sure the header contains the correct data - - True if called from Dispose - - - - Updates the header with file size information - - - - - Finaliser - should only be called if the user forgot to close this WaveFileWriterRT - - - - - Provides a buffered store of samples - Read method will return queued samples or fill buffer with zeroes - Now backed by a circular buffer - - - - - Creates a new buffered WaveProvider - - WaveFormat - - - - If true, always read the amount of data requested, padding with zeroes if necessary - By default is set to true - - - - - Buffer length in bytes - - - - - Buffer duration - - - - - If true, when the buffer is full, start throwing away data - if false, AddSamples will throw an exception when buffer is full - - - - - The number of buffered bytes - - - - - Buffered Duration - - - - - Gets the WaveFormat - - - - - Adds samples. Takes a copy of buffer, so that buffer can be reused if necessary - - - - - Reads from this WaveProvider - Will always return count bytes, since we will zero-fill the buffer if not enough available - - - - - Discards all audio from the buffer - - - - - WaveProvider that can mix together multiple 32 bit floating point input provider - All channels must have the same number of inputs and same sample rate - n.b. Work in Progress - not tested yet - - - - - Creates a new MixingWaveProvider32 - - - - - Creates a new 32 bit MixingWaveProvider32 - - inputs - must all have the same format. - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove an input from the mixer - - waveProvider to remove - - - - The number of inputs to this mixer - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Converts from mono to stereo, allowing freedom to route all, some, or none of the incoming signal to left or right channels - - - - - Creates a new stereo waveprovider based on a mono input - - Mono 16 bit PCM input - - - - 1.0 to copy the mono stream to the left channel without adjusting volume - - - - - 1.0 to copy the mono stream to the right channel without adjusting volume - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Allows any number of inputs to be patched to outputs - Uses could include swapping left and right channels, turning mono into stereo, - feeding different input sources to different soundcard outputs etc - - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels. Number of outputs is equal to total number of channels in inputs - - Input wave providers. Must all be of the same format, but can have any number of channels - - - - Creates a multiplexing wave provider, allowing re-patching of input channels to different - output channels - - Input wave providers. Must all be of the same format, but can have any number of channels - Desired number of output channels. (-1 means use total number of input channels) - - - - persistent temporary buffer to prevent creating work for garbage collector - - - - - Reads data from this WaveProvider - - Buffer to be filled with sample data - Offset to write to within buffer, usually 0 - Number of bytes required - Number of bytes read - - - - The WaveFormat of this WaveProvider - - - - - Connects a specified input channel to an output channel - - Input Channel index (zero based). Must be less than InputChannelCount - Output Channel index (zero based). Must be less than OutputChannelCount - - - - The number of input channels. Note that this is not the same as the number of input wave providers. If you pass in - one stereo and one mono input provider, the number of input channels is three. - - - - - The number of output channels, as specified in the constructor. - - - - - Silence producing wave provider - Useful for playing silence when doing a WASAPI Loopback Capture - - - - - Creates a new silence producing wave provider - - Desired WaveFormat (should be PCM / IEE float - - - - Read silence from into the buffer - - - - - WaveFormat of this silence producing wave provider - - - - - Takes a stereo 16 bit input and turns it mono, allowing you to select left or right channel only or mix them together - - - - - Creates a new mono waveprovider based on a stereo input - - Stereo 16 bit PCM input - - - - 1.0 to mix the mono source entirely to the left channel - - - - - 1.0 to mix the mono source entirely to the right channel - - - - - Output Wave Format - - - - - Reads bytes from this WaveProvider - - - - - Helper class allowing us to modify the volume of a 16 bit stream without converting to IEEE float - - - - - Constructs a new VolumeWaveProvider16 - - Source provider, must be 16 bit PCM - - - - Gets or sets volume. - 1.0 is full scale, 0.0 is silence, anything over 1.0 will amplify but potentially clip - - - - - WaveFormat of this WaveProvider - - - - - Read bytes from this WaveProvider - - Buffer to read into - Offset within buffer to read to - Bytes desired - Bytes read - - - - Converts 16 bit PCM to IEEE float, optionally adjusting volume along the way - - - - - Creates a new Wave16toFloatProvider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Converts IEEE float to 16 bit PCM, optionally clipping and adjusting volume along the way - - - - - Creates a new WaveFloatTo16Provider - - the source provider - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Buffered WaveProvider taking source data from WaveIn - - - - - Creates a new WaveInProvider - n.b. Should make sure the WaveFormat is set correctly on IWaveIn before calling - - The source of wave data - - - - Reads data from the WaveInProvider - - - - - The WaveFormat - - - - - Base class for creating a 16 bit wave provider - - - - - Initializes a new instance of the WaveProvider16 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider16 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a short array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Base class for creating a 32 bit floating point wave provider - Can also be used as a base class for an ISampleProvider that can - be plugged straight into anything requiring an IWaveProvider - - - - - Initializes a new instance of the WaveProvider32 class - defaulting to 44.1kHz mono - - - - - Initializes a new instance of the WaveProvider32 class with the specified - sample rate and number of channels - - - - - Allows you to specify the sample rate and channels for this WaveProvider - (should be initialised before you pass it to a wave player) - - - - - Implements the Read method of IWaveProvider by delegating to the abstract - Read method taking a float array - - - - - Method to override in derived classes - Supply the requested number of samples into the buffer - - - - - The Wave Format - - - - - Utility class to intercept audio from an IWaveProvider and - save it to disk - - - - - Constructs a new WaveRecorder - - The location to write the WAV file to - The Source Wave Provider - - - - Read simply returns what the source returns, but writes to disk along the way - - - - - The WaveFormat - - - - - Closes the WAV file - - - - A read-only stream of AIFF data based on an aiff file - with an associated WaveFormat - originally contributed to NAudio by Giawa - - - - Supports opening a AIF file - The AIF is of similar nastiness to the WAV format. - This supports basic reading of uncompressed PCM AIF files, - with 8, 16, 24 and 32 bit PCM data. - - - - - Creates an Aiff File Reader based on an input stream - - The input stream containing a AIF file including header - - - - Ensures valid AIFF header and then finds data offset. - - The stream, positioned at the start of audio data - The format found - The position of the data chunk - The length of the data chunk - Additional chunks found - - - - Cleans up the resources associated with this AiffFileReader - - - - - - - - - - - - - - - Number of Samples (if possible to calculate) - - - - - Position in the AIFF file - - - - - - Reads bytes from the AIFF File - - - - - - AIFF Chunk - - - - - Chunk Name - - - - - Chunk Length - - - - - Chunk start - - - - - Creates a new AIFF Chunk - - - - - Helper stream that lets us read from compressed audio files with large block alignment - as though we could read any amount and reposition anywhere - - - - - Creates a new BlockAlignReductionStream - - the input stream - - - - Block alignment of this stream - - - - - Wave Format - - - - - Length of this Stream - - - - - Current position within stream - - - - - Disposes this WaveStream - - - - - Reads data from this stream - - - - - - - - - Implementation of Com IStream - - - - - Holds information on a cue: a labeled position within a Wave file - - - - - Cue position in samples - - - - - Label of the cue - - - - - Creates a Cue based on a sample position and label - - - - - - - Holds a list of cues - - - The specs for reading and writing cues from the cue and list RIFF chunks - are from http://www.sonicspot.com/guide/wavefiles.html and http://www.wotsit.org/ - ------------------------------ - The cues are stored like this: - ------------------------------ - struct CuePoint - { - Int32 dwIdentifier; - Int32 dwPosition; - Int32 fccChunk; - Int32 dwChunkStart; - Int32 dwBlockStart; - Int32 dwSampleOffset; - } - - struct CueChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwCuePoints; - CuePoint[] points; - } - ------------------------------ - Labels look like this: - ------------------------------ - struct ListHeader - { - Int32 listID; /* 'list' */ - Int32 chunkSize; /* includes the Type ID below */ - Int32 typeID; /* 'adtl' */ - } - - struct LabelChunk - { - Int32 chunkID; - Int32 chunkSize; - Int32 dwIdentifier; - Char[] dwText; /* Encoded with extended ASCII */ - } LabelChunk; - - - - - Creates an empty cue list - - - - - Adds an item to the list - - Cue - - - - Gets sample positions for the embedded cues - - Array containing the cue positions - - - - Gets labels for the embedded cues - - Array containing the labels - - - - Creates a cue list from the cue RIFF chunk and the list RIFF chunk - - The data contained in the cue chunk - The data contained in the list chunk - - - - Gets the cues as the concatenated cue and list RIFF chunks. - - RIFF chunks containing the cue data - - - - Number of cues - - - - - Accesses the cue at the specified index - - - - - - - Checks if the cue and list chunks exist and if so, creates a cue list - - - - - A wave file reader supporting cue reading - - - - - Loads a wavefile and supports reading cues - - - - - - Loads a wave from a stream and supports reading cues - - - - - - Cue List (can be null if cues not present) - - - - - An interface for WaveStreams which can report notification of individual samples - - - - - A sample has been detected - - - - - Sample event arguments - - - - - Left sample - - - - - Right sample - - - - - Constructor - - - - - Class for reading any file that Media Foundation can play - Will only work in Windows Vista and above - Automatically converts to PCM - If it is a video file with multiple audio streams, it will pick out the first audio stream - - - - - Allows customisation of this reader class - - - - - Sets up the default settings for MediaFoundationReader - - - - - Allows us to request IEEE float output (n.b. no guarantee this will be accepted) - - - - - If true, the reader object created in the constructor is used in Read - Should only be set to true if you are working entirely on an STA thread, or - entirely with MTA threads. - - - - - If true, the reposition does not happen immediately, but waits until the - next call to read to be processed. - - - - - Default constructor - - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename (can also be a URL e.g. http:// mms:// file://) - - - - Creates a new MediaFoundationReader based on the supplied file - - Filename - Advanced settings - - - - Initializes - - - - - Creates the reader (overridable by ) - - - - - Reads from this wave stream - - Buffer to read into - Offset in buffer - Bytes required - Number of bytes read; 0 indicates end of stream - - - - WaveFormat of this stream (n.b. this is after converting to PCM) - - - - - The bytesRequired of this stream in bytes (n.b may not be accurate) - - - - - Current position within this stream - - - - - Cleans up after finishing with this reader - - true if called from Dispose - - - - WaveFormat has changed - - - - - WaveStream that simply passes on data from its source stream - (e.g. a MemoryStream) - - - - - Initialises a new instance of RawSourceWaveStream - - The source stream containing raw audio - The waveformat of the audio in the source stream - - - - Initialises a new instance of RawSourceWaveStream - - The buffer containing raw audio - Offset in the source buffer to read from - Number of bytes to read in the buffer - The waveformat of the audio in the source stream - - - - The WaveFormat of this stream - - - - - The length in bytes of this stream (if supported) - - - - - The current position in this stream - - - - - Reads data from the stream - - - - - Wave Stream for converting between sample rates - - - - - WaveStream to resample using the DMO Resampler - - Input Stream - Desired Output Format - - - - Stream Wave Format - - - - - Stream length in bytes - - - - - Stream position in bytes - - - - - Reads data from input stream - - buffer - offset into buffer - Bytes required - Number of bytes read - - - - Dispose - - True if disposing (not from finalizer) - - - - Holds information about a RIFF file chunk - - - - - Creates a RiffChunk object - - - - - The chunk identifier - - - - - The chunk identifier converted to a string - - - - - The chunk length - - - - - The stream position this chunk is located at - - - - - A simple compressor - - - - - Create a new simple compressor stream - - Source stream - - - - Make-up Gain - - - - - Threshold - - - - - Ratio - - - - - Attack time - - - - - Release time - - - - - Turns gain on or off - - - - - Gets the WaveFormat of this stream - - - - - Reads bytes from this stream - - Buffer to read into - Offset in array to read into - Number of bytes to read - Number of bytes read - - - - MediaFoundationReader supporting reading from a stream - - - - - Constructs a new media foundation reader from a stream - - - - - Creates the reader - - - - - WaveStream that converts 32 bit audio back down to 16 bit, clipping if necessary - - - - - The method reuses the same buffer to prevent - unnecessary allocations. - - - - - Creates a new Wave32To16Stream - - the source stream - - - - Sets the volume for this stream. 1.0f is full scale - - - - - - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - Destination buffer - Offset into destination buffer - - Number of bytes read. - - - - Conversion to 16 bit and clipping - - - - - - - - - - Clip indicator. Can be reset. - - - - - Disposes this WaveStream - - - - - Represents Channel for the WaveMixerStream - 32 bit output and 16 bit input - It's output is always stereo - The input stream can be panned - - - - - Creates a new WaveChannel32 - - the source stream - stream volume (1 is 0dB) - pan control (-1 to 1) - - - - Creates a WaveChannel32 with default settings - - The source stream - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - If true, Read always returns the number of bytes requested - - - - - - - - - - Volume of this channel. 1.0 = full scale - - - - - Pan of this channel (from -1 to 1) - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - Sample - - - - - Raise the sample event (no check for null because it has already been done) - - - - This class supports the reading of WAV files, - providing a repositionable WaveStream that returns the raw data - contained in the WAV file - - - - Supports opening a WAV file - The WAV file format is a real mess, but we will only - support the basic WAV file format which actually covers the vast - majority of WAV files out there. For more WAV file format information - visit www.wotsit.org. If you have a WAV file that can't be read by - this class, email it to the NAudio project and we will probably - fix this reader to support it - - - - - Creates a Wave File Reader based on an input stream - - The input stream containing a WAV file including header - - - - Gets a list of the additional chunks found in this file - - - - - Gets the data for the specified chunk - - - - - Cleans up the resources associated with this WaveFileReader - - - - - - - - - - This is the length of audio data contained in this WAV file, in bytes - (i.e. the byte length of the data chunk, not the length of the WAV file itself) - - - - - - Number of Sample Frames (if possible to calculate) - This currently does not take into account number of channels - Multiply number of channels if you want the total number of samples - - - - - Position in the WAV data chunk. - - - - - - Reads bytes from the Wave File - - - - - - Attempts to read the next sample or group of samples as floating point normalised into the range -1.0f to 1.0f - - An array of samples, 1 for mono, 2 for stereo etc. Null indicates end of file reached - - - - - Attempts to read a sample into a float. n.b. only applicable for uncompressed formats - Will normalise the value read into the range -1.0f to 1.0f if it comes from a PCM encoding - - False if the end of the WAV data chunk was reached - - - - A buffer of Wave samples - - - - - creates a new wavebuffer - - WaveIn device to write to - Buffer size in bytes - - - - Place this buffer back to record more audio - - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - - Provides access to the actual record buffer (for reading only) - - - - - Indicates whether the Done flag is set on this buffer - - - - - Indicates whether the InQueue flag is set on this buffer - - - - - Number of bytes recorded - - - - - The buffer size in bytes - - - - - WaveStream that can mix together multiple 32 bit input streams - (Normally used with stereo input channels) - All channels must have the same number of inputs - - - - - Creates a new 32 bit WaveMixerStream - - - - - Creates a new 32 bit WaveMixerStream - - An Array of WaveStreams - must all have the same format. - Use WaveChannel is designed for this purpose. - Automatically stop when all inputs have been read - Thrown if the input streams are not 32 bit floating point, - or if they have different formats to each other - - - - Add a new input to the mixer - - The wave input to add - - - - Remove a WaveStream from the mixer - - waveStream to remove - - - - The number of inputs to this mixer - - - - - Automatically stop when all inputs have been read - - - - - Reads bytes from this wave stream - - buffer to read into - offset into buffer - number of bytes required - Number of bytes read. - Thrown if an invalid number of bytes requested - - - - Actually performs the mixing - - - - - - - - - - Length of this Wave Stream (in bytes) - - - - - - Position within this Wave Stream (in bytes) - - - - - - - - - - - Disposes this WaveStream - - - - - Simply shifts the input stream in time, optionally - clipping its start and end. - (n.b. may include looping in the future) - - - - - Creates a new WaveOffsetStream - - the source stream - the time at which we should start reading from the source stream - amount to trim off the front of the source stream - length of time to play from source stream - - - - Creates a WaveOffsetStream with default settings (no offset or pre-delay, - and whole length of source stream) - - The source stream - - - - The length of time before which no audio will be played - - - - - An offset into the source stream from which to start playing - - - - - Length of time to read from the source stream - - - - - Gets the block alignment for this WaveStream - - - - - Returns the stream length - - - - - Gets or sets the current position in the stream - - - - - Reads bytes from this wave stream - - The destination buffer - Offset into the destination buffer - Number of bytes read - Number of bytes read. - - - - - - - - - Determines whether this channel has any data to play - to allow optimisation to not read, but bump position forward - - - - - Disposes this WaveStream - - - - - A buffer of Wave samples for streaming to a Wave Output device - - - - - creates a new wavebuffer - - WaveOut device to write to - Buffer size in bytes - Stream to provide more data - Lock to protect WaveOut API's from being called on >1 thread - - - - Finalizer for this wave buffer - - - - - Releases resources held by this WaveBuffer - - - - - Releases resources held by this WaveBuffer - - - - this is called by the WAVE callback and should be used to refill the buffer - - - - Whether the header's in queue flag is set - - - - - The buffer size in bytes - - - - - Base class for all WaveStream classes. Derives from stream. - - - - - Retrieves the WaveFormat for this stream - - - - - We can read from this stream - - - - - We can seek within this stream - - - - - We can't write to this stream - - - - - Flush does not need to do anything - See - - - - - An alternative way of repositioning. - See - - - - - Sets the length of the WaveStream. Not Supported. - - - - - - Writes to the WaveStream. Not Supported. - - - - - The block alignment for this wavestream. Do not modify the Position - to anything that is not a whole multiple of this value - - - - - Moves forward or backwards the specified number of seconds in the stream - - Number of seconds to move, can be negative - - - - The current position in the stream in Time format - - - - - Total length in real-time of the stream (may be an estimate for compressed files) - - - - - Whether the WaveStream has non-zero sample data at the current position for the - specified count - - Number of bytes to read - - - - MP3 Frame decompressor using the Windows Media MP3 Decoder DMO object - - - - - Initializes a new instance of the DMO MP3 Frame decompressor - - - - - - Converted PCM WaveFormat - - - - - Decompress a single frame of MP3 - - - - - Alerts us that a reposition has occured so the MP3 decoder needs to reset its state - - - - - Dispose of this obejct and clean up resources - - - - - http://tech.ebu.ch/docs/tech/tech3306-2009.pdf - - - - - WaveFormat - - - - - Data Chunk Position - - - - - Data Chunk Length - - - - - Riff Chunks - - - - - Soundfont generator - - - - - Gets the generator type - - - - - Generator amount as an unsigned short - - - - - Generator amount as a signed short - - - - - Low byte amount - - - - - High byte amount - - - - - Instrument - - - - - Sample Header - - - - - - - - - - Generator types - - - - Start address offset - - - End address offset - - - Start loop address offset - - - End loop address offset - - - Start address coarse offset - - - Modulation LFO to pitch - - - Vibrato LFO to pitch - - - Modulation envelope to pitch - - - Initial filter cutoff frequency - - - Initial filter Q - - - Modulation LFO to filter Cutoff frequency - - - Modulation envelope to filter cutoff frequency - - - End address coarse offset - - - Modulation LFO to volume - - - Unused - - - Chorus effects send - - - Reverb effects send - - - Pan - - - Unused - - - Unused - - - Unused - - - Delay modulation LFO - - - Frequency modulation LFO - - - Delay vibrato LFO - - - Frequency vibrato LFO - - - Delay modulation envelope - - - Attack modulation envelope - - - Hold modulation envelope - - - Decay modulation envelope - - - Sustain modulation envelop - - - Release modulation envelope - - - Key number to modulation envelope hold - - - Key number to modulation envelope decay - - - Delay volume envelope - - - Attack volume envelope - - - Hold volume envelope - - - Decay volume envelope - - - Sustain volume envelope - - - Release volume envelope - - - Key number to volume envelope hold - - - Key number to volume envelope decay - - - Instrument - - - Reserved - - - Key range - - - Velocity range - - - Start loop address coarse offset - - - Key number - - - Velocity - - - Initial attenuation - - - Reserved - - - End loop address coarse offset - - - Coarse tune - - - Fine tune - - - Sample ID - - - Sample modes - - - Reserved - - - Scale tuning - - - Exclusive class - - - Overriding root key - - - Unused - - - Unused - - - - A soundfont info chunk - - - - - SoundFont Version - - - - - WaveTable sound engine - - - - - Bank name - - - - - Data ROM - - - - - Creation Date - - - - - Author - - - - - Target Product - - - - - Copyright - - - - - Comments - - - - - Tools - - - - - ROM Version - - - - - - - - - - SoundFont instrument - - - - - instrument name - - - - - Zones - - - - - - - - - - Instrument Builder - - - - - Transform Types - - - - - Linear - - - - - Modulator - - - - - Source Modulation data type - - - - - Destination generator type - - - - - Amount - - - - - Source Modulation Amount Type - - - - - Source Transform Type - - - - - - - - - - Controller Sources - - - - - No Controller - - - - - Note On Velocity - - - - - Note On Key Number - - - - - Poly Pressure - - - - - Channel Pressure - - - - - Pitch Wheel - - - - - Pitch Wheel Sensitivity - - - - - Source Types - - - - - Linear - - - - - Concave - - - - - Convex - - - - - Switch - - - - - Modulator Type - - - - - - - - - - - A SoundFont Preset - - - - - Preset name - - - - - Patch Number - - - - - Bank number - 0 - 127, GM percussion bank is 128 - - - - - Zones - - - - - - - - - - Class to read the SoundFont file presets chunk - - - - - The Presets contained in this chunk - - - - - The instruments contained in this chunk - - - - - The sample headers contained in this chunk - - - - - - - - - - just reads a chunk ID at the current position - - chunk ID - - - - reads a chunk at the current position - - - - - creates a new riffchunk from current position checking that we're not - at the end of this chunk first - - the new chunk - - - - useful for chunks that just contain a string - - chunk as string - - - - A SoundFont Sample Header - - - - - The sample name - - - - - Start offset - - - - - End offset - - - - - Start loop point - - - - - End loop point - - - - - Sample Rate - - - - - Original pitch - - - - - Pitch correction - - - - - Sample Link - - - - - SoundFont Sample Link Type - - - - - - - - - - SoundFont sample modes - - - - - No loop - - - - - Loop Continuously - - - - - Reserved no loop - - - - - Loop and continue - - - - - Sample Link Type - - - - - Mono Sample - - - - - Right Sample - - - - - Left Sample - - - - - Linked Sample - - - - - ROM Mono Sample - - - - - ROM Right Sample - - - - - ROM Left Sample - - - - - ROM Linked Sample - - - - - SoundFont Version Structure - - - - - Major Version - - - - - Minor Version - - - - - Builds a SoundFont version - - - - - Reads a SoundFont Version structure - - - - - Writes a SoundFont Version structure - - - - - Gets the length of this structure - - - - - Represents a SoundFont - - - - - Loads a SoundFont from a stream - - stream - - - - The File Info Chunk - - - - - The Presets - - - - - The Instruments - - - - - The Sample Headers - - - - - The Sample Data - - - - - - - - - - base class for structures that can read themselves - - - - - A SoundFont zone - - - - - - - - - - Modulators for this Zone - - - - - Generators for this Zone - - - - - Audio Subtype GUIDs - http://msdn.microsoft.com/en-us/library/windows/desktop/aa372553%28v=vs.85%29.aspx - - - - - Advanced Audio Coding (AAC). - - - - - Not used - - - - - Dolby AC-3 audio over Sony/Philips Digital Interface (S/PDIF). - - - - - Encrypted audio data used with secure audio path. - - - - - Digital Theater Systems (DTS) audio. - - - - - Uncompressed IEEE floating-point audio. - - - - - MPEG Audio Layer-3 (MP3). - - - - - MPEG-1 audio payload. - - - - - Windows Media Audio 9 Voice codec. - - - - - Uncompressed PCM audio. - - - - - Windows Media Audio 9 Professional codec over S/PDIF. - - - - - Windows Media Audio 9 Lossless codec or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 8 codec, Windows Media Audio 9 codec, or Windows Media Audio 9.1 codec. - - - - - Windows Media Audio 9 Professional codec or Windows Media Audio 9.1 Professional codec. - - - - - Dolby Digital (AC-3). - - - - - MPEG-4 and AAC Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - Dolby Audio Types - http://msdn.microsoft.com/en-us/library/windows/desktop/dd317599(v=vs.85).aspx - Reference : wmcodecdsp.h - - - - - μ-law coding - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Adaptive delta pulse code modulation (ADPCM) - http://msdn.microsoft.com/en-us/library/windows/desktop/dd390971(v=vs.85).aspx - Reference : Ksmedia.h - - - - - Dolby Digital Plus formatted for HDMI output. - http://msdn.microsoft.com/en-us/library/windows/hardware/ff538392(v=vs.85).aspx - Reference : internet - - - - - MSAudio1 - unknown meaning - Reference : wmcodecdsp.h - - - - - IMA ADPCM ACM Wrapper - - - - - WMSP2 - unknown meaning - Reference: wmsdkidl.h - - - - - IMFActivate, defined in mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Creates the object associated with this activation object. - - - - - Shuts down the created object. - - - - - Detaches the created object from the activation object. - - - - - Provides a generic way to store key/value pairs on an object. - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms704598%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - IMFByteStream - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms698720%28v=vs.85%29.aspx - - - - - Retrieves the characteristics of the byte stream. - virtual HRESULT STDMETHODCALLTYPE GetCapabilities(/*[out]*/ __RPC__out DWORD *pdwCapabilities) = 0; - - - - - Retrieves the length of the stream. - virtual HRESULT STDMETHODCALLTYPE GetLength(/*[out]*/ __RPC__out QWORD *pqwLength) = 0; - - - - - Sets the length of the stream. - virtual HRESULT STDMETHODCALLTYPE SetLength(/*[in]*/ QWORD qwLength) = 0; - - - - - Retrieves the current read or write position in the stream. - virtual HRESULT STDMETHODCALLTYPE GetCurrentPosition(/*[out]*/ __RPC__out QWORD *pqwPosition) = 0; - - - - - Sets the current read or write position. - virtual HRESULT STDMETHODCALLTYPE SetCurrentPosition(/*[in]*/ QWORD qwPosition) = 0; - - - - - Queries whether the current position has reached the end of the stream. - virtual HRESULT STDMETHODCALLTYPE IsEndOfStream(/*[out]*/ __RPC__out BOOL *pfEndOfStream) = 0; - - - - - Reads data from the stream. - virtual HRESULT STDMETHODCALLTYPE Read(/*[size_is][out]*/ __RPC__out_ecount_full(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbRead) = 0; - - - - - Begins an asynchronous read operation from the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginRead(/*[out]*/ _Out_writes_bytes_(cb) BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous read operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndRead(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbRead) = 0; - - - - - Writes data to the stream. - virtual HRESULT STDMETHODCALLTYPE Write(/*[size_is][in]*/ __RPC__in_ecount_full(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[out]*/ __RPC__out ULONG *pcbWritten) = 0; - - - - - Begins an asynchronous write operation to the stream. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE BeginWrite(/*[in]*/ _In_reads_bytes_(cb) const BYTE *pb, /*[in]*/ ULONG cb, /*[in]*/ IMFAsyncCallback *pCallback, /*[in]*/ IUnknown *punkState) = 0; - - - - - Completes an asynchronous write operation. - virtual /*[local]*/ HRESULT STDMETHODCALLTYPE EndWrite(/*[in]*/ IMFAsyncResult *pResult, /*[out]*/ _Out_ ULONG *pcbWritten) = 0; - - - - - Moves the current position in the stream by a specified offset. - virtual HRESULT STDMETHODCALLTYPE Seek(/*[in]*/ MFBYTESTREAM_SEEK_ORIGIN SeekOrigin, /*[in]*/ LONGLONG llSeekOffset, /*[in]*/ DWORD dwSeekFlags, /*[out]*/ __RPC__out QWORD *pqwCurrentPosition) = 0; - - - - - Clears any internal buffers used by the stream. - virtual HRESULT STDMETHODCALLTYPE Flush( void) = 0; - - - - - Closes the stream and releases any resources associated with the stream. - virtual HRESULT STDMETHODCALLTYPE Close( void) = 0; - - - - - Represents a generic collection of IUnknown pointers. - - - - - Retrieves the number of objects in the collection. - - - - - Retrieves an object in the collection. - - - - - Adds an object to the collection. - - - - - Removes an object from the collection. - - - - - Removes an object from the collection. - - - - - Removes all items from the collection. - - - - - IMFMediaBuffer - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms696261%28v=vs.85%29.aspx - - - - - Gives the caller access to the memory in the buffer. - - - - - Unlocks a buffer that was previously locked. - - - - - Retrieves the length of the valid data in the buffer. - - - - - Sets the length of the valid data in the buffer. - - - - - Retrieves the allocated size of the buffer. - - - - - IMFMediaEvent - Represents an event generated by a Media Foundation object. Use this interface to get information about the event. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms702249%28v=vs.85%29.aspx - Mfobjects.h - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the event type. - - - virtual HRESULT STDMETHODCALLTYPE GetType( - /* [out] */ __RPC__out MediaEventType *pmet) = 0; - - - - - Retrieves the extended type of the event. - - - virtual HRESULT STDMETHODCALLTYPE GetExtendedType( - /* [out] */ __RPC__out GUID *pguidExtendedType) = 0; - - - - - Retrieves an HRESULT that specifies the event status. - - - virtual HRESULT STDMETHODCALLTYPE GetStatus( - /* [out] */ __RPC__out HRESULT *phrStatus) = 0; - - - - - Retrieves the value associated with the event, if any. - - - virtual HRESULT STDMETHODCALLTYPE GetValue( - /* [out] */ __RPC__out PROPVARIANT *pvValue) = 0; - - - - - Represents a description of a media format. - http://msdn.microsoft.com/en-us/library/windows/desktop/ms704850%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves the major type of the format. - - - - - Queries whether the media type is a compressed format. - - - - - Compares two media types and determines whether they are identical. - - - - - Retrieves an alternative representation of the media type. - - - - - Frees memory that was allocated by the GetRepresentation method. - - - - - Creates an instance of either the sink writer or the source reader. - - - - - Creates an instance of the sink writer or source reader, given a URL. - - - - - Creates an instance of the sink writer or source reader, given an IUnknown pointer. - - - - - CLSID_MFReadWriteClassFactory - - - - - http://msdn.microsoft.com/en-gb/library/windows/desktop/ms702192%28v=vs.85%29.aspx - - - - - Retrieves the value associated with a key. - - - - - Retrieves the data type of the value associated with a key. - - - - - Queries whether a stored attribute value equals a specified PROPVARIANT. - - - - - Compares the attributes on this object with the attributes on another object. - - - - - Retrieves a UINT32 value associated with a key. - - - - - Retrieves a UINT64 value associated with a key. - - - - - Retrieves a double value associated with a key. - - - - - Retrieves a GUID value associated with a key. - - - - - Retrieves the length of a string value associated with a key. - - - - - Retrieves a wide-character string associated with a key. - - - - - Retrieves a wide-character string associated with a key. This method allocates the memory for the string. - - - - - Retrieves the length of a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. - - - - - Retrieves a byte array associated with a key. This method allocates the memory for the array. - - - - - Retrieves an interface pointer associated with a key. - - - - - Associates an attribute value with a key. - - - - - Removes a key/value pair from the object's attribute list. - - - - - Removes all key/value pairs from the object's attribute list. - - - - - Associates a UINT32 value with a key. - - - - - Associates a UINT64 value with a key. - - - - - Associates a double value with a key. - - - - - Associates a GUID value with a key. - - - - - Associates a wide-character string with a key. - - - - - Associates a byte array with a key. - - - - - Associates an IUnknown pointer with a key. - - - - - Locks the attribute store so that no other thread can access it. - - - - - Unlocks the attribute store. - - - - - Retrieves the number of attributes that are set on this object. - - - - - Retrieves an attribute at the specified index. - - - - - Copies all of the attributes from this object into another attribute store. - - - - - Retrieves flags associated with the sample. - - - - - Sets flags associated with the sample. - - - - - Retrieves the presentation time of the sample. - - - - - Sets the presentation time of the sample. - - - - - Retrieves the duration of the sample. - - - - - Sets the duration of the sample. - - - - - Retrieves the number of buffers in the sample. - - - - - Retrieves a buffer from the sample. - - - - - Converts a sample with multiple buffers into a sample with a single buffer. - - - - - Adds a buffer to the end of the list of buffers in the sample. - - - - - Removes a buffer at a specified index from the sample. - - - - - Removes all buffers from the sample. - - - - - Retrieves the total length of the valid data in all of the buffers in the sample. - - - - - Copies the sample data to a buffer. - - - - - Implemented by the Microsoft Media Foundation sink writer object. - - - - - Adds a stream to the sink writer. - - - - - Sets the input format for a stream on the sink writer. - - - - - Initializes the sink writer for writing. - - - - - Delivers a sample to the sink writer. - - - - - Indicates a gap in an input stream. - - - - - Places a marker in the specified stream. - - - - - Notifies the media sink that a stream has reached the end of a segment. - - - - - Flushes one or more streams. - - - - - (Finalize) Completes all writing operations on the sink writer. - - - - - Queries the underlying media sink or encoder for an interface. - - - - - Gets statistics about the performance of the sink writer. - - - - - IMFSourceReader interface - http://msdn.microsoft.com/en-us/library/windows/desktop/dd374655%28v=vs.85%29.aspx - - - - - Queries whether a stream is selected. - - - - - Selects or deselects one or more streams. - - - - - Gets a format that is supported natively by the media source. - - - - - Gets the current media type for a stream. - - - - - Sets the media type for a stream. - - - - - Seeks to a new position in the media source. - - - - - Reads the next sample from the media source. - - - - - Flushes one or more streams. - - - - - Queries the underlying media source or decoder for an interface. - - - - - Gets an attribute from the underlying media source. - - - - - Contains flags that indicate the status of the IMFSourceReader::ReadSample method - http://msdn.microsoft.com/en-us/library/windows/desktop/dd375773(v=vs.85).aspx - - - - - No Error - - - - - An error occurred. If you receive this flag, do not make any further calls to IMFSourceReader methods. - - - - - The source reader reached the end of the stream. - - - - - One or more new streams were created - - - - - The native format has changed for one or more streams. The native format is the format delivered by the media source before any decoders are inserted. - - - - - The current media has type changed for one or more streams. To get the current media type, call the IMFSourceReader::GetCurrentMediaType method. - - - - - There is a gap in the stream. This flag corresponds to an MEStreamTick event from the media source. - - - - - All transforms inserted by the application have been removed for a particular stream. - - - - - IMFTransform, defined in mftransform.h - - - - - Retrieves the minimum and maximum number of input and output streams. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamLimits( - /* [out] */ __RPC__out DWORD *pdwInputMinimum, - /* [out] */ __RPC__out DWORD *pdwInputMaximum, - /* [out] */ __RPC__out DWORD *pdwOutputMinimum, - /* [out] */ __RPC__out DWORD *pdwOutputMaximum) = 0; - - - - - Retrieves the current number of input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamCount( - /* [out] */ __RPC__out DWORD *pcInputStreams, - /* [out] */ __RPC__out DWORD *pcOutputStreams) = 0; - - - - - Retrieves the stream identifiers for the input and output streams on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetStreamIDs( - DWORD dwInputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwInputIDArraySize) DWORD *pdwInputIDs, - DWORD dwOutputIDArraySize, - /* [size_is][out] */ __RPC__out_ecount_full(dwOutputIDArraySize) DWORD *pdwOutputIDs) = 0; - - - - - Gets the buffer requirements and other information for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamInfo( - DWORD dwInputStreamID, - /* [out] */ __RPC__out MFT_INPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the buffer requirements and other information for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamInfo( - DWORD dwOutputStreamID, - /* [out] */ __RPC__out MFT_OUTPUT_STREAM_INFO *pStreamInfo) = 0; - - - - - Gets the global attribute store for this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetAttributes( - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an input stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStreamAttributes( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Retrieves the attribute store for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStreamAttributes( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFAttributes **pAttributes) = 0; - - - - - Removes an input stream from this MFT. - - - virtual HRESULT STDMETHODCALLTYPE DeleteInputStream( - DWORD dwStreamID) = 0; - - - - - Adds one or more new input streams to this MFT. - - - virtual HRESULT STDMETHODCALLTYPE AddInputStreams( - DWORD cStreams, - /* [in] */ __RPC__in DWORD *adwStreamIDs) = 0; - - - - - Gets an available media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputAvailableType( - DWORD dwInputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Retrieves an available media type for an output stream on this MFT. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputAvailableType( - DWORD dwOutputStreamID, - DWORD dwTypeIndex, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Sets, tests, or clears the media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetInputType( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Sets, tests, or clears the media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE SetOutputType( - DWORD dwOutputStreamID, - /* [in] */ __RPC__in_opt IMFMediaType *pType, - DWORD dwFlags) = 0; - - - - - Gets the current media type for an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetInputCurrentType( - DWORD dwInputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Gets the current media type for an output stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE GetOutputCurrentType( - DWORD dwOutputStreamID, - /* [out] */ __RPC__deref_out_opt IMFMediaType **ppType) = 0; - - - - - Queries whether an input stream on this Media Foundation transform (MFT) can accept more data. - - - virtual HRESULT STDMETHODCALLTYPE GetInputStatus( - DWORD dwInputStreamID, - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Queries whether the Media Foundation transform (MFT) is ready to produce output data. - - - virtual HRESULT STDMETHODCALLTYPE GetOutputStatus( - /* [out] */ __RPC__out DWORD *pdwFlags) = 0; - - - - - Sets the range of time stamps the client needs for output. - - - virtual HRESULT STDMETHODCALLTYPE SetOutputBounds( - LONGLONG hnsLowerBound, - LONGLONG hnsUpperBound) = 0; - - - - - Sends an event to an input stream on this Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessEvent( - DWORD dwInputStreamID, - /* [in] */ __RPC__in_opt IMFMediaEvent *pEvent) = 0; - - - - - Sends a message to the Media Foundation transform (MFT). - - - virtual HRESULT STDMETHODCALLTYPE ProcessMessage( - MFT_MESSAGE_TYPE eMessage, - ULONG_PTR ulParam) = 0; - - - - - Delivers data to an input stream on this Media Foundation transform (MFT). - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessInput( - DWORD dwInputStreamID, - IMFSample *pSample, - DWORD dwFlags) = 0; - - - - - Generates output from the current input data. - - - virtual /* [local] */ HRESULT STDMETHODCALLTYPE ProcessOutput( - DWORD dwFlags, - DWORD cOutputBufferCount, - /* [size_is][out][in] */ MFT_OUTPUT_DATA_BUFFER *pOutputSamples, - /* [out] */ DWORD *pdwStatus) = 0; - - - - - See mfobjects.h - - - - - Unknown event type. - - - - - Signals a serious error. - - - - - Custom event type. - - - - - A non-fatal error occurred during streaming. - - - - - Session Unknown - - - - - Raised after the IMFMediaSession::SetTopology method completes asynchronously - - - - - Raised by the Media Session when the IMFMediaSession::ClearTopologies method completes asynchronously. - - - - - Raised when the IMFMediaSession::Start method completes asynchronously. - - - - - Raised when the IMFMediaSession::Pause method completes asynchronously. - - - - - Raised when the IMFMediaSession::Stop method completes asynchronously. - - - - - Raised when the IMFMediaSession::Close method completes asynchronously. - - - - - Raised by the Media Session when it has finished playing the last presentation in the playback queue. - - - - - Raised by the Media Session when the playback rate changes. - - - - - Raised by the Media Session when it completes a scrubbing request. - - - - - Raised by the Media Session when the session capabilities change. - - - - - Raised by the Media Session when the status of a topology changes. - - - - - Raised by the Media Session when a new presentation starts. - - - - - Raised by a media source a new presentation is ready. - - - - - License acquisition is about to begin. - - - - - License acquisition is complete. - - - - - Individualization is about to begin. - - - - - Individualization is complete. - - - - - Signals the progress of a content enabler object. - - - - - A content enabler object's action is complete. - - - - - Raised by a trusted output if an error occurs while enforcing the output policy. - - - - - Contains status information about the enforcement of an output policy. - - - - - A media source started to buffer data. - - - - - A media source stopped buffering data. - - - - - The network source started opening a URL. - - - - - The network source finished opening a URL. - - - - - Raised by a media source at the start of a reconnection attempt. - - - - - Raised by a media source at the end of a reconnection attempt. - - - - - Raised by the enhanced video renderer (EVR) when it receives a user event from the presenter. - - - - - Raised by the Media Session when the format changes on a media sink. - - - - - Source Unknown - - - - - Raised when a media source starts without seeking. - - - - - Raised by a media stream when the source starts without seeking. - - - - - Raised when a media source seeks to a new position. - - - - - Raised by a media stream after a call to IMFMediaSource::Start causes a seek in the stream. - - - - - Raised by a media source when it starts a new stream. - - - - - Raised by a media source when it restarts or seeks a stream that is already active. - - - - - Raised by a media source when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Stop method completes asynchronously. - - - - - Raised by a media source when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media stream when the IMFMediaSource::Pause method completes asynchronously. - - - - - Raised by a media source when a presentation ends. - - - - - Raised by a media stream when the stream ends. - - - - - Raised when a media stream delivers a new sample. - - - - - Signals that a media stream does not have data available at a specified time. - - - - - Raised by a media stream when it starts or stops thinning the stream. - - - - - Raised by a media stream when the media type of the stream changes. - - - - - Raised by a media source when the playback rate changes. - - - - - Raised by the sequencer source when a segment is completed and is followed by another segment. - - - - - Raised by a media source when the source's characteristics change. - - - - - Raised by a media source to request a new playback rate. - - - - - Raised by a media source when it updates its metadata. - - - - - Raised by the sequencer source when the IMFSequencerSource::UpdateTopology method completes asynchronously. - - - - - Sink Unknown - - - - - Raised by a stream sink when it completes the transition to the running state. - - - - - Raised by a stream sink when it completes the transition to the stopped state. - - - - - Raised by a stream sink when it completes the transition to the paused state. - - - - - Raised by a stream sink when the rate has changed. - - - - - Raised by a stream sink to request a new media sample from the pipeline. - - - - - Raised by a stream sink after the IMFStreamSink::PlaceMarker method is called. - - - - - Raised by a stream sink when the stream has received enough preroll data to begin rendering. - - - - - Raised by a stream sink when it completes a scrubbing request. - - - - - Raised by a stream sink when the sink's media type is no longer valid. - - - - - Raised by the stream sinks of the EVR if the video device changes. - - - - - Provides feedback about playback quality to the quality manager. - - - - - Raised when a media sink becomes invalid. - - - - - The audio session display name changed. - - - - - The volume or mute state of the audio session changed - - - - - The audio device was removed. - - - - - The Windows audio server system was shut down. - - - - - The grouping parameters changed for the audio session. - - - - - The audio session icon changed. - - - - - The default audio format for the audio device changed. - - - - - The audio session was disconnected from a Windows Terminal Services session - - - - - The audio session was preempted by an exclusive-mode connection. - - - - - Trust Unknown - - - - - The output policy for a stream changed. - - - - - Content protection message - - - - - The IMFOutputTrustAuthority::SetPolicy method completed. - - - - - DRM License Backup Completed - - - - - DRM License Backup Progress - - - - - DRM License Restore Completed - - - - - DRM License Restore Progress - - - - - DRM License Acquisition Completed - - - - - DRM Individualization Completed - - - - - DRM Individualization Progress - - - - - DRM Proximity Completed - - - - - DRM License Store Cleaned - - - - - DRM Revocation Download Completed - - - - - Transform Unknown - - - - - Sent by an asynchronous MFT to request a new input sample. - - - - - Sent by an asynchronous MFT when new output data is available from the MFT. - - - - - Sent by an asynchronous Media Foundation transform (MFT) when a drain operation is complete. - - - - - Sent by an asynchronous MFT in response to an MFT_MESSAGE_COMMAND_MARKER message. - - - - - Media Foundation attribute guids - http://msdn.microsoft.com/en-us/library/windows/desktop/ms696989%28v=vs.85%29.aspx - - - - - Specifies whether an MFT performs asynchronous processing. - - - - - Enables the use of an asynchronous MFT. - - - - - Contains flags for an MFT activation object. - - - - - Specifies the category for an MFT. - - - - - Contains the class identifier (CLSID) of an MFT. - - - - - Contains the registered input types for a Media Foundation transform (MFT). - - - - - Contains the registered output types for a Media Foundation transform (MFT). - - - - - Contains the symbolic link for a hardware-based MFT. - - - - - Contains the display name for a hardware-based MFT. - - - - - Contains a pointer to the stream attributes of the connected stream on a hardware-based MFT. - - - - - Specifies whether a hardware-based MFT is connected to another hardware-based MFT. - - - - - Specifies the preferred output format for an encoder. - - - - - Specifies whether an MFT is registered only in the application's process. - - - - - Contains configuration properties for an encoder. - - - - - Specifies whether a hardware device source uses the system time for time stamps. - - - - - Contains an IMFFieldOfUseMFTUnlock pointer, which can be used to unlock the MFT. - - - - - Contains the merit value of a hardware codec. - - - - - Specifies whether a decoder is optimized for transcoding rather than for playback. - - - - - Contains a pointer to the proxy object for the application's presentation descriptor. - - - - - Contains a pointer to the presentation descriptor from the protected media path (PMP). - - - - - Specifies the duration of a presentation, in 100-nanosecond units. - - - - - Specifies the total size of the source file, in bytes. - - - - - Specifies the audio encoding bit rate for the presentation, in bits per second. - - - - - Specifies the video encoding bit rate for the presentation, in bits per second. - - - - - Specifies the MIME type of the content. - - - - - Specifies when a presentation was last modified. - - - - - The identifier of the playlist element in the presentation. - - - - - Contains the preferred RFC 1766 language of the media source. - - - - - The time at which the presentation must begin, relative to the start of the media source. - - - - - Specifies whether the audio streams in the presentation have a variable bit rate. - - - - - Media type Major Type - - - - - Media Type subtype - - - - - Audio block alignment - - - - - Audio average bytes per second - - - - - Audio number of channels - - - - - Audio samples per second - - - - - Audio bits per sample - - - - - Enables the source reader or sink writer to use hardware-based Media Foundation transforms (MFTs). - - - - - Contains additional format data for a media type. - - - - - Specifies for a media type whether each sample is independent of the other samples in the stream. - - - - - Specifies for a media type whether the samples have a fixed size. - - - - - Contains a DirectShow format GUID for a media type. - - - - - Specifies the preferred legacy format structure to use when converting an audio media type. - - - - - Specifies for a media type whether the media data is compressed. - - - - - Approximate data rate of the video stream, in bits per second, for a video media type. - - - - - Specifies the payload type of an Advanced Audio Coding (AAC) stream. - 0 - The stream contains raw_data_block elements only - 1 - Audio Data Transport Stream (ADTS). The stream contains an adts_sequence, as defined by MPEG-2. - 2 - Audio Data Interchange Format (ADIF). The stream contains an adif_sequence, as defined by MPEG-2. - 3 - The stream contains an MPEG-4 audio transport stream with a synchronization layer (LOAS) and a multiplex layer (LATM). - - - - - Specifies the audio profile and level of an Advanced Audio Coding (AAC) stream, as defined by ISO/IEC 14496-3. - - - - - Media Foundation Errors - - - - RANGES - 14000 - 14999 = General Media Foundation errors - 15000 - 15999 = ASF parsing errors - 16000 - 16999 = Media Source errors - 17000 - 17999 = MEDIAFOUNDATION Network Error Events - 18000 - 18999 = MEDIAFOUNDATION WMContainer Error Events - 19000 - 19999 = MEDIAFOUNDATION Media Sink Error Events - 20000 - 20999 = Renderer errors - 21000 - 21999 = Topology Errors - 25000 - 25999 = Timeline Errors - 26000 - 26999 = Unused - 28000 - 28999 = Transform errors - 29000 - 29999 = Content Protection errors - 40000 - 40999 = Clock errors - 41000 - 41999 = MF Quality Management Errors - 42000 - 42999 = MF Transcode API Errors - - - - - MessageId: MF_E_PLATFORM_NOT_INITIALIZED - - MessageText: - - Platform not initialized. Please call MFStartup().%0 - - - - - MessageId: MF_E_BUFFERTOOSMALL - - MessageText: - - The buffer was too small to carry out the requested action.%0 - - - - - MessageId: MF_E_INVALIDREQUEST - - MessageText: - - The request is invalid in the current state.%0 - - - - - MessageId: MF_E_INVALIDSTREAMNUMBER - - MessageText: - - The stream number provided was invalid.%0 - - - - - MessageId: MF_E_INVALIDMEDIATYPE - - MessageText: - - The data specified for the media type is invalid, inconsistent, or not supported by this object.%0 - - - - - MessageId: MF_E_NOTACCEPTING - - MessageText: - - The callee is currently not accepting further input.%0 - - - - - MessageId: MF_E_NOT_INITIALIZED - - MessageText: - - This object needs to be initialized before the requested operation can be carried out.%0 - - - - - MessageId: MF_E_UNSUPPORTED_REPRESENTATION - - MessageText: - - The requested representation is not supported by this object.%0 - - - - - MessageId: MF_E_NO_MORE_TYPES - - MessageText: - - An object ran out of media types to suggest therefore the requested chain of streaming objects cannot be completed.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SERVICE - - MessageText: - - The object does not support the specified service.%0 - - - - - MessageId: MF_E_UNEXPECTED - - MessageText: - - An unexpected error has occurred in the operation requested.%0 - - - - - MessageId: MF_E_INVALIDNAME - - MessageText: - - Invalid name.%0 - - - - - MessageId: MF_E_INVALIDTYPE - - MessageText: - - Invalid type.%0 - - - - - MessageId: MF_E_INVALID_FILE_FORMAT - - MessageText: - - The file does not conform to the relevant file format specification. - - - - - MessageId: MF_E_INVALIDINDEX - - MessageText: - - Invalid index.%0 - - - - - MessageId: MF_E_INVALID_TIMESTAMP - - MessageText: - - An invalid timestamp was given.%0 - - - - - MessageId: MF_E_UNSUPPORTED_SCHEME - - MessageText: - - The scheme of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_BYTESTREAM_TYPE - - MessageText: - - The byte stream type of the given URL is unsupported.%0 - - - - - MessageId: MF_E_UNSUPPORTED_TIME_FORMAT - - MessageText: - - The given time format is unsupported.%0 - - - - - MessageId: MF_E_NO_SAMPLE_TIMESTAMP - - MessageText: - - The Media Sample does not have a timestamp.%0 - - - - - MessageId: MF_E_NO_SAMPLE_DURATION - - MessageText: - - The Media Sample does not have a duration.%0 - - - - - MessageId: MF_E_INVALID_STREAM_DATA - - MessageText: - - The request failed because the data in the stream is corrupt.%0\n. - - - - - MessageId: MF_E_RT_UNAVAILABLE - - MessageText: - - Real time services are not available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE - - MessageText: - - The specified rate is not supported.%0 - - - - - MessageId: MF_E_THINNING_UNSUPPORTED - - MessageText: - - This component does not support stream-thinning.%0 - - - - - MessageId: MF_E_REVERSE_UNSUPPORTED - - MessageText: - - The call failed because no reverse playback rates are available.%0 - - - - - MessageId: MF_E_UNSUPPORTED_RATE_TRANSITION - - MessageText: - - The requested rate transition cannot occur in the current state.%0 - - - - - MessageId: MF_E_RATE_CHANGE_PREEMPTED - - MessageText: - - The requested rate change has been pre-empted and will not occur.%0 - - - - - MessageId: MF_E_NOT_FOUND - - MessageText: - - The specified object or value does not exist.%0 - - - - - MessageId: MF_E_NOT_AVAILABLE - - MessageText: - - The requested value is not available.%0 - - - - - MessageId: MF_E_NO_CLOCK - - MessageText: - - The specified operation requires a clock and no clock is available.%0 - - - - - MessageId: MF_S_MULTIPLE_BEGIN - - MessageText: - - This callback and state had already been passed in to this event generator earlier.%0 - - - - - MessageId: MF_E_MULTIPLE_BEGIN - - MessageText: - - This callback has already been passed in to this event generator.%0 - - - - - MessageId: MF_E_MULTIPLE_SUBSCRIBERS - - MessageText: - - Some component is already listening to events on this event generator.%0 - - - - - MessageId: MF_E_TIMER_ORPHANED - - MessageText: - - This timer was orphaned before its callback time arrived.%0 - - - - - MessageId: MF_E_STATE_TRANSITION_PENDING - - MessageText: - - A state transition is already pending.%0 - - - - - MessageId: MF_E_UNSUPPORTED_STATE_TRANSITION - - MessageText: - - The requested state transition is unsupported.%0 - - - - - MessageId: MF_E_UNRECOVERABLE_ERROR_OCCURRED - - MessageText: - - An unrecoverable error has occurred.%0 - - - - - MessageId: MF_E_SAMPLE_HAS_TOO_MANY_BUFFERS - - MessageText: - - The provided sample has too many buffers.%0 - - - - - MessageId: MF_E_SAMPLE_NOT_WRITABLE - - MessageText: - - The provided sample is not writable.%0 - - - - - MessageId: MF_E_INVALID_KEY - - MessageText: - - The specified key is not valid. - - - - - MessageId: MF_E_BAD_STARTUP_VERSION - - MessageText: - - You are calling MFStartup with the wrong MF_VERSION. Mismatched bits? - - - - - MessageId: MF_E_UNSUPPORTED_CAPTION - - MessageText: - - The caption of the given URL is unsupported.%0 - - - - - MessageId: MF_E_INVALID_POSITION - - MessageText: - - The operation on the current offset is not permitted.%0 - - - - - MessageId: MF_E_ATTRIBUTENOTFOUND - - MessageText: - - The requested attribute was not found.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_ALLOWED - - MessageText: - - The specified property type is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_TYPE_NOT_SUPPORTED - - MessageText: - - The specified property type is not supported.%0 - - - - - MessageId: MF_E_PROPERTY_EMPTY - - MessageText: - - The specified property is empty.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_EMPTY - - MessageText: - - The specified property is not empty.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_NOT_ALLOWED - - MessageText: - - The vector property specified is not allowed in this context.%0 - - - - - MessageId: MF_E_PROPERTY_VECTOR_REQUIRED - - MessageText: - - A vector property is required in this context.%0 - - - - - MessageId: MF_E_OPERATION_CANCELLED - - MessageText: - - The operation is cancelled.%0 - - - - - MessageId: MF_E_BYTESTREAM_NOT_SEEKABLE - - MessageText: - - The provided bytestream was expected to be seekable and it is not.%0 - - - - - MessageId: MF_E_DISABLED_IN_SAFEMODE - - MessageText: - - The Media Foundation platform is disabled when the system is running in Safe Mode.%0 - - - - - MessageId: MF_E_CANNOT_PARSE_BYTESTREAM - - MessageText: - - The Media Source could not parse the byte stream.%0 - - - - - MessageId: MF_E_SOURCERESOLVER_MUTUALLY_EXCLUSIVE_FLAGS - - MessageText: - - Mutually exclusive flags have been specified to source resolver. This flag combination is invalid.%0 - - - - - MessageId: MF_E_MEDIAPROC_WRONGSTATE - - MessageText: - - MediaProc is in the wrong state%0 - - - - - MessageId: MF_E_RT_THROUGHPUT_NOT_AVAILABLE - - MessageText: - - Real time I/O service can not provide requested throughput.%0 - - - - - MessageId: MF_E_RT_TOO_MANY_CLASSES - - MessageText: - - The workqueue cannot be registered with more classes.%0 - - - - - MessageId: MF_E_RT_WOULDBLOCK - - MessageText: - - This operation cannot succeed because another thread owns this object.%0 - - - - - MessageId: MF_E_NO_BITPUMP - - MessageText: - - Internal. Bitpump not found.%0 - - - - - MessageId: MF_E_RT_OUTOFMEMORY - - MessageText: - - No more RT memory available.%0 - - - - - MessageId: MF_E_RT_WORKQUEUE_CLASS_NOT_SPECIFIED - - MessageText: - - An MMCSS class has not been set for this work queue.%0 - - - - - MessageId: MF_E_INSUFFICIENT_BUFFER - - MessageText: - - Insufficient memory for response.%0 - - - - - MessageId: MF_E_CANNOT_CREATE_SINK - - MessageText: - - Activate failed to create mediasink. Call OutputNode::GetUINT32(MF_TOPONODE_MAJORTYPE) for more information. %0 - - - - - MessageId: MF_E_BYTESTREAM_UNKNOWN_LENGTH - - MessageText: - - The length of the provided bytestream is unknown.%0 - - - - - MessageId: MF_E_SESSION_PAUSEWHILESTOPPED - - MessageText: - - The media session cannot pause from a stopped state.%0 - - - - - MessageId: MF_S_ACTIVATE_REPLACED - - MessageText: - - The activate could not be created in the remote process for some reason it was replaced with empty one.%0 - - - - - MessageId: MF_E_FORMAT_CHANGE_NOT_SUPPORTED - - MessageText: - - The data specified for the media type is supported, but would require a format change, which is not supported by this object.%0 - - - - - MessageId: MF_E_INVALID_WORKQUEUE - - MessageText: - - The operation failed because an invalid combination of workqueue ID and flags was specified.%0 - - - - - MessageId: MF_E_DRM_UNSUPPORTED - - MessageText: - - No DRM support is available.%0 - - - - - MessageId: MF_E_UNAUTHORIZED - - MessageText: - - This operation is not authorized.%0 - - - - - MessageId: MF_E_OUT_OF_RANGE - - MessageText: - - The value is not in the specified or valid range.%0 - - - - - MessageId: MF_E_INVALID_CODEC_MERIT - - MessageText: - - The registered codec merit is not valid.%0 - - - - - MessageId: MF_E_HW_MFT_FAILED_START_STREAMING - - MessageText: - - Hardware MFT failed to start streaming due to lack of hardware resources.%0 - - - - - MessageId: MF_S_ASF_PARSEINPROGRESS - - MessageText: - - Parsing is still in progress and is not yet complete.%0 - - - - - MessageId: MF_E_ASF_PARSINGINCOMPLETE - - MessageText: - - Not enough data have been parsed to carry out the requested action.%0 - - - - - MessageId: MF_E_ASF_MISSINGDATA - - MessageText: - - There is a gap in the ASF data provided.%0 - - - - - MessageId: MF_E_ASF_INVALIDDATA - - MessageText: - - The data provided are not valid ASF.%0 - - - - - MessageId: MF_E_ASF_OPAQUEPACKET - - MessageText: - - The packet is opaque, so the requested information cannot be returned.%0 - - - - - MessageId: MF_E_ASF_NOINDEX - - MessageText: - - The requested operation failed since there is no appropriate ASF index.%0 - - - - - MessageId: MF_E_ASF_OUTOFRANGE - - MessageText: - - The value supplied is out of range for this operation.%0 - - - - - MessageId: MF_E_ASF_INDEXNOTLOADED - - MessageText: - - The index entry requested needs to be loaded before it can be available.%0 - - - - - MessageId: MF_E_ASF_TOO_MANY_PAYLOADS - - MessageText: - - The packet has reached the maximum number of payloads.%0 - - - - - MessageId: MF_E_ASF_UNSUPPORTED_STREAM_TYPE - - MessageText: - - Stream type is not supported.%0 - - - - - MessageId: MF_E_ASF_DROPPED_PACKET - - MessageText: - - One or more ASF packets were dropped.%0 - - - - - MessageId: MF_E_NO_EVENTS_AVAILABLE - - MessageText: - - There are no events available in the queue.%0 - - - - - MessageId: MF_E_INVALID_STATE_TRANSITION - - MessageText: - - A media source cannot go from the stopped state to the paused state.%0 - - - - - MessageId: MF_E_END_OF_STREAM - - MessageText: - - The media stream cannot process any more samples because there are no more samples in the stream.%0 - - - - - MessageId: MF_E_SHUTDOWN - - MessageText: - - The request is invalid because Shutdown() has been called.%0 - - - - - MessageId: MF_E_MP3_NOTFOUND - - MessageText: - - The MP3 object was not found.%0 - - - - - MessageId: MF_E_MP3_OUTOFDATA - - MessageText: - - The MP3 parser ran out of data before finding the MP3 object.%0 - - - - - MessageId: MF_E_MP3_NOTMP3 - - MessageText: - - The file is not really a MP3 file.%0 - - - - - MessageId: MF_E_MP3_NOTSUPPORTED - - MessageText: - - The MP3 file is not supported.%0 - - - - - MessageId: MF_E_NO_DURATION - - MessageText: - - The Media stream has no duration.%0 - - - - - MessageId: MF_E_INVALID_FORMAT - - MessageText: - - The Media format is recognized but is invalid.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_FOUND - - MessageText: - - The property requested was not found.%0 - - - - - MessageId: MF_E_PROPERTY_READ_ONLY - - MessageText: - - The property is read only.%0 - - - - - MessageId: MF_E_PROPERTY_NOT_ALLOWED - - MessageText: - - The specified property is not allowed in this context.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NOT_STARTED - - MessageText: - - The media source is not started.%0 - - - - - MessageId: MF_E_UNSUPPORTED_FORMAT - - MessageText: - - The Media format is recognized but not supported.%0 - - - - - MessageId: MF_E_MP3_BAD_CRC - - MessageText: - - The MPEG frame has bad CRC.%0 - - - - - MessageId: MF_E_NOT_PROTECTED - - MessageText: - - The file is not protected.%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_WRONGSTATE - - MessageText: - - The media source is in the wrong state%0 - - - - - MessageId: MF_E_MEDIA_SOURCE_NO_STREAMS_SELECTED - - MessageText: - - No streams are selected in source presentation descriptor.%0 - - - - - MessageId: MF_E_CANNOT_FIND_KEYFRAME_SAMPLE - - MessageText: - - No key frame sample was found.%0 - - - - - MessageId: MF_E_NETWORK_RESOURCE_FAILURE - - MessageText: - - An attempt to acquire a network resource failed.%0 - - - - - MessageId: MF_E_NET_WRITE - - MessageText: - - Error writing to the network.%0 - - - - - MessageId: MF_E_NET_READ - - MessageText: - - Error reading from the network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_NETWORK - - MessageText: - - Internal. Entry cannot complete operation without network.%0 - - - - - MessageId: MF_E_NET_REQUIRE_ASYNC - - MessageText: - - Internal. Async op is required.%0 - - - - - MessageId: MF_E_NET_BWLEVEL_NOT_SUPPORTED - - MessageText: - - Internal. Bandwidth levels are not supported.%0 - - - - - MessageId: MF_E_NET_STREAMGROUPS_NOT_SUPPORTED - - MessageText: - - Internal. Stream groups are not supported.%0 - - - - - MessageId: MF_E_NET_MANUALSS_NOT_SUPPORTED - - MessageText: - - Manual stream selection is not supported.%0 - - - - - MessageId: MF_E_NET_INVALID_PRESENTATION_DESCRIPTOR - - MessageText: - - Invalid presentation descriptor.%0 - - - - - MessageId: MF_E_NET_CACHESTREAM_NOT_FOUND - - MessageText: - - Cannot find cache stream.%0 - - - - - MessageId: MF_I_MANUAL_PROXY - - MessageText: - - The proxy setting is manual.%0 - - - - duplicate removed - MessageId=17011 Severity=Informational Facility=MEDIAFOUNDATION SymbolicName=MF_E_INVALID_REQUEST - Language=English - The request is invalid in the current state.%0 - . - - MessageId: MF_E_NET_REQUIRE_INPUT - - MessageText: - - Internal. Entry cannot complete operation without input.%0 - - - - - MessageId: MF_E_NET_REDIRECT - - MessageText: - - The client redirected to another server.%0 - - - - - MessageId: MF_E_NET_REDIRECT_TO_PROXY - - MessageText: - - The client is redirected to a proxy server.%0 - - - - - MessageId: MF_E_NET_TOO_MANY_REDIRECTS - - MessageText: - - The client reached maximum redirection limit.%0 - - - - - MessageId: MF_E_NET_TIMEOUT - - MessageText: - - The server, a computer set up to offer multimedia content to other computers, could not handle your request for multimedia content in a timely manner. Please try again later.%0 - - - - - MessageId: MF_E_NET_CLIENT_CLOSE - - MessageText: - - The control socket is closed by the client.%0 - - - - - MessageId: MF_E_NET_BAD_CONTROL_DATA - - MessageText: - - The server received invalid data from the client on the control connection.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_SERVER - - MessageText: - - The server is not a compatible streaming media server.%0 - - - - - MessageId: MF_E_NET_UNSAFE_URL - - MessageText: - - Url.%0 - - - - - MessageId: MF_E_NET_CACHE_NO_DATA - - MessageText: - - Data is not available.%0 - - - - - MessageId: MF_E_NET_EOL - - MessageText: - - End of line.%0 - - - - - MessageId: MF_E_NET_BAD_REQUEST - - MessageText: - - The request could not be understood by the server.%0 - - - - - MessageId: MF_E_NET_INTERNAL_SERVER_ERROR - - MessageText: - - The server encountered an unexpected condition which prevented it from fulfilling the request.%0 - - - - - MessageId: MF_E_NET_SESSION_NOT_FOUND - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_NET_NOCONNECTION - - MessageText: - - There is no connection established with the Windows Media server. The operation failed.%0 - - - - - MessageId: MF_E_NET_CONNECTION_FAILURE - - MessageText: - - The network connection has failed.%0 - - - - - MessageId: MF_E_NET_INCOMPATIBLE_PUSHSERVER - - MessageText: - - The Server service that received the HTTP push request is not a compatible version of Windows Media Services (WMS). This error may indicate the push request was received by IIS instead of WMS. Ensure WMS is started and has the HTTP Server control protocol properly enabled and try again.%0 - - - - - MessageId: MF_E_NET_SERVER_ACCESSDENIED - - MessageText: - - The Windows Media server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_PROXY_ACCESSDENIED - - MessageText: - - The proxy server is denying access. The username and/or password might be incorrect.%0 - - - - - MessageId: MF_E_NET_CANNOTCONNECT - - MessageText: - - Unable to establish a connection to the server.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_TEMPLATE - - MessageText: - - The specified push template is invalid.%0 - - - - - MessageId: MF_E_NET_INVALID_PUSH_PUBLISHING_POINT - - MessageText: - - The specified push publishing point is invalid.%0 - - - - - MessageId: MF_E_NET_BUSY - - MessageText: - - The requested resource is in use.%0 - - - - - MessageId: MF_E_NET_RESOURCE_GONE - - MessageText: - - The Publishing Point or file on the Windows Media Server is no longer available.%0 - - - - - MessageId: MF_E_NET_ERROR_FROM_PROXY - - MessageText: - - The proxy experienced an error while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_PROXY_TIMEOUT - - MessageText: - - The proxy did not receive a timely response while attempting to contact the media server.%0 - - - - - MessageId: MF_E_NET_SERVER_UNAVAILABLE - - MessageText: - - The server is currently unable to handle the request due to a temporary overloading or maintenance of the server.%0 - - - - - MessageId: MF_E_NET_TOO_MUCH_DATA - - MessageText: - - The encoding process was unable to keep up with the amount of supplied data.%0 - - - - - MessageId: MF_E_NET_SESSION_INVALID - - MessageText: - - Session not found.%0 - - - - - MessageId: MF_E_OFFLINE_MODE - - MessageText: - - The requested URL is not available in offline mode.%0 - - - - - MessageId: MF_E_NET_UDP_BLOCKED - - MessageText: - - A device in the network is blocking UDP traffic.%0 - - - - - MessageId: MF_E_NET_UNSUPPORTED_CONFIGURATION - - MessageText: - - The specified configuration value is not supported.%0 - - - - - MessageId: MF_E_NET_PROTOCOL_DISABLED - - MessageText: - - The networking protocol is disabled.%0 - - - - - MessageId: MF_E_ALREADY_INITIALIZED - - MessageText: - - This object has already been initialized and cannot be re-initialized at this time.%0 - - - - - MessageId: MF_E_BANDWIDTH_OVERRUN - - MessageText: - - The amount of data passed in exceeds the given bitrate and buffer window.%0 - - - - - MessageId: MF_E_LATE_SAMPLE - - MessageText: - - The sample was passed in too late to be correctly processed.%0 - - - - - MessageId: MF_E_FLUSH_NEEDED - - MessageText: - - The requested action cannot be carried out until the object is flushed and the queue is emptied.%0 - - - - - MessageId: MF_E_INVALID_PROFILE - - MessageText: - - The profile is invalid.%0 - - - - - MessageId: MF_E_INDEX_NOT_COMMITTED - - MessageText: - - The index that is being generated needs to be committed before the requested action can be carried out.%0 - - - - - MessageId: MF_E_NO_INDEX - - MessageText: - - The index that is necessary for the requested action is not found.%0 - - - - - MessageId: MF_E_CANNOT_INDEX_IN_PLACE - - MessageText: - - The requested index cannot be added in-place to the specified ASF content.%0 - - - - - MessageId: MF_E_MISSING_ASF_LEAKYBUCKET - - MessageText: - - The ASF leaky bucket parameters must be specified in order to carry out this request.%0 - - - - - MessageId: MF_E_INVALID_ASF_STREAMID - - MessageText: - - The stream id is invalid. The valid range for ASF stream id is from 1 to 127.%0 - - - - - MessageId: MF_E_STREAMSINK_REMOVED - - MessageText: - - The requested Stream Sink has been removed and cannot be used.%0 - - - - - MessageId: MF_E_STREAMSINKS_OUT_OF_SYNC - - MessageText: - - The various Stream Sinks in this Media Sink are too far out of sync for the requested action to take place.%0 - - - - - MessageId: MF_E_STREAMSINKS_FIXED - - MessageText: - - Stream Sinks cannot be added to or removed from this Media Sink because its set of streams is fixed.%0 - - - - - MessageId: MF_E_STREAMSINK_EXISTS - - MessageText: - - The given Stream Sink already exists.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_CANCELED - - MessageText: - - Sample allocations have been canceled.%0 - - - - - MessageId: MF_E_SAMPLEALLOCATOR_EMPTY - - MessageText: - - The sample allocator is currently empty, due to outstanding requests.%0 - - - - - MessageId: MF_E_SINK_ALREADYSTOPPED - - MessageText: - - When we try to sopt a stream sink, it is already stopped %0 - - - - - MessageId: MF_E_ASF_FILESINK_BITRATE_UNKNOWN - - MessageText: - - The ASF file sink could not reserve AVIO because the bitrate is unknown.%0 - - - - - MessageId: MF_E_SINK_NO_STREAMS - - MessageText: - - No streams are selected in sink presentation descriptor.%0 - - - - - MessageId: MF_S_SINK_NOT_FINALIZED - - MessageText: - - The sink has not been finalized before shut down. This may cause sink generate a corrupted content.%0 - - - - - MessageId: MF_E_METADATA_TOO_LONG - - MessageText: - - A metadata item was too long to write to the output container.%0 - - - - - MessageId: MF_E_SINK_NO_SAMPLES_PROCESSED - - MessageText: - - The operation failed because no samples were processed by the sink.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_PROCAMP_HW - - MessageText: - - There is no available procamp hardware with which to perform color correction.%0 - - - - - MessageId: MF_E_VIDEO_REN_NO_DEINTERLACE_HW - - MessageText: - - There is no available deinterlacing hardware with which to deinterlace the video stream.%0 - - - - - MessageId: MF_E_VIDEO_REN_COPYPROT_FAILED - - MessageText: - - A video stream requires copy protection to be enabled, but there was a failure in attempting to enable copy protection.%0 - - - - - MessageId: MF_E_VIDEO_REN_SURFACE_NOT_SHARED - - MessageText: - - A component is attempting to access a surface for sharing that is not shared.%0 - - - - - MessageId: MF_E_VIDEO_DEVICE_LOCKED - - MessageText: - - A component is attempting to access a shared device that is already locked by another component.%0 - - - - - MessageId: MF_E_NEW_VIDEO_DEVICE - - MessageText: - - The device is no longer available. The handle should be closed and a new one opened.%0 - - - - - MessageId: MF_E_NO_VIDEO_SAMPLE_AVAILABLE - - MessageText: - - A video sample is not currently queued on a stream that is required for mixing.%0 - - - - - MessageId: MF_E_NO_AUDIO_PLAYBACK_DEVICE - - MessageText: - - No audio playback device was found.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_IN_USE - - MessageText: - - The requested audio playback device is currently in use.%0 - - - - - MessageId: MF_E_AUDIO_PLAYBACK_DEVICE_INVALIDATED - - MessageText: - - The audio playback device is no longer present.%0 - - - - - MessageId: MF_E_AUDIO_SERVICE_NOT_RUNNING - - MessageText: - - The audio service is not running.%0 - - - - - MessageId: MF_E_TOPO_INVALID_OPTIONAL_NODE - - MessageText: - - The topology contains an invalid optional node. Possible reasons are incorrect number of outputs and inputs or optional node is at the beginning or end of a segment. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_FIND_DECRYPTOR - - MessageText: - - No suitable transform was found to decrypt the content. %0 - - - - - MessageId: MF_E_TOPO_CODEC_NOT_FOUND - - MessageText: - - No suitable transform was found to encode or decode the content. %0 - - - - - MessageId: MF_E_TOPO_CANNOT_CONNECT - - MessageText: - - Unable to find a way to connect nodes%0 - - - - - MessageId: MF_E_TOPO_UNSUPPORTED - - MessageText: - - Unsupported operations in topoloader%0 - - - - - MessageId: MF_E_TOPO_INVALID_TIME_ATTRIBUTES - - MessageText: - - The topology or its nodes contain incorrectly set time attributes%0 - - - - - MessageId: MF_E_TOPO_LOOPS_IN_TOPOLOGY - - MessageText: - - The topology contains loops, which are unsupported in media foundation topologies%0 - - - - - MessageId: MF_E_TOPO_MISSING_PRESENTATION_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_STREAM_DESCRIPTOR - - MessageText: - - A source stream node in the topology does not have a stream descriptor%0 - - - - - MessageId: MF_E_TOPO_STREAM_DESCRIPTOR_NOT_SELECTED - - MessageText: - - A stream descriptor was set on a source stream node but it was not selected on the presentation descriptor%0 - - - - - MessageId: MF_E_TOPO_MISSING_SOURCE - - MessageText: - - A source stream node in the topology does not have a source%0 - - - - - MessageId: MF_E_TOPO_SINK_ACTIVATES_UNSUPPORTED - - MessageText: - - The topology loader does not support sink activates on output nodes.%0 - - - - - MessageId: MF_E_SEQUENCER_UNKNOWN_SEGMENT_ID - - MessageText: - - The sequencer cannot find a segment with the given ID.%0\n. - - - - - MessageId: MF_S_SEQUENCER_CONTEXT_CANCELED - - MessageText: - - The context was canceled.%0\n. - - - - - MessageId: MF_E_NO_SOURCE_IN_CACHE - - MessageText: - - Cannot find source in source cache.%0\n. - - - - - MessageId: MF_S_SEQUENCER_SEGMENT_AT_END_OF_STREAM - - MessageText: - - Cannot update topology flags.%0\n. - - - - - MessageId: MF_E_TRANSFORM_TYPE_NOT_SET - - MessageText: - - A valid type has not been set for this stream or a stream that it depends on.%0 - - - - - MessageId: MF_E_TRANSFORM_STREAM_CHANGE - - MessageText: - - A stream change has occurred. Output cannot be produced until the streams have been renegotiated.%0 - - - - - MessageId: MF_E_TRANSFORM_INPUT_REMAINING - - MessageText: - - The transform cannot take the requested action until all of the input data it currently holds is processed or flushed.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_MISSING - - MessageText: - - The transform requires a profile but no profile was supplied or found.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_INVALID_OR_CORRUPT - - MessageText: - - The transform requires a profile but the supplied profile was invalid or corrupt.%0 - - - - - MessageId: MF_E_TRANSFORM_PROFILE_TRUNCATED - - MessageText: - - The transform requires a profile but the supplied profile ended unexpectedly while parsing.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_PID_NOT_RECOGNIZED - - MessageText: - - The property ID does not match any property supported by the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VARIANT_TYPE_WRONG - - MessageText: - - The variant does not have the type expected for this property ID.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_NOT_WRITEABLE - - MessageText: - - An attempt was made to set the value on a read-only property.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_ARRAY_VALUE_WRONG_NUM_DIM - - MessageText: - - The array property value has an unexpected number of dimensions.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_SIZE_WRONG - - MessageText: - - The array or blob property value has an unexpected size.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_OUT_OF_RANGE - - MessageText: - - The property value is out of range for this transform.%0 - - - - - MessageId: MF_E_TRANSFORM_PROPERTY_VALUE_INCOMPATIBLE - - MessageText: - - The property value is incompatible with some other property or mediatype set on the transform.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_OUTPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set output mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_INPUT_MEDIATYPE - - MessageText: - - The requested operation is not supported for the currently set input mediatype.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_MEDIATYPE_COMBINATION - - MessageText: - - The requested operation is not supported for the currently set combination of mediatypes.%0 - - - - - MessageId: MF_E_TRANSFORM_CONFLICTS_WITH_OTHER_CURRENTLY_ENABLED_FEATURES - - MessageText: - - The requested feature is not supported in combination with some other currently enabled feature.%0 - - - - - MessageId: MF_E_TRANSFORM_NEED_MORE_INPUT - - MessageText: - - The transform cannot produce output until it gets more input samples.%0 - - - - - MessageId: MF_E_TRANSFORM_NOT_POSSIBLE_FOR_CURRENT_SPKR_CONFIG - - MessageText: - - The requested operation is not supported for the current speaker configuration.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_CHANGE_MEDIATYPE_WHILE_PROCESSING - - MessageText: - - The transform cannot accept mediatype changes in the middle of processing.%0 - - - - - MessageId: MF_S_TRANSFORM_DO_NOT_PROPAGATE_EVENT - - MessageText: - - The caller should not propagate this event to downstream components.%0 - - - - - MessageId: MF_E_UNSUPPORTED_D3D_TYPE - - MessageText: - - The input type is not supported for D3D device.%0 - - - - - MessageId: MF_E_TRANSFORM_ASYNC_LOCKED - - MessageText: - - The caller does not appear to support this transform's asynchronous capabilities.%0 - - - - - MessageId: MF_E_TRANSFORM_CANNOT_INITIALIZE_ACM_DRIVER - - MessageText: - - An audio compression manager driver could not be initialized by the transform.%0 - - - - - MessageId: MF_E_LICENSE_INCORRECT_RIGHTS - - MessageText: - - You are not allowed to open this file. Contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_OUTOFDATE - - MessageText: - - The license for this media file has expired. Get a new license or contact the content provider for further assistance.%0 - - - - - MessageId: MF_E_LICENSE_REQUIRED - - MessageText: - - You need a license to perform the requested operation on this media file.%0 - - - - - MessageId: MF_E_DRM_HARDWARE_INCONSISTENT - - MessageText: - - The licenses for your media files are corrupted. Contact Microsoft product support.%0 - - - - - MessageId: MF_E_NO_CONTENT_PROTECTION_MANAGER - - MessageText: - - The APP needs to provide IMFContentProtectionManager callback to access the protected media file.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NO_RIGHTS - - MessageText: - - Client does not have rights to restore licenses.%0 - - - - - MessageId: MF_E_BACKUP_RESTRICTED_LICENSE - - MessageText: - - Licenses are restricted and hence can not be backed up.%0 - - - - - MessageId: MF_E_LICENSE_RESTORE_NEEDS_INDIVIDUALIZATION - - MessageText: - - License restore requires machine to be individualized.%0 - - - - - MessageId: MF_S_PROTECTION_NOT_REQUIRED - - MessageText: - - Protection for stream is not required.%0 - - - - - MessageId: MF_E_COMPONENT_REVOKED - - MessageText: - - Component is revoked.%0 - - - - - MessageId: MF_E_TRUST_DISABLED - - MessageText: - - Trusted functionality is currently disabled on this component.%0 - - - - - MessageId: MF_E_WMDRMOTA_NO_ACTION - - MessageText: - - No Action is set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_ALREADY_SET - - MessageText: - - Action is already set on WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_HEADER_NOT_AVAILABLE - - MessageText: - - DRM Heaader is not available.%0 - - - - - MessageId: MF_E_WMDRMOTA_DRM_ENCRYPTION_SCHEME_NOT_SUPPORTED - - MessageText: - - Current encryption scheme is not supported.%0 - - - - - MessageId: MF_E_WMDRMOTA_ACTION_MISMATCH - - MessageText: - - Action does not match with current configuration.%0 - - - - - MessageId: MF_E_WMDRMOTA_INVALID_POLICY - - MessageText: - - Invalid policy for WMDRM Output Trust Authority.%0 - - - - - MessageId: MF_E_POLICY_UNSUPPORTED - - MessageText: - - The policies that the Input Trust Authority requires to be enforced are unsupported by the outputs.%0 - - - - - MessageId: MF_E_OPL_NOT_SUPPORTED - - MessageText: - - The OPL that the license requires to be enforced are not supported by the Input Trust Authority.%0 - - - - - MessageId: MF_E_TOPOLOGY_VERIFICATION_FAILED - - MessageText: - - The topology could not be successfully verified.%0 - - - - - MessageId: MF_E_SIGNATURE_VERIFICATION_FAILED - - MessageText: - - Signature verification could not be completed successfully for this component.%0 - - - - - MessageId: MF_E_DEBUGGING_NOT_ALLOWED - - MessageText: - - Running this process under a debugger while using protected content is not allowed.%0 - - - - - MessageId: MF_E_CODE_EXPIRED - - MessageText: - - MF component has expired.%0 - - - - - MessageId: MF_E_GRL_VERSION_TOO_LOW - - MessageText: - - The current GRL on the machine does not meet the minimum version requirements.%0 - - - - - MessageId: MF_E_GRL_RENEWAL_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any renewal entries for the specified revocation.%0 - - - - - MessageId: MF_E_GRL_EXTENSIBLE_ENTRY_NOT_FOUND - - MessageText: - - The current GRL on the machine does not contain any extensible entries for the specified extension GUID.%0 - - - - - MessageId: MF_E_KERNEL_UNTRUSTED - - MessageText: - - The kernel isn't secure for high security level content.%0 - - - - - MessageId: MF_E_PEAUTH_UNTRUSTED - - MessageText: - - The response from protected environment driver isn't valid.%0 - - - - - MessageId: MF_E_NON_PE_PROCESS - - MessageText: - - A non-PE process tried to talk to PEAuth.%0 - - - - - MessageId: MF_E_REBOOT_REQUIRED - - MessageText: - - We need to reboot the machine.%0 - - - - - MessageId: MF_S_WAIT_FOR_POLICY_SET - - MessageText: - - Protection for this stream is not guaranteed to be enforced until the MEPolicySet event is fired.%0 - - - - - MessageId: MF_S_VIDEO_DISABLED_WITH_UNKNOWN_SOFTWARE_OUTPUT - - MessageText: - - This video stream is disabled because it is being sent to an unknown software output.%0 - - - - - MessageId: MF_E_GRL_INVALID_FORMAT - - MessageText: - - The GRL file is not correctly formed, it may have been corrupted or overwritten.%0 - - - - - MessageId: MF_E_GRL_UNRECOGNIZED_FORMAT - - MessageText: - - The GRL file is in a format newer than those recognized by this GRL Reader.%0 - - - - - MessageId: MF_E_ALL_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and required all processes that can run protected media to restart.%0 - - - - - MessageId: MF_E_PROCESS_RESTART_REQUIRED - - MessageText: - - The GRL was reloaded and the current process needs to restart.%0 - - - - - MessageId: MF_E_USERMODE_UNTRUSTED - - MessageText: - - The user space is untrusted for protected content play.%0 - - - - - MessageId: MF_E_PEAUTH_SESSION_NOT_STARTED - - MessageText: - - PEAuth communication session hasn't been started.%0 - - - - - MessageId: MF_E_PEAUTH_PUBLICKEY_REVOKED - - MessageText: - - PEAuth's public key is revoked.%0 - - - - - MessageId: MF_E_GRL_ABSENT - - MessageText: - - The GRL is absent.%0 - - - - - MessageId: MF_S_PE_TRUSTED - - MessageText: - - The Protected Environment is trusted.%0 - - - - - MessageId: MF_E_PE_UNTRUSTED - - MessageText: - - The Protected Environment is untrusted.%0 - - - - - MessageId: MF_E_PEAUTH_NOT_STARTED - - MessageText: - - The Protected Environment Authorization service (PEAUTH) has not been started.%0 - - - - - MessageId: MF_E_INCOMPATIBLE_SAMPLE_PROTECTION - - MessageText: - - The sample protection algorithms supported by components are not compatible.%0 - - - - - MessageId: MF_E_PE_SESSIONS_MAXED - - MessageText: - - No more protected environment sessions can be supported.%0 - - - - - MessageId: MF_E_HIGH_SECURITY_LEVEL_CONTENT_NOT_ALLOWED - - MessageText: - - WMDRM ITA does not allow protected content with high security level for this release.%0 - - - - - MessageId: MF_E_TEST_SIGNED_COMPONENTS_NOT_ALLOWED - - MessageText: - - WMDRM ITA cannot allow the requested action for the content as one or more components is not properly signed.%0 - - - - - MessageId: MF_E_ITA_UNSUPPORTED_ACTION - - MessageText: - - WMDRM ITA does not support the requested action.%0 - - - - - MessageId: MF_E_ITA_ERROR_PARSING_SAP_PARAMETERS - - MessageText: - - WMDRM ITA encountered an error in parsing the Secure Audio Path parameters.%0 - - - - - MessageId: MF_E_POLICY_MGR_ACTION_OUTOFBOUNDS - - MessageText: - - The Policy Manager action passed in is invalid.%0 - - - - - MessageId: MF_E_BAD_OPL_STRUCTURE_FORMAT - - MessageText: - - The structure specifying Output Protection Level is not the correct format.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_PROTECTION_GUID - - MessageText: - - WMDRM ITA does not recognize the Explicite Analog Video Output Protection guid specified in the license.%0 - - - - - MessageId: MF_E_NO_PMP_HOST - - MessageText: - - IMFPMPHost object not available.%0 - - - - - MessageId: MF_E_ITA_OPL_DATA_NOT_INITIALIZED - - MessageText: - - WMDRM ITA could not initialize the Output Protection Level data.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_ANALOG_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Analog Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_ITA_UNRECOGNIZED_DIGITAL_VIDEO_OUTPUT - - MessageText: - - WMDRM ITA does not recognize the Digital Video Output specified by the OTA.%0 - - - - - MessageId: MF_E_CLOCK_INVALID_CONTINUITY_KEY - - MessageText: - - The continuity key supplied is not currently valid.%0 - - - - - MessageId: MF_E_CLOCK_NO_TIME_SOURCE - - MessageText: - - No Presentation Time Source has been specified.%0 - - - - - MessageId: MF_E_CLOCK_STATE_ALREADY_SET - - MessageText: - - The clock is already in the requested state.%0 - - - - - MessageId: MF_E_CLOCK_NOT_SIMPLE - - MessageText: - - The clock has too many advanced features to carry out the request.%0 - - - - - MessageId: MF_S_CLOCK_STOPPED - - MessageText: - - Timer::SetTimer returns this success code if called happened while timer is stopped. Timer is not going to be dispatched until clock is running%0 - - - - - MessageId: MF_E_NO_MORE_DROP_MODES - - MessageText: - - The component does not support any more drop modes.%0 - - - - - MessageId: MF_E_NO_MORE_QUALITY_LEVELS - - MessageText: - - The component does not support any more quality levels.%0 - - - - - MessageId: MF_E_DROPTIME_NOT_SUPPORTED - - MessageText: - - The component does not support drop time functionality.%0 - - - - - MessageId: MF_E_QUALITYKNOB_WAIT_LONGER - - MessageText: - - Quality Manager needs to wait longer before bumping the Quality Level up.%0 - - - - - MessageId: MF_E_QM_INVALIDSTATE - - MessageText: - - Quality Manager is in an invalid state. Quality Management is off at this moment.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_CONTAINERTYPE - - MessageText: - - No transcode output container type is specified.%0 - - - - - MessageId: MF_E_TRANSCODE_PROFILE_NO_MATCHING_STREAMS - - MessageText: - - The profile does not have a media type configuration for any selected source streams.%0 - - - - - MessageId: MF_E_TRANSCODE_NO_MATCHING_ENCODER - - MessageText: - - Cannot find an encoder MFT that accepts the user preferred output type.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_INITIALIZED - - MessageText: - - Memory allocator is not initialized.%0 - - - - - MessageId: MF_E_ALLOCATOR_NOT_COMMITED - - MessageText: - - Memory allocator is not committed yet.%0 - - - - - MessageId: MF_E_ALLOCATOR_ALREADY_COMMITED - - MessageText: - - Memory allocator has already been committed.%0 - - - - - MessageId: MF_E_STREAM_ERROR - - MessageText: - - An error occurred in media stream.%0 - - - - - MessageId: MF_E_INVALID_STREAM_STATE - - MessageText: - - Stream is not in a state to handle the request.%0 - - - - - MessageId: MF_E_HW_STREAM_NOT_CONNECTED - - MessageText: - - Hardware stream is not connected yet.%0 - - - - - Main interface for using Media Foundation with NAudio - - - - - initializes MediaFoundation - only needs to be called once per process - - - - - uninitializes MediaFoundation - - - - - Creates a Media type - - - - - Creates a media type from a WaveFormat - - - - - Creates a memory buffer of the specified size - - Memory buffer size in bytes - The memory buffer - - - - Creates a sample object - - The sample object - - - - Creates a new attributes store - - Initial size - The attributes store - - - - Creates a media foundation byte stream based on a stream object - (usable with WinRT streams) - - The input stream - A media foundation byte stream - - - - Creates a source reader based on a byte stream - - The byte stream - A media foundation source reader - - - - Interop definitions for MediaFoundation - thanks to Lucian Wischik for the initial work on many of these definitions (also various interfaces) - n.b. the goal is to make as much of this internal as possible, and provide - better .NET APIs using the MediaFoundationApi class instead - - - - - Initializes Microsoft Media Foundation. - - - - - Shuts down the Microsoft Media Foundation platform - - - - - Creates an empty media type. - - - - - Initializes a media type from a WAVEFORMATEX structure. - - - - - Converts a Media Foundation audio media type to a WAVEFORMATEX structure. - - TODO: try making second parameter out WaveFormatExtraData - - - - Creates the source reader from a URL. - - - - - Creates the source reader from a byte stream. - - - - - Creates the sink writer from a URL or byte stream. - - - - - Creates a Microsoft Media Foundation byte stream that wraps an IRandomAccessStream object. - - - - - Creates an empty media sample. - - - - - Allocates system memory and creates a media buffer to manage it. - - - - - Creates an empty attribute store. - - - - - All streams - - - - - First audio stream - - - - - First video stream - - - - - Media source - - - - - Media Foundation SDK Version - - - - - Media Foundation API Version - - - - - Media Foundation Version - - - - - An abstract base class for simplifying working with Media Foundation Transforms - You need to override the method that actually creates and configures the transform - - - - - The Source Provider - - - - - The Output WaveFormat - - - - - Constructs a new MediaFoundationTransform wrapper - Will read one second at a time - - The source provider for input data to the transform - The desired output format - - - - To be implemented by overriding classes. Create the transform object, set up its input and output types, - and configure any custom properties in here - - An object implementing IMFTrasform - - - - Disposes this MediaFoundation transform - - - - - Disposes this Media Foundation Transform - - - - - Destructor - - - - - The output WaveFormat of this Media Foundation Transform - - - - - Reads data out of the source, passing it through the transform - - Output buffer - Offset within buffer to write to - Desired byte count - Number of bytes read - - - - Attempts to read from the transform - Some useful info here: - http://msdn.microsoft.com/en-gb/library/windows/desktop/aa965264%28v=vs.85%29.aspx#process_data - - - - - - Indicate that the source has been repositioned and completely drain out the transforms buffers - - - - - Media Foundation Transform Categories - - - - - MFT_CATEGORY_VIDEO_DECODER - - - - - MFT_CATEGORY_VIDEO_ENCODER - - - - - MFT_CATEGORY_VIDEO_EFFECT - - - - - MFT_CATEGORY_MULTIPLEXER - - - - - MFT_CATEGORY_DEMULTIPLEXER - - - - - MFT_CATEGORY_AUDIO_DECODER - - - - - MFT_CATEGORY_AUDIO_ENCODER - - - - - MFT_CATEGORY_AUDIO_EFFECT - - - - - MFT_CATEGORY_VIDEO_PROCESSOR - - - - - MFT_CATEGORY_OTHER - - - - - Media Type helper class, simplifying working with IMFMediaType - (will probably change in the future, to inherit from an attributes class) - Currently does not release the COM object, so you must do that yourself - - - - - Wraps an existing IMFMediaType object - - The IMFMediaType object - - - - Creates and wraps a new IMFMediaType object - - - - - Creates and wraps a new IMFMediaType object based on a WaveFormat - - WaveFormat - - - - Tries to get a UINT32 value, returning a default value if it doesn't exist - - Attribute key - Default value - Value or default if key doesn't exist - - - - The Sample Rate (valid for audio media types) - - - - - The number of Channels (valid for audio media types) - - - - - The number of bits per sample (n.b. not always valid for compressed audio types) - - - - - The average bytes per second (valid for audio media types) - - - - - The Media Subtype. For audio, is a value from the AudioSubtypes class - - - - - The Major type, e.g. audio or video (from the MediaTypes class) - - - - - Access to the actual IMFMediaType object - Use to pass to MF APIs or Marshal.ReleaseComObject when you are finished with it - - - - - Major Media Types - http://msdn.microsoft.com/en-us/library/windows/desktop/aa367377%28v=vs.85%29.aspx - - - - - Default - - - - - Audio - - - - - Video - - - - - Protected Media - - - - - Synchronized Accessible Media Interchange (SAMI) captions. - - - - - Script stream - - - - - Still image stream. - - - - - HTML stream. - - - - - Binary stream. - - - - - A stream that contains data files. - - - - - Contains information about an input stream on a Media Foundation transform (MFT) - - - - - Maximum amount of time between an input sample and the corresponding output sample, in 100-nanosecond units. - - - - - Bitwise OR of zero or more flags from the _MFT_INPUT_STREAM_INFO_FLAGS enumeration. - - - - - The minimum size of each input buffer, in bytes. - - - - - Maximum amount of input data, in bytes, that the MFT holds to perform lookahead. - - - - - The memory alignment required for input buffers. If the MFT does not require a specific alignment, the value is zero. - - - - - Defines messages for a Media Foundation transform (MFT). - - - - - Requests the MFT to flush all stored data. - - - - - Requests the MFT to drain any stored data. - - - - - Sets or clears the Direct3D Device Manager for DirectX Video Accereration (DXVA). - - - - - Drop samples - requires Windows 7 - - - - - Command Tick - requires Windows 8 - - - - - Notifies the MFT that streaming is about to begin. - - - - - Notifies the MFT that streaming is about to end. - - - - - Notifies the MFT that an input stream has ended. - - - - - Notifies the MFT that the first sample is about to be processed. - - - - - Marks a point in the stream. This message applies only to asynchronous MFTs. Requires Windows 7 - - - - - Contains information about an output buffer for a Media Foundation transform. - - - - - Output stream identifier. - - - - - Pointer to the IMFSample interface. - - - - - Before calling ProcessOutput, set this member to zero. - - - - - Before calling ProcessOutput, set this member to NULL. - - - - - Contains information about an output stream on a Media Foundation transform (MFT). - - - - - Bitwise OR of zero or more flags from the _MFT_OUTPUT_STREAM_INFO_FLAGS enumeration. - - - - - Minimum size of each output buffer, in bytes. - - - - - The memory alignment required for output buffers. - - - - - Contains media type information for registering a Media Foundation transform (MFT). - - - - - The major media type. - - - - - The Media Subtype - - - - - Contains statistics about the performance of the sink writer. - - - - - The size of the structure, in bytes. - - - - - The time stamp of the most recent sample given to the sink writer. - - - - - The time stamp of the most recent sample to be encoded. - - - - - The time stamp of the most recent sample given to the media sink. - - - - - The time stamp of the most recent stream tick. - - - - - The system time of the most recent sample request from the media sink. - - - - - The number of samples received. - - - - - The number of samples encoded. - - - - - The number of samples given to the media sink. - - - - - The number of stream ticks received. - - - - - The amount of data, in bytes, currently waiting to be processed. - - - - - The total amount of data, in bytes, that has been sent to the media sink. - - - - - The number of pending sample requests. - - - - - The average rate, in media samples per 100-nanoseconds, at which the application sent samples to the sink writer. - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the encoder - - - - - The average rate, in media samples per 100-nanoseconds, at which the sink writer sent samples to the media sink. - - - - - Contains flags for registering and enumeration Media Foundation transforms (MFTs). - - - - - None - - - - - The MFT performs synchronous data processing in software. - - - - - The MFT performs asynchronous data processing in software. - - - - - The MFT performs hardware-based data processing, using either the AVStream driver or a GPU-based proxy MFT. - - - - - The MFT that must be unlocked by the application before use. - - - - - For enumeration, include MFTs that were registered in the caller's process. - - - - - The MFT is optimized for transcoding rather than playback. - - - - - For enumeration, sort and filter the results. - - - - - Bitwise OR of all the flags, excluding MFT_ENUM_FLAG_SORTANDFILTER. - - - - - Indicates the status of an input stream on a Media Foundation transform (MFT). - - - - - None - - - - - The input stream can receive more data at this time. - - - - - Describes an input stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of input data must contain complete, unbroken units of data. - - - - - Each media sample that the client provides as input must contain exactly one unit of data, as defined for the MFT_INPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All input samples must be the same size. - - - - - MTF Input Stream Holds buffers - - - - - The MFT does not hold input samples after the IMFTransform::ProcessInput method returns. - - - - - This input stream can be removed by calling IMFTransform::DeleteInputStream. - - - - - This input stream is optional. - - - - - The MFT can perform in-place processing. - - - - - Defines flags for the IMFTransform::ProcessOutput method. - - - - - None - - - - - The MFT can still generate output from this stream without receiving any more input. - - - - - The format has changed on this output stream, or there is a new preferred format for this stream. - - - - - The MFT has removed this output stream. - - - - - There is no sample ready for this stream. - - - - - Indicates whether a Media Foundation transform (MFT) can produce output data. - - - - - None - - - - - There is a sample available for at least one output stream. - - - - - Describes an output stream on a Media Foundation transform (MFT). - - - - - No flags set - - - - - Each media sample (IMFSample interface) of output data from the MFT contains complete, unbroken units of data. - - - - - Each output sample contains exactly one unit of data, as defined for the MFT_OUTPUT_STREAM_WHOLE_SAMPLES flag. - - - - - All output samples are the same size. - - - - - The MFT can discard the output data from this output stream, if requested by the client. - - - - - This output stream is optional. - - - - - The MFT provides the output samples for this stream, either by allocating them internally or by operating directly on the input samples. - - - - - The MFT can either provide output samples for this stream or it can use samples that the client allocates. - - - - - The MFT does not require the client to process the output for this stream. - - - - - The MFT might remove this output stream during streaming. - - - - - Defines flags for processing output samples in a Media Foundation transform (MFT). - - - - - None - - - - - Do not produce output for streams in which the pSample member of the MFT_OUTPUT_DATA_BUFFER structure is NULL. - - - - - Regenerates the last output sample. - - - - - Process Output Status flags - - - - - None - - - - - The Media Foundation transform (MFT) has created one or more new output streams. - - - - - Defines flags for the setting or testing the media type on a Media Foundation transform (MFT). - - - - - None - - - - - Test the proposed media type, but do not set it. - - - - - Represents a MIDI Channel AfterTouch Event. - - - - - Creates a new ChannelAfterTouchEvent from raw MIDI data - - A binary reader - - - - Creates a new Channel After-Touch Event - - Absolute time - Channel - After-touch pressure - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The aftertouch pressure value - - - - - Represents a MIDI control change event - - - - - Reads a control change event from a MIDI stream - - Binary reader on the MIDI stream - - - - Creates a control change event - - Time - MIDI Channel Number - The MIDI Controller - Controller value - - - - Describes this control change event - - A string describing this event - - - - - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - The controller number - - - - - The controller value - - - - - Represents a MIDI key signature event event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new Key signature event with the specified data - - - - - Creates a deep clone of this MIDI event. - - - - - Number of sharps or flats - - - - - Major or Minor key - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event - - - - - Gets the type of this meta event - - - - - Empty constructor - - - - - Custom constructor for use by derived types, who will manage the data themselves - - Meta event type - Meta data length - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Reads a meta-event from a stream - - A binary reader based on the stream of MIDI data - A new MetaEvent object - - - - Describes this meta event - - - - - - - - - - MIDI MetaEvent Type - - - - Track sequence number - - - Text event - - - Copyright - - - Sequence track name - - - Track instrument name - - - Lyric - - - Marker - - - Cue point - - - Program (patch) name - - - Device (port) name - - - MIDI Channel (not official?) - - - MIDI Port (not official?) - - - End track - - - Set tempo - - - SMPTE offset - - - Time signature - - - Key signature - - - Sequencer specific - - - - MIDI command codes - - - - Note Off - - - Note On - - - Key After-touch - - - Control change - - - Patch change - - - Channel after-touch - - - Pitch wheel change - - - Sysex message - - - Eox (comes at end of a sysex message) - - - Timing clock (used when synchronization is required) - - - Start sequence - - - Continue sequence - - - Stop sequence - - - Auto-Sensing - - - Meta-event - - - - MidiController enumeration - http://www.midi.org/techspecs/midimessages.php#3 - - - - Bank Select (MSB) - - - Modulation (MSB) - - - Breath Controller - - - Foot controller (MSB) - - - Main volume - - - Pan - - - Expression - - - Bank Select LSB - - - Sustain - - - Portamento On/Off - - - Sostenuto On/Off - - - Soft Pedal On/Off - - - Legato Footswitch - - - Reset all controllers - - - All notes off - - - - Represents an individual MIDI event - - - - The MIDI command code - - - - Creates a MidiEvent from a raw message received using - the MME MIDI In APIs - - The short MIDI message - A new MIDI Event - - - - Constructs a MidiEvent from a BinaryStream - - The binary stream of MIDI data - The previous MIDI event (pass null for first event) - A new MidiEvent - - - - Converts this MIDI event to a short message (32 bit integer) that - can be sent by the Windows MIDI out short message APIs - Cannot be implemented for all MIDI messages - - A short message - - - - Default constructor - - - - - Creates a MIDI event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - - - - Creates a deep clone of this MIDI event. - - - - - The MIDI Channel Number for this event (1-16) - - - - - The Delta time for this event - - - - - The absolute time for this event - - - - - The command code for this event - - - - - Whether this is a note off event - - - - - Whether this is a note on event - - - - - Determines if this is an end track event - - - - - Displays a summary of the MIDI event - - A string containing a brief description of this MIDI event - - - - Utility function that can read a variable length integer from a binary stream - - The binary stream - The integer read - - - - Writes a variable length integer to a binary stream - - Binary stream - The value to write - - - - Exports this MIDI event's data - Overriden in derived classes, but they should call this version - - Absolute time used to calculate delta. - Is updated ready for the next delta calculation - Stream to write to - - - - A helper class to manage collection of MIDI events - It has the ability to organise them in tracks - - - - - Creates a new Midi Event collection - - Initial file type - Delta Ticks Per Quarter Note - - - - The number of tracks - - - - - The absolute time that should be considered as time zero - Not directly used here, but useful for timeshifting applications - - - - - The number of ticks per quarter note - - - - - Gets events on a specified track - - Track number - The list of events - - - - Gets events on a specific track - - Track number - The list of events - - - - Adds a new track - - The new track event list - - - - Adds a new track - - Initial events to add to the new track - The new track event list - - - - Removes a track - - Track number to remove - - - - Clears all events - - - - - The MIDI file type - - - - - Adds an event to the appropriate track depending on file type - - The event to be added - The original (or desired) track number - When adding events in type 0 mode, the originalTrack parameter - is ignored. If in type 1 mode, it will use the original track number to - store the new events. If the original track was 0 and this is a channel based - event, it will create new tracks if necessary and put it on the track corresponding - to its channel number - - - - Sorts, removes empty tracks and adds end track markers - - - - - Gets an enumerator for the lists of track events - - - - - Gets an enumerator for the lists of track events - - - - - Utility class for comparing MidiEvent objects - - - - - Compares two MidiEvents - Sorts by time, with EndTrack always sorted to the end - - - - - Class able to read a MIDI file - - - - - Opens a MIDI file for reading - - Name of MIDI file - - - - MIDI File format - - - - - Opens a MIDI file for reading - - Name of MIDI file - If true will error on non-paired note events - - - - Opens a MIDI file stream for reading - - The input stream containing a MIDI file - If true will error on non-paired note events - - - - The collection of events in this MIDI file - - - - - Number of tracks in this MIDI file - - - - - Delta Ticks Per Quarter Note - - - - - Describes the MIDI file - - A string describing the MIDI file and its events - - - - Exports a MIDI file - - Filename to export to - Events to export - - - - Represents a MIDI in device - - - - - Called when a MIDI message is received - - - - - An invalid MIDI message - - - - - Gets the number of MIDI input devices available in the system - - - - - Opens a specified MIDI in device - - The device number - - - - Closes this MIDI in device - - - - - Closes this MIDI in device - - - - - Start the MIDI in device - - - - - Stop the MIDI in device - - - - - Reset the MIDI in device - - - - - Gets the MIDI in device info - - - - - Closes the MIDI out device - - True if called from Dispose - - - - Cleanup - - - - - MIDI In Device Capabilities - - - - - wMid - - - - - wPid - - - - - vDriverVersion - - - - - Product Name - - - - - Support - Reserved - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - MIDI In Message Information - - - - - Create a new MIDI In Message EventArgs - - - - - - - The Raw message received from the MIDI In API - - - - - The raw message interpreted as a MidiEvent - - - - - The timestamp in milliseconds for this message - - - - - MIM_OPEN - - - - - MIM_CLOSE - - - - - MIM_DATA - - - - - MIM_LONGDATA - - - - - MIM_ERROR - - - - - MIM_LONGERROR - - - - - MIM_MOREDATA - - - - - MOM_OPEN - - - - - MOM_CLOSE - - - - - MOM_DONE - - - - - Represents a MIDI message - - - - - Creates a new MIDI message - - Status - Data parameter 1 - Data parameter 2 - - - - Creates a new MIDI message from a raw message - - A packed MIDI message from an MMIO function - - - - Creates a Note On message - - Note number (0 to 127) - Volume (0 to 127) - MIDI channel (1 to 16) - A new MidiMessage object - - - - Creates a Note Off message - - Note number - Volume - MIDI channel (1-16) - A new MidiMessage object - - - - Creates a patch change message - - The patch number - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Creates a Control Change message - - The controller number to change - The value to set the controller to - The MIDI channel number (1-16) - A new MidiMessageObject - - - - Returns the raw MIDI message data - - - - - Represents a MIDI out device - - - - - Gets the number of MIDI devices available in the system - - - - - Gets the MIDI Out device info - - - - - Opens a specified MIDI out device - - The device number - - - - Closes this MIDI out device - - - - - Closes this MIDI out device - - - - - Gets or sets the volume for this MIDI out device - - - - - Resets the MIDI out device - - - - - Sends a MIDI out message - - Message - Parameter 1 - Parameter 2 - - - - Sends a MIDI message to the MIDI out device - - The message to send - - - - Closes the MIDI out device - - True if called from Dispose - - - - Send a long message, for example sysex. - - The bytes to send. - - - - Cleanup - - - - - class representing the capabilities of a MIDI out device - MIDIOUTCAPS: http://msdn.microsoft.com/en-us/library/dd798467%28VS.85%29.aspx - - - - - MIDICAPS_VOLUME - - - - - separate left-right volume control - MIDICAPS_LRVOLUME - - - - - MIDICAPS_CACHE - - - - - MIDICAPS_STREAM - driver supports midiStreamOut directly - - - - - Gets the manufacturer of this device - - - - - Gets the product identifier (manufacturer specific) - - - - - Gets the product name - - - - - Returns the number of supported voices - - - - - Gets the polyphony of the device - - - - - Returns true if the device supports all channels - - - - - Queries whether a particular channel is supported - - Channel number to test - True if the channel is supported - - - - Returns true if the device supports patch caching - - - - - Returns true if the device supports separate left and right volume - - - - - Returns true if the device supports MIDI stream out - - - - - Returns true if the device supports volume control - - - - - Returns the type of technology used by this MIDI out device - - - - - Represents the different types of technology used by a MIDI out device - - from mmsystem.h - - - The device is a MIDI port - - - The device is a MIDI synth - - - The device is a square wave synth - - - The device is an FM synth - - - The device is a MIDI mapper - - - The device is a WaveTable synth - - - The device is a software synth - - - - Represents a note MIDI event - - - - - Reads a NoteEvent from a stream of MIDI data - - Binary Reader for the stream - - - - Creates a MIDI Note Event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI command code - MIDI Note Number - MIDI Note Velocity - - - - - - - - - The MIDI note number - - - - - The note velocity - - - - - The note name - - - - - Describes the Note Event - - Note event as a string - - - - - - - - - Represents a MIDI note on event - - - - - Reads a new Note On event from a stream of MIDI data - - Binary reader on the MIDI data stream - - - - Creates a NoteOn event with specified parameters - - Absolute time of this event - MIDI channel number - MIDI note number - MIDI note velocity - MIDI note duration - - - - Creates a deep clone of this MIDI event. - - - - - The associated Note off event - - - - - Get or set the Note Number, updating the off event at the same time - - - - - Get or set the channel, updating the off event at the same time - - - - - The duration of this note - - - There must be a note off event - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI patch change event - - - - - Gets the default MIDI instrument names - - - - - Reads a new patch change event from a MIDI stream - - Binary reader for the MIDI stream - - - - Creates a new patch change event - - Time of the event - Channel number - Patch number - - - - The Patch Number - - - - - Describes this patch change event - - String describing the patch change event - - - - Gets as a short message for sending with the midiOutShortMsg API - - short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI pitch wheel change event - - - - - Reads a pitch wheel change event from a MIDI stream - - The MIDI stream to read from - - - - Creates a new pitch wheel change event - - Absolute event time - Channel - Pitch wheel value - - - - Describes this pitch wheel change event - - String describing this pitch wheel change event - - - - Pitch Wheel Value 0 is minimum, 0x2000 (8192) is default, 0x3FFF (16383) is maximum - - - - - Gets a short message - - Integer to sent as short message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI meta event with raw data - - - - - Raw data contained in the meta event - - - - - Creates a meta event with raw data - - - - - Creates a deep clone of this MIDI event. - - - - - Describes this meta event - - - - - - - - - - Represents a Sequencer Specific event - - - - - Reads a new sequencer specific event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new Sequencer Specific event - - The sequencer specific data - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this sequencer specific - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - SMPTE Offset Event - - - - - Creates a new time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a deep clone of this MIDI event. - - - - - Hours - - - - - Minutes - - - - - Seconds - - - - - Frames - - - - - SubFrames - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI sysex message - - - - - Reads a sysex message from a MIDI stream - - Stream of MIDI data - a new sysex message - - - - Creates a deep clone of this MIDI event. - - - - - Describes this sysex message - - A string describing the sysex message - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI tempo event - - - - - Reads a new tempo event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a new tempo event with specified settings - - Microseconds per quarter note - Absolute time - - - - Creates a deep clone of this MIDI event. - - - - - Describes this tempo event - - String describing the tempo event - - - - Microseconds per quarter note - - - - - Tempo - - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI text event - - - - - Reads a new text event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TextEvent - - The text in this type - MetaEvent type (must be one that is - associated with text data) - Absolute time of this event - - - - Creates a deep clone of this MIDI event. - - - - - The contents of this text event - - - - - The raw contents of this text event - - - - - Describes this MIDI text event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI time signature event - - - - - Reads a new time signature event from a MIDI stream - - The MIDI stream - The data length - - - - Creates a new TimeSignatureEvent - - Time at which to create this event - Numerator - Denominator - Ticks in Metronome Click - No of 32nd Notes in Quarter Click - - - - Creates a deep clone of this MIDI event. - - - - - Numerator (number of beats in a bar) - - - - - Denominator (Beat unit), - 1 means 2, 2 means 4 (crochet), 3 means 8 (quaver), 4 means 16 and 5 means 32 - - - - - Ticks in a metronome click - - - - - Number of 32nd notes in a quarter note - - - - - The time signature - - - - - Describes this time signature event - - A string describing this event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Represents a MIDI track sequence number event event - - - - - Creates a new track sequence number event - - - - - Reads a new track sequence number event from a MIDI stream - - The MIDI stream - the data length - - - - Creates a deep clone of this MIDI event. - - - - - Describes this event - - String describing the event - - - - Calls base class export first, then exports the data - specific to this event - MidiEvent.Export - - - - - Boolean mixer control - - - - - Gets the details for this control - - memory pointer - - - - The current value of the control - - - - - Custom Mixer control - - - - - Get the data for this custom control - - pointer to memory to receive data - - - - List text mixer control - - - - - Get the details for this control - - Memory location to read to - - - Represents a Windows mixer device - - - The number of mixer devices available - - - Connects to the specified mixer - The index of the mixer to use. - This should be between zero and NumberOfDevices - 1 - - - The number of destinations this mixer supports - - - The name of this mixer device - - - The manufacturer code for this mixer device - - - The product identifier code for this mixer device - - - Retrieve the specified MixerDestination object - The ID of the destination to use. - Should be between 0 and DestinationCount - 1 - - - - A way to enumerate the destinations - - - - - A way to enumerate all available devices - - - - - Represents a mixer control - - - - - Mixer Handle - - - - - Number of Channels - - - - - Mixer Handle Type - - - - - Gets all the mixer controls - - Mixer Handle - Mixer Line - Mixer Handle Type - - - - - Gets a specified Mixer Control - - Mixer Handle - Line ID - Control ID - Number of Channels - Flags to use (indicates the meaning of mixerHandle) - - - - - Gets the control details - - - - - Gets the control details - - - - - - Mixer control name - - - - - Mixer control type - - - - - Returns true if this is a boolean control - - Control type - - - - Is this a boolean control - - - - - Determines whether a specified mixer control type is a list text control - - - - - True if this is a list text control - - - - - True if this is a signed control - - - - - True if this is an unsigned control - - - - - True if this is a custom control - - - - - String representation for debug purposes - - - - - Mixer control types - - - - Custom - - - Boolean meter - - - Signed meter - - - Peak meter - - - Unsigned meter - - - Boolean - - - On Off - - - Mute - - - Mono - - - Loudness - - - Stereo Enhance - - - Button - - - Decibels - - - Signed - - - Unsigned - - - Percent - - - Slider - - - Pan - - - Q-sound pan - - - Fader - - - Volume - - - Bass - - - Treble - - - Equaliser - - - Single Select - - - Mux - - - Multiple select - - - Mixer - - - Micro time - - - Milli time - - - - Mixer Interop Flags - - - - - MIXER_OBJECTF_HANDLE = 0x80000000; - - - - - MIXER_OBJECTF_MIXER = 0x00000000; - - - - - MIXER_OBJECTF_HMIXER - - - - - MIXER_OBJECTF_WAVEOUT - - - - - MIXER_OBJECTF_HWAVEOUT - - - - - MIXER_OBJECTF_WAVEIN - - - - - MIXER_OBJECTF_HWAVEIN - - - - - MIXER_OBJECTF_MIDIOUT - - - - - MIXER_OBJECTF_HMIDIOUT - - - - - MIXER_OBJECTF_MIDIIN - - - - - MIXER_OBJECTF_HMIDIIN - - - - - MIXER_OBJECTF_AUX - - - - - MIXER_GETCONTROLDETAILSF_VALUE = 0x00000000; - MIXER_SETCONTROLDETAILSF_VALUE = 0x00000000; - - - - - MIXER_GETCONTROLDETAILSF_LISTTEXT = 0x00000001; - MIXER_SETCONTROLDETAILSF_LISTTEXT = 0x00000001; - - - - - MIXER_GETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_SETCONTROLDETAILSF_QUERYMASK = 0x0000000F; - MIXER_GETLINECONTROLSF_QUERYMASK = 0x0000000F; - - - - - MIXER_GETLINECONTROLSF_ALL = 0x00000000; - - - - - MIXER_GETLINECONTROLSF_ONEBYID = 0x00000001; - - - - - MIXER_GETLINECONTROLSF_ONEBYTYPE = 0x00000002; - - - - - MIXER_GETLINEINFOF_DESTINATION = 0x00000000; - - - - - MIXER_GETLINEINFOF_SOURCE = 0x00000001; - - - - - MIXER_GETLINEINFOF_LINEID = 0x00000002; - - - - - MIXER_GETLINEINFOF_COMPONENTTYPE = 0x00000003; - - - - - MIXER_GETLINEINFOF_TARGETTYPE = 0x00000004; - - - - - MIXER_GETLINEINFOF_QUERYMASK = 0x0000000F; - - - - - Mixer Line Flags - - - - - Audio line is active. An active line indicates that a signal is probably passing - through the line. - - - - - Audio line is disconnected. A disconnected line's associated controls can still be - modified, but the changes have no effect until the line is connected. - - - - - Audio line is an audio source line associated with a single audio destination line. - If this flag is not set, this line is an audio destination line associated with zero - or more audio source lines. - - - - - BOUNDS structure - - - - - dwMinimum / lMinimum / reserved 0 - - - - - dwMaximum / lMaximum / reserved 1 - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - METRICS structure - - - - - cSteps / reserved[0] - - - - - cbCustomData / reserved[1], number of bytes for control details - - - - - reserved 2 - - - - - reserved 3 - - - - - reserved 4 - - - - - reserved 5 - - - - - MIXERCONTROL struct - http://msdn.microsoft.com/en-us/library/dd757293%28VS.85%29.aspx - - - - - Represents a mixer line (source or destination) - - - - - Creates a new mixer destination - - Mixer Handle - Destination Index - Mixer Handle Type - - - - Creates a new Mixer Source For a Specified Source - - Mixer Handle - Destination Index - Source Index - Flag indicating the meaning of mixerHandle - - - - Creates a new Mixer Source - - Wave In Device - - - - Mixer Line Name - - - - - Mixer Line short name - - - - - The line ID - - - - - Component Type - - - - - Mixer destination type description - - - - - Number of channels - - - - - Number of sources - - - - - Number of controls - - - - - Is this destination active - - - - - Is this destination disconnected - - - - - Is this destination a source - - - - - Gets the specified source - - - - - Enumerator for the controls on this Mixer Limne - - - - - Enumerator for the sources on this Mixer Line - - - - - The name of the target output device - - - - - Describes this Mixer Line (for diagnostic purposes) - - - - - Mixer Line Component type enumeration - - - - - Audio line is a destination that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_DST_UNDEFINED - - - - - Audio line is a digital destination (for example, digital input to a DAT or CD audio device). - MIXERLINE_COMPONENTTYPE_DST_DIGITAL - - - - - Audio line is a line level destination (for example, line level input from a CD audio device) that will be the final recording source for the analog-to-digital converter (ADC). Because most audio cards for personal computers provide some sort of gain for the recording audio source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_DST_WAVEIN type. - MIXERLINE_COMPONENTTYPE_DST_LINE - - - - - Audio line is a destination used for a monitor. - MIXERLINE_COMPONENTTYPE_DST_MONITOR - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive speakers. This is the typical component type for the audio output of audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_SPEAKERS - - - - - Audio line is an adjustable (gain and/or attenuation) destination intended to drive headphones. Most audio cards use the same audio destination line for speakers and headphones, in which case the mixer device simply uses the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS type. - MIXERLINE_COMPONENTTYPE_DST_HEADPHONES - - - - - Audio line is a destination that will be routed to a telephone line. - MIXERLINE_COMPONENTTYPE_DST_TELEPHONE - - - - - Audio line is a destination that will be the final recording source for the waveform-audio input (ADC). This line typically provides some sort of gain or attenuation. This is the typical component type for the recording line of most audio cards for personal computers. - MIXERLINE_COMPONENTTYPE_DST_WAVEIN - - - - - Audio line is a destination that will be the final recording source for voice input. This component type is exactly like MIXERLINE_COMPONENTTYPE_DST_WAVEIN but is intended specifically for settings used during voice recording/recognition. Support for this line is optional for a mixer device. Many mixer devices provide only MIXERLINE_COMPONENTTYPE_DST_WAVEIN. - MIXERLINE_COMPONENTTYPE_DST_VOICEIN - - - - - Audio line is a source that cannot be defined by one of the standard component types. A mixer device is required to use this component type for line component types that have not been defined by Microsoft Corporation. - MIXERLINE_COMPONENTTYPE_SRC_UNDEFINED - - - - - Audio line is a digital source (for example, digital output from a DAT or audio CD). - MIXERLINE_COMPONENTTYPE_SRC_DIGITAL - - - - - Audio line is a line-level source (for example, line-level input from an external stereo) that can be used as an optional recording source. Because most audio cards for personal computers provide some sort of gain for the recording source line, the mixer device will use the MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY type. - MIXERLINE_COMPONENTTYPE_SRC_LINE - - - - - Audio line is a microphone recording source. Most audio cards for personal computers provide at least two types of recording sources: an auxiliary audio line and microphone input. A microphone audio line typically provides some sort of gain. Audio cards that use a single input for use with a microphone or auxiliary audio line should use the MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE component type. - MIXERLINE_COMPONENTTYPE_SRC_MICROPHONE - - - - - Audio line is a source originating from the output of an internal synthesizer. Most audio cards for personal computers provide some sort of MIDI synthesizer (for example, an Adlib®-compatible or OPL/3 FM synthesizer). - MIXERLINE_COMPONENTTYPE_SRC_SYNTHESIZER - - - - - Audio line is a source originating from the output of an internal audio CD. This component type is provided for audio cards that provide an audio source line intended to be connected to an audio CD (or CD-ROM playing an audio CD). - MIXERLINE_COMPONENTTYPE_SRC_COMPACTDISC - - - - - Audio line is a source originating from an incoming telephone line. - MIXERLINE_COMPONENTTYPE_SRC_TELEPHONE - - - - - Audio line is a source originating from personal computer speaker. Several audio cards for personal computers provide the ability to mix what would typically be played on the internal speaker with the output of an audio card. Some audio cards support the ability to use this output as a recording source. - MIXERLINE_COMPONENTTYPE_SRC_PCSPEAKER - - - - - Audio line is a source originating from the waveform-audio output digital-to-analog converter (DAC). Most audio cards for personal computers provide this component type as a source to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination. Some cards also allow this source to be routed to the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_WAVEOUT - - - - - Audio line is a source originating from the auxiliary audio line. This line type is intended as a source with gain or attenuation that can be routed to the MIXERLINE_COMPONENTTYPE_DST_SPEAKERS destination and/or recorded from the MIXERLINE_COMPONENTTYPE_DST_WAVEIN destination. - MIXERLINE_COMPONENTTYPE_SRC_AUXILIARY - - - - - Audio line is an analog source (for example, analog output from a video-cassette tape). - MIXERLINE_COMPONENTTYPE_SRC_ANALOG - - - - - Represents a signed mixer control - - - - - Gets details for this contrl - - - - - The value of the control - - - - - Minimum value for this control - - - - - Maximum value for this control - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - - Represents an unsigned mixer control - - - - - Gets the details for this control - - - - - The control value - - - - - The control's minimum value - - - - - The control's maximum value - - - - - Value of the control represented as a percentage - - - - - String Representation for debugging purposes - - - - - Helper methods for working with audio buffers - - - - - Ensures the buffer is big enough - - - - - - - - Ensures the buffer is big enough - - - - - - - - these will become extension methods once we move to .NET 3.5 - - - - - Checks if the buffer passed in is entirely full of nulls - - - - - Converts to a string containing the buffer described in hex - - - - - Decodes the buffer using the specified encoding, stopping at the first null - - - - - Concatenates the given arrays into a single array. - - The arrays to concatenate - The concatenated resulting array. - - - - An encoding for use with file types that have one byte per character - - - - - The one and only instance of this class - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Chunk Identifier helpers - - - - - Chunk identifier to Int32 (replaces mmioStringToFOURCC) - - four character chunk identifier - Chunk identifier as int 32 - - - - A very basic circular buffer implementation - - - - - Create a new circular buffer - - Max buffer size in bytes - - - - Write data to the buffer - - Data to write - Offset into data - Number of bytes to write - number of bytes written - - - - Read from the buffer - - Buffer to read into - Offset into read buffer - Bytes to read - Number of bytes actually read - - - - Maximum length of this circular buffer - - - - - Number of bytes currently stored in the circular buffer - - - - - Resets the buffer - - - - - Advances the buffer, discarding bytes - - Bytes to advance - - - - A util class for conversions - - - - - linear to dB conversion - - linear value - decibel value - - - - dB to linear conversion - - decibel value - linear value - - - - Allows us to add descriptions to interop members - - - - - The description - - - - - Field description - - - - - String representation - - - - - - Helper to get descriptions - - - - - Describes the Guid by looking for a FieldDescription attribute on the specified class - - - - - HResult - - - - - S_OK - - - - - S_FALSE - - - - - E_INVALIDARG (from winerror.h) - - - - - MAKE_HRESULT macro - - - - - Helper to deal with the fact that in Win Store apps, - the HResult property name has changed - - COM Exception - The HResult - - - - Methods for converting between IEEE 80-bit extended double precision - and standard C# double precision. - - - - - Converts a C# double precision number to an 80-bit - IEEE extended double precision number (occupying 10 bytes). - - The double precision number to convert to IEEE extended. - An array of 10 bytes containing the IEEE extended number. - - - - Converts an IEEE 80-bit extended precision number to a - C# double precision number. - - The 80-bit IEEE extended number (as an array of 10 bytes). - A C# double precision number that is a close representation of the IEEE extended number. - - - - Pass-through stream that ignores Dispose - Useful for dealing with MemoryStreams that you want to re-use - - - - - The source stream all other methods fall through to - - - - - If true the Dispose will be ignored, if false, will pass through to the SourceStream - Set to true by default - - - - - Creates a new IgnoreDisposeStream - - The source stream - - - - Can Read - - - - - Can Seek - - - - - Can write to the underlying stream - - - - - Flushes the underlying stream - - - - - Gets the length of the underlying stream - - - - - Gets or sets the position of the underlying stream - - - - - Reads from the underlying stream - - - - - Seeks on the underlying stream - - - - - Sets the length of the underlying stream - - - - - Writes to the underlying stream - - - - - Dispose - by default (IgnoreDispose = true) will do nothing, - leaving the underlying stream undisposed - - - - - Support for Marshal Methods in both UWP and .NET 3.5 - - - - - SizeOf a structure - - - - - Offset of a field in a structure - - - - - Pointer to Structure - - - - - In-place and stable implementation of MergeSort - - - - - MergeSort a list of comparable items - - - - - MergeSort a list - - - - - General purpose native methods for internal NAudio use - - - - - WavePosition extension methods - - - - - Get Position as timespan - - - - - Manufacturer codes from mmreg.h - - - - Microsoft Corporation - - - Creative Labs, Inc - - - Media Vision, Inc. - - - Fujitsu Corp. - - - Artisoft, Inc. - - - Turtle Beach, Inc. - - - IBM Corporation - - - Vocaltec LTD. - - - Roland - - - DSP Solutions, Inc. - - - NEC - - - ATI - - - Wang Laboratories, Inc - - - Tandy Corporation - - - Voyetra - - - Antex Electronics Corporation - - - ICL Personal Systems - - - Intel Corporation - - - Advanced Gravis - - - Video Associates Labs, Inc. - - - InterActive Inc - - - Yamaha Corporation of America - - - Everex Systems, Inc - - - Echo Speech Corporation - - - Sierra Semiconductor Corp - - - Computer Aided Technologies - - - APPS Software International - - - DSP Group, Inc - - - microEngineering Labs - - - Computer Friends, Inc. - - - ESS Technology - - - Audio, Inc. - - - Motorola, Inc. - - - Canopus, co., Ltd. - - - Seiko Epson Corporation - - - Truevision - - - Aztech Labs, Inc. - - - Videologic - - - SCALACS - - - Korg Inc. - - - Audio Processing Technology - - - Integrated Circuit Systems, Inc. - - - Iterated Systems, Inc. - - - Metheus - - - Logitech, Inc. - - - Winnov, Inc. - - - NCR Corporation - - - EXAN - - - AST Research Inc. - - - Willow Pond Corporation - - - Sonic Foundry - - - Vitec Multimedia - - - MOSCOM Corporation - - - Silicon Soft, Inc. - - - Supermac - - - Audio Processing Technology - - - Speech Compression - - - Ahead, Inc. - - - Dolby Laboratories - - - OKI - - - AuraVision Corporation - - - Ing C. Olivetti & C., S.p.A. - - - I/O Magic Corporation - - - Matsushita Electric Industrial Co., LTD. - - - Control Resources Limited - - - Xebec Multimedia Solutions Limited - - - New Media Corporation - - - Natural MicroSystems - - - Lyrrus Inc. - - - Compusic - - - OPTi Computers Inc. - - - Adlib Accessories Inc. - - - Compaq Computer Corp. - - - Dialogic Corporation - - - InSoft, Inc. - - - M.P. Technologies, Inc. - - - Weitek - - - Lernout & Hauspie - - - Quanta Computer Inc. - - - Apple Computer, Inc. - - - Digital Equipment Corporation - - - Mark of the Unicorn - - - Workbit Corporation - - - Ositech Communications Inc. - - - miro Computer Products AG - - - Cirrus Logic - - - ISOLUTION B.V. - - - Horizons Technology, Inc - - - Computer Concepts Ltd - - - Voice Technologies Group, Inc. - - - Radius - - - Rockwell International - - - Co. XYZ for testing - - - Opcode Systems - - - Voxware Inc - - - Northern Telecom Limited - - - APICOM - - - Grande Software - - - ADDX - - - Wildcat Canyon Software - - - Rhetorex Inc - - - Brooktree Corporation - - - ENSONIQ Corporation - - - FAST Multimedia AG - - - NVidia Corporation - - - OKSORI Co., Ltd. - - - DiAcoustics, Inc. - - - Gulbransen, Inc. - - - Kay Elemetrics, Inc. - - - Crystal Semiconductor Corporation - - - Splash Studios - - - Quarterdeck Corporation - - - TDK Corporation - - - Digital Audio Labs, Inc. - - - Seer Systems, Inc. - - - PictureTel Corporation - - - AT&T Microelectronics - - - Osprey Technologies, Inc. - - - Mediatrix Peripherals - - - SounDesignS M.C.S. Ltd. - - - A.L. Digital Ltd. - - - Spectrum Signal Processing, Inc. - - - Electronic Courseware Systems, Inc. - - - AMD - - - Core Dynamics - - - CANAM Computers - - - Softsound, Ltd. - - - Norris Communications, Inc. - - - Danka Data Devices - - - EuPhonics - - - Precept Software, Inc. - - - Crystal Net Corporation - - - Chromatic Research, Inc - - - Voice Information Systems, Inc - - - Vienna Systems - - - Connectix Corporation - - - Gadget Labs LLC - - - Frontier Design Group LLC - - - Viona Development GmbH - - - Casio Computer Co., LTD - - - Diamond Multimedia - - - S3 - - - Fraunhofer - - - - Summary description for MmException. - - - - - Creates a new MmException - - The result returned by the Windows API call - The name of the Windows API that failed - - - - Helper function to automatically raise an exception on failure - - The result of the API call - The API function name - - - - Returns the Windows API result - - - - - Windows multimedia error codes from mmsystem.h. - - - - no error, MMSYSERR_NOERROR - - - unspecified error, MMSYSERR_ERROR - - - device ID out of range, MMSYSERR_BADDEVICEID - - - driver failed enable, MMSYSERR_NOTENABLED - - - device already allocated, MMSYSERR_ALLOCATED - - - device handle is invalid, MMSYSERR_INVALHANDLE - - - no device driver present, MMSYSERR_NODRIVER - - - memory allocation error, MMSYSERR_NOMEM - - - function isn't supported, MMSYSERR_NOTSUPPORTED - - - error value out of range, MMSYSERR_BADERRNUM - - - invalid flag passed, MMSYSERR_INVALFLAG - - - invalid parameter passed, MMSYSERR_INVALPARAM - - - handle being used simultaneously on another thread (eg callback),MMSYSERR_HANDLEBUSY - - - specified alias not found, MMSYSERR_INVALIDALIAS - - - bad registry database, MMSYSERR_BADDB - - - registry key not found, MMSYSERR_KEYNOTFOUND - - - registry read error, MMSYSERR_READERROR - - - registry write error, MMSYSERR_WRITEERROR - - - registry delete error, MMSYSERR_DELETEERROR - - - registry value not found, MMSYSERR_VALNOTFOUND - - - driver does not call DriverCallback, MMSYSERR_NODRIVERCB - - - more data to be returned, MMSYSERR_MOREDATA - - - unsupported wave format, WAVERR_BADFORMAT - - - still something playing, WAVERR_STILLPLAYING - - - header not prepared, WAVERR_UNPREPARED - - - device is synchronous, WAVERR_SYNC - - - Conversion not possible (ACMERR_NOTPOSSIBLE) - - - Busy (ACMERR_BUSY) - - - Header Unprepared (ACMERR_UNPREPARED) - - - Cancelled (ACMERR_CANCELED) - - - invalid line (MIXERR_INVALLINE) - - - invalid control (MIXERR_INVALCONTROL) - - - invalid value (MIXERR_INVALVALUE) - - - diff --git a/packages/Newtonsoft.Json.12.0.3/.signature.p7s b/packages/Newtonsoft.Json.12.0.3/.signature.p7s deleted file mode 100644 index bc07e21..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/.signature.p7s and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/LICENSE.md b/packages/Newtonsoft.Json.12.0.3/LICENSE.md deleted file mode 100644 index dfaadbe..0000000 --- a/packages/Newtonsoft.Json.12.0.3/LICENSE.md +++ /dev/null @@ -1,20 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2007 James Newton-King - -Permission is hereby granted, free of charge, to any person obtaining a copy of -this software and associated documentation files (the "Software"), to deal in -the Software without restriction, including without limitation the rights to -use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of -the Software, and to permit persons to whom the Software is furnished to do so, -subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS -FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR -COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER -IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN -CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/Newtonsoft.Json.12.0.3/Newtonsoft.Json.12.0.3.nupkg b/packages/Newtonsoft.Json.12.0.3/Newtonsoft.Json.12.0.3.nupkg deleted file mode 100644 index f162e3d..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/Newtonsoft.Json.12.0.3.nupkg and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.dll deleted file mode 100644 index adabab6..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.xml deleted file mode 100644 index 4628a0b..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/net20/Newtonsoft.Json.xml +++ /dev/null @@ -1,10298 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Represents a JSON property. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Provides a set of static (Shared in Visual Basic) methods for - querying objects that implement . - - - - - Returns the input typed as . - - - - - Returns an empty that has the - specified type argument. - - - - - Converts the elements of an to the - specified type. - - - - - Filters the elements of an based on a specified type. - - - - - Generates a sequence of integral numbers within a specified range. - - The value of the first integer in the sequence. - The number of sequential integers to generate. - - - - Generates a sequence that contains one repeated value. - - - - - Filters a sequence of values based on a predicate. - - - - - Filters a sequence of values based on a predicate. - Each element's index is used in the logic of the predicate function. - - - - - Projects each element of a sequence into a new form. - - - - - Projects each element of a sequence into a new form by - incorporating the element's index. - - - - - Projects each element of a sequence to an - and flattens the resulting sequences into one sequence. - - - - - Projects each element of a sequence to an , - and flattens the resulting sequences into one sequence. The - index of each source element is used in the projected form of - that element. - - - - - Projects each element of a sequence to an , - flattens the resulting sequences into one sequence, and invokes - a result selector function on each element therein. - - - - - Projects each element of a sequence to an , - flattens the resulting sequences into one sequence, and invokes - a result selector function on each element therein. The index of - each source element is used in the intermediate projected form - of that element. - - - - - Returns elements from a sequence as long as a specified condition is true. - - - - - Returns elements from a sequence as long as a specified condition is true. - The element's index is used in the logic of the predicate function. - - - - - Base implementation of First operator. - - - - - Returns the first element of a sequence. - - - - - Returns the first element in a sequence that satisfies a specified condition. - - - - - Returns the first element of a sequence, or a default value if - the sequence contains no elements. - - - - - Returns the first element of the sequence that satisfies a - condition or a default value if no such element is found. - - - - - Base implementation of Last operator. - - - - - Returns the last element of a sequence. - - - - - Returns the last element of a sequence that satisfies a - specified condition. - - - - - Returns the last element of a sequence, or a default value if - the sequence contains no elements. - - - - - Returns the last element of a sequence that satisfies a - condition or a default value if no such element is found. - - - - - Base implementation of Single operator. - - - - - Returns the only element of a sequence, and throws an exception - if there is not exactly one element in the sequence. - - - - - Returns the only element of a sequence that satisfies a - specified condition, and throws an exception if more than one - such element exists. - - - - - Returns the only element of a sequence, or a default value if - the sequence is empty; this method throws an exception if there - is more than one element in the sequence. - - - - - Returns the only element of a sequence that satisfies a - specified condition or a default value if no such element - exists; this method throws an exception if more than one element - satisfies the condition. - - - - - Returns the element at a specified index in a sequence. - - - - - Returns the element at a specified index in a sequence or a - default value if the index is out of range. - - - - - Inverts the order of the elements in a sequence. - - - - - Returns a specified number of contiguous elements from the start - of a sequence. - - - - - Bypasses a specified number of elements in a sequence and then - returns the remaining elements. - - - - - Bypasses elements in a sequence as long as a specified condition - is true and then returns the remaining elements. - - - - - Bypasses elements in a sequence as long as a specified condition - is true and then returns the remaining elements. The element's - index is used in the logic of the predicate function. - - - - - Returns the number of elements in a sequence. - - - - - Returns a number that represents how many elements in the - specified sequence satisfy a condition. - - - - - Returns a that represents the total number - of elements in a sequence. - - - - - Returns a that represents how many elements - in a sequence satisfy a condition. - - - - - Concatenates two sequences. - - - - - Creates a from an . - - - - - Creates an array from an . - - - - - Returns distinct elements from a sequence by using the default - equality comparer to compare values. - - - - - Returns distinct elements from a sequence by using a specified - to compare values. - - - - - Creates a from an - according to a specified key - selector function. - - - - - Creates a from an - according to a specified key - selector function and a key comparer. - - - - - Creates a from an - according to specified key - and element selector functions. - - - - - Creates a from an - according to a specified key - selector function, a comparer and an element selector function. - - - - - Groups the elements of a sequence according to a specified key - selector function. - - - - - Groups the elements of a sequence according to a specified key - selector function and compares the keys by using a specified - comparer. - - - - - Groups the elements of a sequence according to a specified key - selector function and projects the elements for each group by - using a specified function. - - - - - Groups the elements of a sequence according to a specified key - selector function and creates a result value from each group and - its key. - - - - - Groups the elements of a sequence according to a key selector - function. The keys are compared by using a comparer and each - group's elements are projected by using a specified function. - - - - - Groups the elements of a sequence according to a specified key - selector function and creates a result value from each group and - its key. The elements of each group are projected by using a - specified function. - - - - - Groups the elements of a sequence according to a specified key - selector function and creates a result value from each group and - its key. The keys are compared by using a specified comparer. - - - - - Groups the elements of a sequence according to a specified key - selector function and creates a result value from each group and - its key. Key values are compared by using a specified comparer, - and the elements of each group are projected by using a - specified function. - - - - - Applies an accumulator function over a sequence. - - - - - Applies an accumulator function over a sequence. The specified - seed value is used as the initial accumulator value. - - - - - Applies an accumulator function over a sequence. The specified - seed value is used as the initial accumulator value, and the - specified function is used to select the result value. - - - - - Produces the set union of two sequences by using the default - equality comparer. - - - - - Produces the set union of two sequences by using a specified - . - - - - - Returns the elements of the specified sequence or the type - parameter's default value in a singleton collection if the - sequence is empty. - - - - - Returns the elements of the specified sequence or the specified - value in a singleton collection if the sequence is empty. - - - - - Determines whether all elements of a sequence satisfy a condition. - - - - - Determines whether a sequence contains any elements. - - - - - Determines whether any element of a sequence satisfies a - condition. - - - - - Determines whether a sequence contains a specified element by - using the default equality comparer. - - - - - Determines whether a sequence contains a specified element by - using a specified . - - - - - Determines whether two sequences are equal by comparing the - elements by using the default equality comparer for their type. - - - - - Determines whether two sequences are equal by comparing their - elements by using a specified . - - - - - Base implementation for Min/Max operator. - - - - - Base implementation for Min/Max operator for nullable types. - - - - - Returns the minimum value in a generic sequence. - - - - - Invokes a transform function on each element of a generic - sequence and returns the minimum resulting value. - - - - - Returns the maximum value in a generic sequence. - - - - - Invokes a transform function on each element of a generic - sequence and returns the maximum resulting value. - - - - - Makes an enumerator seen as enumerable once more. - - - The supplied enumerator must have been started. The first element - returned is the element the enumerator was on when passed in. - DO NOT use this method if the caller must be a generator. It is - mostly safe among aggregate operations. - - - - - Sorts the elements of a sequence in ascending order according to a key. - - - - - Sorts the elements of a sequence in ascending order by using a - specified comparer. - - - - - Sorts the elements of a sequence in descending order according to a key. - - - - - Sorts the elements of a sequence in descending order by using a - specified comparer. - - - - - Performs a subsequent ordering of the elements in a sequence in - ascending order according to a key. - - - - - Performs a subsequent ordering of the elements in a sequence in - ascending order by using a specified comparer. - - - - - Performs a subsequent ordering of the elements in a sequence in - descending order, according to a key. - - - - - Performs a subsequent ordering of the elements in a sequence in - descending order by using a specified comparer. - - - - - Base implementation for Intersect and Except operators. - - - - - Produces the set intersection of two sequences by using the - default equality comparer to compare values. - - - - - Produces the set intersection of two sequences by using the - specified to compare values. - - - - - Produces the set difference of two sequences by using the - default equality comparer to compare values. - - - - - Produces the set difference of two sequences by using the - specified to compare values. - - - - - Creates a from an - according to a specified key - selector function. - - - - - Creates a from an - according to a specified key - selector function and key comparer. - - - - - Creates a from an - according to specified key - selector and element selector functions. - - - - - Creates a from an - according to a specified key - selector function, a comparer, and an element selector function. - - - - - Correlates the elements of two sequences based on matching keys. - The default equality comparer is used to compare keys. - - - - - Correlates the elements of two sequences based on matching keys. - The default equality comparer is used to compare keys. A - specified is used to compare keys. - - - - - Correlates the elements of two sequences based on equality of - keys and groups the results. The default equality comparer is - used to compare keys. - - - - - Correlates the elements of two sequences based on equality of - keys and groups the results. The default equality comparer is - used to compare keys. A specified - is used to compare keys. - - - - - Computes the sum of a sequence of values. - - - - - Computes the sum of a sequence of - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of values. - - - - - Computes the average of a sequence of values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of nullable - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of nullable values. - - - - - Computes the average of a sequence of nullable values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Returns the minimum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the minimum nullable value. - - - - - Returns the maximum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the maximum nullable value. - - - - - Computes the sum of a sequence of values. - - - - - Computes the sum of a sequence of - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of values. - - - - - Computes the average of a sequence of values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of nullable - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of nullable values. - - - - - Computes the average of a sequence of nullable values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Returns the minimum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the minimum nullable value. - - - - - Returns the maximum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the maximum nullable value. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of values. - - - - - Computes the average of a sequence of values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of nullable - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of nullable values. - - - - - Computes the average of a sequence of nullable values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Returns the minimum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the minimum nullable value. - - - - - Returns the maximum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the maximum nullable value. - - - - - Computes the sum of a sequence of values. - - - - - Computes the sum of a sequence of - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of values. - - - - - Computes the average of a sequence of values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of nullable - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of nullable values. - - - - - Computes the average of a sequence of nullable values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Returns the minimum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the minimum nullable value. - - - - - Returns the maximum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the maximum nullable value. - - - - - Computes the sum of a sequence of values. - - - - - Computes the sum of a sequence of - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of values. - - - - - Computes the average of a sequence of values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Computes the sum of a sequence of nullable values. - - - - - Computes the sum of a sequence of nullable - values that are obtained by invoking a transform function on - each element of the input sequence. - - - - - Computes the average of a sequence of nullable values. - - - - - Computes the average of a sequence of nullable values - that are obtained by invoking a transform function on each - element of the input sequence. - - - - - Returns the minimum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the minimum nullable value. - - - - - Returns the maximum value in a sequence of nullable - values. - - - - - Invokes a transform function on each element of a sequence and - returns the maximum nullable value. - - - - - Represents a collection of objects that have a common key. - - - - - Gets the key of the . - - - - - Defines an indexer, size property, and Boolean search method for - data structures that map keys to - sequences of values. - - - - - Represents a sorted sequence. - - - - - Performs a subsequent ordering on the elements of an - according to a key. - - - - - Represents a collection of keys each mapped to one or more values. - - - - - Gets the number of key/value collection pairs in the . - - - - - Gets the collection of values indexed by the specified key. - - - - - Determines whether a specified key is in the . - - - - - Applies a transform function to each key and its associated - values and returns the results. - - - - - Returns a generic enumerator that iterates through the . - - - - - See issue #11 - for why this method is needed and cannot be expressed as a - lambda at the call site. - - - - - See issue #11 - for why this method is needed and cannot be expressed as a - lambda at the call site. - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - - This attribute allows us to define extension methods without - requiring .NET Framework 3.5. For more information, see the section, - Extension Methods in .NET Framework 2.0 Apps, - of Basic Instincts: Extension Methods - column in MSDN Magazine, - issue Nov 2007. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.dll deleted file mode 100644 index b965fb5..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.xml deleted file mode 100644 index 6058a14..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/net35/Newtonsoft.Json.xml +++ /dev/null @@ -1,9446 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Represents a JSON property. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.dll deleted file mode 100644 index 628aaf0..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.xml deleted file mode 100644 index 0cbf62c..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/net40/Newtonsoft.Json.xml +++ /dev/null @@ -1,9646 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.dll deleted file mode 100644 index e4a6339..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.xml deleted file mode 100644 index aa245c5..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/net45/Newtonsoft.Json.xml +++ /dev/null @@ -1,11262 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.dll deleted file mode 100644 index 32bbff8..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.xml deleted file mode 100644 index 4d19d19..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.0/Newtonsoft.Json.xml +++ /dev/null @@ -1,10950 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Allows users to control class loading and mandate what class to load. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Specifies what messages to output for the class. - - - - - Output no tracing and debugging messages. - - - - - Output error-handling messages. - - - - - Output warnings and error-handling messages. - - - - - Output informational messages, warnings, and error-handling messages. - - - - - Output all debugging and tracing messages. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - List of primitive types which can be widened. - - - - - Widening masks for primitive types above. - Index of the value in this array defines a type we're widening, - while the bits in mask define types it can be widened to (including itself). - - For example, value at index 0 defines a bool type, and it only has bit 0 set, - i.e. bool values can be assigned only to bool. - - - - - Checks if value of primitive type can be - assigned to parameter of primitive type . - - Source primitive type. - Target primitive type. - true if source type can be widened to target type, false otherwise. - - - - Checks if a set of values with given can be used - to invoke a method with specified . - - Method parameters. - Argument types. - Try to pack extra arguments into the last parameter when it is marked up with . - true if method can be called with given arguments, false otherwise. - - - - Compares two sets of parameters to determine - which one suits better for given argument types. - - - - - Returns a best method overload for given argument . - - List of method candidates. - Argument types. - Best method overload, or null if none matched. - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.dll deleted file mode 100644 index 9244d0a..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.xml deleted file mode 100644 index 584a697..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/netstandard1.3/Newtonsoft.Json.xml +++ /dev/null @@ -1,11072 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Allows users to control class loading and mandate what class to load. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Specifies what messages to output for the class. - - - - - Output no tracing and debugging messages. - - - - - Output error-handling messages. - - - - - Output warnings and error-handling messages. - - - - - Output informational messages, warnings, and error-handling messages. - - - - - Output all debugging and tracing messages. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - List of primitive types which can be widened. - - - - - Widening masks for primitive types above. - Index of the value in this array defines a type we're widening, - while the bits in mask define types it can be widened to (including itself). - - For example, value at index 0 defines a bool type, and it only has bit 0 set, - i.e. bool values can be assigned only to bool. - - - - - Checks if value of primitive type can be - assigned to parameter of primitive type . - - Source primitive type. - Target primitive type. - true if source type can be widened to target type, false otherwise. - - - - Checks if a set of values with given can be used - to invoke a method with specified . - - Method parameters. - Argument types. - Try to pack extra arguments into the last parameter when it is marked up with . - true if method can be called with given arguments, false otherwise. - - - - Compares two sets of parameters to determine - which one suits better for given argument types. - - - - - Returns a best method overload for given argument . - - List of method candidates. - Argument types. - Best method overload, or null if none matched. - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.dll deleted file mode 100644 index b501fb6..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.xml deleted file mode 100644 index 01e90a0..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/netstandard2.0/Newtonsoft.Json.xml +++ /dev/null @@ -1,11237 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an Entity Framework to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to serialize. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to serialize. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the list changes or an item in the list changes. - - - - - Occurs before an item is added to the collection. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Occurs when a property value is changing. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a view of a . - - - - - Initializes a new instance of the class. - - The name. - - - - When overridden in a derived class, returns whether resetting an object changes its value. - - - true if resetting the component changes its value; otherwise, false. - - The component to test for reset capability. - - - - When overridden in a derived class, gets the current value of the property on a component. - - - The value of a property for a given component. - - The component with the property for which to retrieve the value. - - - - When overridden in a derived class, resets the value for this property of the component to the default value. - - The component with the property value that is to be reset to the default value. - - - - When overridden in a derived class, sets the value of the component to a different value. - - The component with the property value that is to be set. - The new value. - - - - When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. - - - true if the property should be persisted; otherwise, false. - - The component with the property to be examined for persistence. - - - - When overridden in a derived class, gets the type of the component this property is bound to. - - - A that represents the type of component this property is bound to. - When the or - - methods are invoked, the object specified might be an instance of this type. - - - - - When overridden in a derived class, gets a value indicating whether this property is read-only. - - - true if the property is read-only; otherwise, false. - - - - - When overridden in a derived class, gets the type of the property. - - - A that represents the type of the property. - - - - - Gets the hash code for the name of the member. - - - - The hash code for the name of the member. - - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class. - - The that holds the serialized object data about the exception being thrown. - The that contains contextual information about the source or destination. - The parameter is null. - The class name is null or is zero (0). - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. - - - true if the interface will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. - - - true if the attribute will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer that writes to the application's instances. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object constructor. - - The object constructor. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.dll deleted file mode 100644 index 112c29a..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.xml deleted file mode 100644 index 8f1dc63..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/portable-net40+sl5+win8+wp8+wpa81/Newtonsoft.Json.xml +++ /dev/null @@ -1,9010 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Represents a JSON property. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a raw JSON string. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Allows users to control class loading and mandate what class to load. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets the default members search flags. - - The default members search flags. - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Specifies what messages to output for the class. - - - - - Output no tracing and debugging messages. - - - - - Output error-handling messages. - - - - - Output warnings and error-handling messages. - - - - - Output informational messages, warnings, and error-handling messages. - - - - - Output all debugging and tracing messages. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.dll b/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.dll deleted file mode 100644 index aa8843c..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.dll and /dev/null differ diff --git a/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.xml b/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.xml deleted file mode 100644 index 4d19d19..0000000 --- a/packages/Newtonsoft.Json.12.0.3/lib/portable-net45+win8+wp8+wpa81/Newtonsoft.Json.xml +++ /dev/null @@ -1,10950 +0,0 @@ - - - - Newtonsoft.Json - - - - - Represents a BSON Oid (object id). - - - - - Gets or sets the value of the Oid. - - The value of the Oid. - - - - Initializes a new instance of the class. - - The Oid value. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized BSON data. - - - - - Gets or sets a value indicating whether binary data reading should be compatible with incorrect Json.NET 3.5 written binary. - - - true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. - - - - - Gets or sets a value indicating whether the root object will be read as a JSON array. - - - true if the root object will be read as a JSON array; otherwise, false. - - - - - Gets or sets the used when reading values from BSON. - - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Initializes a new instance of the class. - - The containing the BSON data to read. - if set to true the root object will be read as a JSON array. - The used when reading values from BSON. - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating BSON data. - - - - - Gets or sets the used when writing values to BSON. - When set to no conversion will occur. - - The used when writing values to BSON. - - - - Initializes a new instance of the class. - - The to write to. - - - - Initializes a new instance of the class. - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying stream. - - - - - Writes the end. - - The token. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes the beginning of a JSON array. - - - - - Writes the beginning of a JSON object. - - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value that represents a BSON object id. - - The Object ID value to write. - - - - Writes a BSON regex. - - The regex pattern. - The regex options. - - - - Specifies how constructors are used when initializing objects during deserialization by the . - - - - - First attempt to use the public default constructor, then fall back to a single parameterized constructor, then to the non-public default constructor. - - - - - Json.NET will use a non-public default constructor before falling back to a parameterized constructor. - - - - - Converts a binary value to and from a base 64 string value. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Creates a custom object. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Creates an object which will then be populated by the serializer. - - Type of the object. - The created object. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Provides a base class for converting a to and from JSON. - - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a F# discriminated union type to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can write JSON. - - - true if this can write JSON; otherwise, false. - - - - - Converts a to and from the ISO 8601 date format (e.g. "2008-04-12T12:53Z"). - - - - - Gets or sets the date time styles used when converting a date to and from JSON. - - The date time styles used when converting a date to and from JSON. - - - - Gets or sets the date time format used when converting a date to and from JSON. - - The date time format used when converting a date to and from JSON. - - - - Gets or sets the culture used when converting a date to and from JSON. - - The culture used when converting a date to and from JSON. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Converts a to and from a JavaScript Date constructor (e.g. new Date(52231943)). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from JSON and BSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts an to and from its name string value. - - - - - Gets or sets a value indicating whether the written enum text should be camel case. - The default value is false. - - true if the written enum text will be camel case; otherwise, false. - - - - Gets or sets the naming strategy used to resolve how enum text is written. - - The naming strategy used to resolve how enum text is written. - - - - Gets or sets a value indicating whether integer values are allowed when serializing and deserializing. - The default value is true. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - true if the written enum text will be camel case; otherwise, false. - - - - Initializes a new instance of the class. - - The naming strategy used to resolve how enum text is written. - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - - Initializes a new instance of the class. - - The of the used to write enum text. - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - true if integers are allowed when serializing and deserializing; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts a to and from Unix epoch time - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Converts a to and from a string (e.g. "1.2.3.4"). - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing property value of the JSON that is being converted. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Converts XML to and from JSON. - - - - - Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produced multiple root elements. - - The name of the deserialized root element. - - - - Gets or sets a value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - true if the array attribute is written to the XML; otherwise, false. - - - - Gets or sets a value indicating whether to write the root JSON object. - - true if the JSON root object is omitted; otherwise, false. - - - - Gets or sets a value indicating whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - true if special characters are encoded; otherwise, false. - - - - Writes the JSON representation of the object. - - The to write to. - The calling serializer. - The value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Checks if the is a namespace attribute. - - Attribute name to test. - The attribute name prefix if it has one, otherwise an empty string. - true if attribute name is for a namespace attribute, otherwise false. - - - - Determines whether this instance can convert the specified value type. - - Type of the value. - - true if this instance can convert the specified value type; otherwise, false. - - - - - Specifies how dates are formatted when writing JSON text. - - - - - Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". - - - - - Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". - - - - - Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. - - - - - Date formatted strings are not parsed to a date type and are read as strings. - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . - - - - - Specifies how to treat the time value when converting between string and . - - - - - Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. - - - - - Treat as a UTC. If the object represents a local time, it is converted to a UTC. - - - - - Treat as a local time if a is being converted to a string. - If a string is being converted to , convert to a local time if a time zone is specified. - - - - - Time zone information should be preserved when converting. - - - - - The default JSON name table implementation. - - - - - Initializes a new instance of the class. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Adds the specified string into name table. - - The string to add. - This method is not thread-safe. - The resolved string. - - - - Specifies default value handling options for the . - - - - - - - - - Include members where the member value is the same as the member's default value when serializing objects. - Included members are written to JSON. Has no effect when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - so that it is not written to JSON. - This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, - decimals and floating point numbers; and false for booleans). The default value ignored can be changed by - placing the on the property. - - - - - Members with a default value but no JSON will be set to their default value when deserializing. - - - - - Ignore members where the member value is the same as the member's default value when serializing objects - and set members to their default value when deserializing. - - - - - Specifies float format handling options when writing special floating point numbers, e.g. , - and with . - - - - - Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". - - - - - Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. - Note that this will produce non-valid JSON. - - - - - Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a of property. - - - - - Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Floating point numbers are parsed to . - - - - - Floating point numbers are parsed to . - - - - - Specifies formatting options for the . - - - - - No special formatting is applied. This is the default. - - - - - Causes child objects to be indented according to the and settings. - - - - - Provides an interface for using pooled arrays. - - The array type content. - - - - Rent an array from the pool. This array must be returned when it is no longer needed. - - The minimum required length of the array. The returned array may be longer. - The rented array from the pool. This array must be returned when it is no longer needed. - - - - Return an array to the pool. - - The array that is being returned. - - - - Provides an interface to enable a class to return line and position information. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - The current line number or 0 if no line information is available (for example, when returns false). - - - - Gets the current line position. - - The current line position or 0 if no line information is available (for example, when returns false). - - - - Instructs the how to serialize the collection. - - - - - Gets or sets a value indicating whether null items are allowed in the collection. - - true if null items are allowed in the collection; otherwise, false. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with a flag indicating whether the array can contain null items. - - A flag indicating whether the array can contain null items. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to use the specified constructor when deserializing that object. - - - - - Instructs the how to serialize the object. - - - - - Gets or sets the id. - - The id. - - - - Gets or sets the title. - - The title. - - - - Gets or sets the description. - - The description. - - - - Gets or sets the collection's items converter. - - The collection's items converter. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets a value that indicates whether to preserve object references. - - - true to keep object reference; otherwise, false. The default is false. - - - - - Gets or sets a value that indicates whether to preserve collection's items references. - - - true to keep collection's items object references; otherwise, false. The default is false. - - - - - Gets or sets the reference loop handling used when serializing the collection's items. - - The reference loop handling. - - - - Gets or sets the type name handling used when serializing the collection's items. - - The type name handling. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Provides methods for converting between .NET types and JSON types. - - - - - - - - Gets or sets a function that creates default . - Default settings are automatically used by serialization methods on , - and and on . - To serialize without using any default settings create a with - . - - - - - Represents JavaScript's boolean value true as a string. This field is read-only. - - - - - Represents JavaScript's boolean value false as a string. This field is read-only. - - - - - Represents JavaScript's null as a string. This field is read-only. - - - - - Represents JavaScript's undefined as a string. This field is read-only. - - - - - Represents JavaScript's positive infinity as a string. This field is read-only. - - - - - Represents JavaScript's negative infinity as a string. This field is read-only. - - - - - Represents JavaScript's NaN as a string. This field is read-only. - - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - The time zone handling when the date is converted to a string. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation using the specified. - - The value to convert. - The format the date will be converted to. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - The string delimiter character. - The string escape handling. - A JSON string representation of the . - - - - Converts the to its JSON string representation. - - The value to convert. - A JSON string representation of the . - - - - Serializes the specified object to a JSON string. - - The object to serialize. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting. - - The object to serialize. - Indicates how the output should be formatted. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a collection of . - - The object to serialize. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using formatting and a collection of . - - The object to serialize. - Indicates how the output should be formatted. - A collection of converters used while serializing. - A JSON string representation of the object. - - - - Serializes the specified object to a JSON string using . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - A JSON string representation of the object. - - - - - Serializes the specified object to a JSON string using a type, formatting and . - - The object to serialize. - Indicates how the output should be formatted. - The used to serialize the object. - If this is null, default serialization settings will be used. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - A JSON string representation of the object. - - - - - Deserializes the JSON to a .NET object. - - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to a .NET object using . - - The JSON to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The JSON to deserialize. - The of object being deserialized. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type. - - The type of the object to deserialize to. - The JSON to deserialize. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the given anonymous type. - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the given anonymous type using . - - - The anonymous type to deserialize to. This can't be specified - traditionally and must be inferred from the anonymous type passed - as a parameter. - - The JSON to deserialize. - The anonymous type object. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized anonymous type from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The type of the object to deserialize to. - The JSON to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The type of the object to deserialize to. - The object to deserialize. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using a collection of . - - The JSON to deserialize. - The type of the object to deserialize. - Converters to use while deserializing. - The deserialized object from the JSON string. - - - - Deserializes the JSON to the specified .NET type using . - - The JSON to deserialize. - The type of the object to deserialize to. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - The deserialized object from the JSON string. - - - - Populates the object with values from the JSON string. - - The JSON to populate values from. - The target object to populate values onto. - - - - Populates the object with values from the JSON string using . - - The JSON to populate values from. - The target object to populate values onto. - - The used to deserialize the object. - If this is null, default serialization settings will be used. - - - - - Serializes the to a JSON string. - - The node to convert to JSON. - A JSON string of the . - - - - Serializes the to a JSON string using formatting. - - The node to convert to JSON. - Indicates how the output should be formatted. - A JSON string of the . - - - - Serializes the to a JSON string using formatting and omits the root object if is true. - - The node to serialize. - Indicates how the output should be formatted. - Omits writing the root object. - A JSON string of the . - - - - Deserializes the from a JSON string. - - The JSON string. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by . - - The JSON string. - The name of the root element to append when deserializing. - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by - and writes a Json.NET array attribute for collections. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - The deserialized . - - - - Deserializes the from a JSON string nested in a root element specified by , - writes a Json.NET array attribute for collections, and encodes special characters. - - The JSON string. - The name of the root element to append when deserializing. - - A value to indicate whether to write the Json.NET array attribute. - This attribute helps preserve arrays when converting the written XML back to JSON. - - - A value to indicate whether to encode special characters when converting JSON to XML. - If true, special characters like ':', '@', '?', '#' and '$' in JSON property names aren't used to specify - XML namespaces, attributes or processing directives. Instead special characters are encoded and written - as part of the XML element name. - - The deserialized . - - - - Converts an object to and from JSON. - - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Gets a value indicating whether this can read JSON. - - true if this can read JSON; otherwise, false. - - - - Gets a value indicating whether this can write JSON. - - true if this can write JSON; otherwise, false. - - - - Converts an object to and from JSON. - - The object type to convert. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Writes the JSON representation of the object. - - The to write to. - The value. - The calling serializer. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. - The calling serializer. - The object value. - - - - Reads the JSON representation of the object. - - The to read from. - Type of the object. - The existing value of object being read. If there is no existing value then null will be used. - The existing value has a value. - The calling serializer. - The object value. - - - - Determines whether this instance can convert the specified object type. - - Type of the object. - - true if this instance can convert the specified object type; otherwise, false. - - - - - Instructs the to use the specified when serializing the member or class. - - - - - Gets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - - - - - Initializes a new instance of the class. - - Type of the . - - - - Initializes a new instance of the class. - - Type of the . - Parameter list to use when constructing the . Can be null. - - - - Represents a collection of . - - - - - Instructs the how to serialize the collection. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to deserialize properties with no matching class member into the specified collection - and write values during serialization. - - - - - Gets or sets a value that indicates whether to write extension data when serializing the object. - - - true to write extension data when serializing the object; otherwise, false. The default is true. - - - - - Gets or sets a value that indicates whether to read extension data when deserializing the object. - - - true to read extension data when deserializing the object; otherwise, false. The default is true. - - - - - Initializes a new instance of the class. - - - - - Instructs the not to serialize the public field or public read/write property value. - - - - - Base class for a table of atomized string objects. - - - - - Gets a string containing the same characters as the specified range of characters in the given array. - - The character array containing the name to find. - The zero-based index into the array specifying the first character of the name. - The number of characters in the name. - A string containing the same characters as the specified range of characters in the given array. - - - - Instructs the how to serialize the object. - - - - - Gets or sets the member serialization. - - The member serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified member serialization. - - The member serialization. - - - - Initializes a new instance of the class with the specified container Id. - - The container Id. - - - - Instructs the to always serialize the member with the specified name. - - - - - Gets or sets the type used when serializing the property's collection items. - - The collection's items type. - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the of the . - - The of the . - - - - The parameter list to use when constructing the described by . - If null, the default constructor is used. - When non-null, there must be a constructor defined in the that exactly matches the number, - order, and type of these parameters. - - - - [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] - - - - - - Gets or sets the null value handling used when serializing this property. - - The null value handling. - - - - Gets or sets the default value handling used when serializing this property. - - The default value handling. - - - - Gets or sets the reference loop handling used when serializing this property. - - The reference loop handling. - - - - Gets or sets the object creation handling used when deserializing this property. - - The object creation handling. - - - - Gets or sets the type name handling used when serializing this property. - - The type name handling. - - - - Gets or sets whether this property's value is serialized as a reference. - - Whether this property's value is serialized as a reference. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets a value indicating whether this property is required. - - - A value indicating whether this property is required. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class with the specified name. - - Name of the property. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously skips the children of the current token. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Specifies the state of the reader. - - - - - A read method has not been called. - - - - - The end of the file has been reached successfully. - - - - - Reader is at a property. - - - - - Reader is at the start of an object. - - - - - Reader is in an object. - - - - - Reader is at the start of an array. - - - - - Reader is in an array. - - - - - The method has been called. - - - - - Reader has just read a value. - - - - - Reader is at the start of a constructor. - - - - - Reader is in a constructor. - - - - - An error occurred that prevents the read operation from continuing. - - - - - The end of the file has been reached successfully. - - - - - Gets the current reader state. - - The current reader state. - - - - Gets or sets a value indicating whether the source should be closed when this reader is closed. - - - true to close the source when this reader is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether multiple pieces of JSON content can - be read from a continuous stream without erroring. - - - true to support reading multiple pieces of JSON content; otherwise false. - The default is false. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - Gets or sets how time zones are handled when reading JSON. - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - - - - - Gets or sets how custom date formatted strings are parsed when reading JSON. - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - - - - - Gets the type of the current JSON token. - - - - - Gets the text value of the current JSON token. - - - - - Gets the .NET type for the current JSON token. - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets or sets the culture used when reading JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Reads the next JSON token from the source. - - true if the next token was read successfully; false if there are no more tokens to read. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the source as a of . - - A of . This method will return null at the end of an array. - - - - Skips the children of the current token. - - - - - Sets the current token. - - The new token. - - - - Sets the current token and value. - - The new token. - The value. - - - - Sets the current token and value. - - The new token. - The value. - A flag indicating whether the position index inside an array should be updated. - - - - Sets the state based on current token type. - - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Changes the reader's state to . - If is set to true, the source is also closed. - - - - - The exception thrown when an error occurs while reading JSON text. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Instructs the to always serialize the member, and to require that the member has a value. - - - - - The exception thrown when an error occurs during JSON serialization or deserialization. - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path, line number, line position, and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The line number indicating where the error occurred. - The line position indicating where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Serializes and deserializes objects into and from the JSON format. - The enables you to control how objects are encoded into JSON. - - - - - Occurs when the errors during serialization and deserialization. - - - - - Gets or sets the used by the serializer when resolving references. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when resolving type names. - - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - - - - Gets or sets how reference loops (e.g. a class referencing itself) is handled. - The default value is . - - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets a collection that will be used during serialization. - - Collection that will be used during serialization. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. - The default value is false. - - - true if there will be a check for additional JSON content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Creates a new instance. - The will not use default settings - from . - - - A new instance. - The will not use default settings - from . - - - - - Creates a new instance using the specified . - The will not use default settings - from . - - The settings to be applied to the . - - A new instance using the specified . - The will not use default settings - from . - - - - - Creates a new instance. - The will use default settings - from . - - - A new instance. - The will use default settings - from . - - - - - Creates a new instance using the specified . - The will use default settings - from as well as the specified . - - The settings to be applied to the . - - A new instance using the specified . - The will use default settings - from as well as the specified . - - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Populates the JSON values onto the target object. - - The that contains the JSON structure to read values from. - The target object to populate values onto. - - - - Deserializes the JSON structure contained by the specified . - - The that contains the JSON structure to deserialize. - The being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The type of the object to deserialize. - The instance of being deserialized. - - - - Deserializes the JSON structure contained by the specified - into an instance of the specified type. - - The containing the object. - The of object being deserialized. - The instance of being deserialized. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - The type of the value being serialized. - This parameter is used when is Auto to write out the type name if the type of the value does not match. - Specifying the type is optional. - - - - - Serializes the specified and writes the JSON structure - using the specified . - - The used to write the JSON structure. - The to serialize. - - - - Specifies the settings on a object. - - - - - Gets or sets how reference loops (e.g. a class referencing itself) are handled. - The default value is . - - Reference loop handling. - - - - Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. - The default value is . - - Missing member handling. - - - - Gets or sets how objects are created during deserialization. - The default value is . - - The object creation handling. - - - - Gets or sets how null values are handled during serialization and deserialization. - The default value is . - - Null value handling. - - - - Gets or sets how default values are handled during serialization and deserialization. - The default value is . - - The default value handling. - - - - Gets or sets a collection that will be used during serialization. - - The converters. - - - - Gets or sets how object references are preserved by the serializer. - The default value is . - - The preserve references handling. - - - - Gets or sets how type name writing and reading is handled by the serializer. - The default value is . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - The type name handling. - - - - Gets or sets how metadata properties are used during deserialization. - The default value is . - - The metadata properties handling. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how a type name assembly is written and resolved by the serializer. - The default value is . - - The type name assembly format. - - - - Gets or sets how constructors are used during deserialization. - The default value is . - - The constructor handling. - - - - Gets or sets the contract resolver used by the serializer when - serializing .NET objects to JSON and vice versa. - - The contract resolver. - - - - Gets or sets the equality comparer used by the serializer when comparing references. - - The equality comparer. - - - - Gets or sets the used by the serializer when resolving references. - - The reference resolver. - - - - Gets or sets a function that creates the used by the serializer when resolving references. - - A function that creates the used by the serializer when resolving references. - - - - Gets or sets the used by the serializer when writing trace messages. - - The trace writer. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the used by the serializer when resolving type names. - - The binder. - - - - Gets or sets the error handler called during serialization and deserialization. - - The error handler called during serialization and deserialization. - - - - Gets or sets the used by the serializer when invoking serialization callback methods. - - The context. - - - - Gets or sets how and values are formatted when writing JSON text, - and the expected date format when reading JSON text. - The default value is "yyyy'-'MM'-'dd'T'HH':'mm':'ss.FFFFFFFK". - - - - - Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . - A null value means there is no maximum. - The default value is null. - - - - - Indicates how JSON text output is formatted. - The default value is . - - - - - Gets or sets how dates are written to JSON text. - The default value is . - - - - - Gets or sets how time zones are handled during serialization and deserialization. - The default value is . - - - - - Gets or sets how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. - The default value is . - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written as JSON. - The default value is . - - - - - Gets or sets how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. - The default value is . - - - - - Gets or sets how strings are escaped when writing JSON text. - The default value is . - - - - - Gets or sets the culture used when reading JSON. - The default value is . - - - - - Gets a value indicating whether there will be a check for additional content after deserializing an object. - The default value is false. - - - true if there will be a check for additional content after deserializing an object; otherwise, false. - - - - - Initializes a new instance of the class. - - - - - Represents a reader that provides fast, non-cached, forward-only access to JSON text data. - - - - - Asynchronously reads the next JSON token from the source. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns true if the next token was read successfully; false if there are no more tokens to read. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a []. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the []. This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a of . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the of . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously reads the next JSON token from the source as a . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous read. The - property returns the . This result will be null at the end of an array. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Initializes a new instance of the class with the specified . - - The containing the JSON data to read. - - - - Gets or sets the reader's property name table. - - - - - Gets or sets the reader's character buffer pool. - - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a []. - - A [] or null if the next JSON token is null. This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Gets a value indicating whether the class can return line information. - - - true if and can be provided; otherwise, false. - - - - - Gets the current line number. - - - The current line number or 0 if no line information is available (for example, returns false). - - - - - Gets the current line position. - - - The current line position or 0 if no line information is available (for example, returns false). - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - Derived classes must override this method to get asynchronous behaviour. Otherwise it will - execute synchronously, returning an already-completed task. - - - - Gets or sets the writer's character array pool. - - - - - Gets or sets how many s to write for each level in the hierarchy when is set to . - - - - - Gets or sets which character to use to quote attribute values. - - - - - Gets or sets which character to use for indenting when is set to . - - - - - Gets or sets a value indicating whether object names will be surrounded with quotes. - - - - - Initializes a new instance of the class using the specified . - - The to write to. - - - - Flushes whatever is in the buffer to the underlying and also flushes the underlying . - - - - - Closes this writer. - If is set to true, the underlying is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the specified end token. - - The end token to write. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Specifies the type of JSON token. - - - - - This is returned by the if a read method has not been called. - - - - - An object start token. - - - - - An array start token. - - - - - A constructor start token. - - - - - An object property name. - - - - - A comment. - - - - - Raw JSON. - - - - - An integer. - - - - - A float. - - - - - A string. - - - - - A boolean. - - - - - A null token. - - - - - An undefined token. - - - - - An object end token. - - - - - An array end token. - - - - - A constructor end token. - - - - - A Date. - - - - - Byte data. - - - - - - Represents a reader that provides validation. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Sets an event handler for receiving schema validation errors. - - - - - Gets the text value of the current JSON token. - - - - - - Gets the depth of the current token in the JSON document. - - The depth of the current token in the JSON document. - - - - Gets the path of the current JSON token. - - - - - Gets the quotation mark character used to enclose the value of a string. - - - - - - Gets the type of the current JSON token. - - - - - - Gets the .NET type for the current JSON token. - - - - - - Initializes a new instance of the class that - validates the content returned from the given . - - The to read from while validating. - - - - Gets or sets the schema. - - The schema. - - - - Gets the used to construct this . - - The specified in the constructor. - - - - Changes the reader's state to . - If is set to true, the underlying is also closed. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a []. - - - A [] or null if the next JSON token is null. - - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying as a . - - A . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . This method will return null at the end of an array. - - - - Reads the next JSON token from the underlying as a of . - - A of . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Asynchronously closes this writer. - If is set to true, the destination is also closed. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously flushes whatever is in the buffer to the destination and also flushes the destination. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the specified end token. - - The end token to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes indent characters. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the JSON value delimiter. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an indent space. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON without changing the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of the current JSON object or array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of an array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a constructor. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the end of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a null value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON array. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the start of a constructor with the given name. - - The name of the constructor. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the beginning of a JSON object. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a [] value. - - The [] value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a value. - - The value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes a of value. - - The of value to write. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes an undefined value. - - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously writes the given white space. - - The string of white space characters. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Asynchronously ets the state of the . - - The being written. - The value being written. - The token to monitor for cancellation requests. The default value is . - A that represents the asynchronous operation. - The default behaviour is to execute synchronously, returning an already-completed task. Derived - classes can override this behaviour for true asynchronicity. - - - - Gets or sets a value indicating whether the destination should be closed when this writer is closed. - - - true to close the destination when this writer is closed; otherwise false. The default is true. - - - - - Gets or sets a value indicating whether the JSON should be auto-completed when this writer is closed. - - - true to auto-complete the JSON when this writer is closed; otherwise false. The default is true. - - - - - Gets the top. - - The top. - - - - Gets the state of the writer. - - - - - Gets the path of the writer. - - - - - Gets or sets a value indicating how JSON text output should be formatted. - - - - - Gets or sets how dates are written to JSON text. - - - - - Gets or sets how time zones are handled when writing JSON text. - - - - - Gets or sets how strings are escaped when writing JSON text. - - - - - Gets or sets how special floating point numbers, e.g. , - and , - are written to JSON text. - - - - - Gets or sets how and values are formatted when writing JSON text. - - - - - Gets or sets the culture used when writing JSON. Defaults to . - - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the destination and also flushes the destination. - - - - - Closes this writer. - If is set to true, the destination is also closed. - If is set to true, the JSON is auto-completed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the end of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the end of an array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end constructor. - - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - - - - Writes the property name of a name/value pair of a JSON object. - - The name of the property. - A flag to indicate whether the text should be escaped when it is written as a JSON property name. - - - - Writes the end of the current JSON object or array. - - - - - Writes the current token and its children. - - The to read the token from. - - - - Writes the current token. - - The to read the token from. - A flag indicating whether the current token's children should be written. - - - - Writes the token and its value. - - The to write. - - The value to write. - A value is only required for tokens that have an associated value, e.g. the property name for . - null can be passed to the method for tokens that don't have a value, e.g. . - - - - - Writes the token. - - The to write. - - - - Writes the specified end token. - - The end token to write. - - - - Writes indent characters. - - - - - Writes the JSON value delimiter. - - - - - Writes an indent space. - - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON without changing the writer's state. - - The raw JSON to write. - - - - Writes raw JSON where a value is expected and updates the writer's state. - - The raw JSON to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a of value. - - The of value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - An error will raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes the given white space. - - The string of white space characters. - - - - Releases unmanaged and - optionally - managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Sets the state of the . - - The being written. - The value being written. - - - - The exception thrown when an error occurs while writing JSON text. - - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Initializes a new instance of the class - with a specified error message, JSON path and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The path to the JSON where the error occurred. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - Specifies how JSON comments are handled when loading JSON. - - - - - Ignore comments. - - - - - Load comments as a with type . - - - - - Specifies how duplicate property names are handled when loading JSON. - - - - - Replace the existing value when there is a duplicate property. The value of the last property in the JSON object will be used. - - - - - Ignore the new value when there is a duplicate property. The value of the first property in the JSON object will be used. - - - - - Throw a when a duplicate property is encountered. - - - - - Contains the LINQ to JSON extension methods. - - - - - Returns a collection of tokens that contains the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, the ancestors of every token in the source collection. - - - - Returns a collection of tokens that contains the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains the descendants of every token in the source collection. - - - - Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. - - The type of the objects in source, constrained to . - An of that contains the source collection. - An of that contains every token in the source collection, and the descendants of every token in the source collection. - - - - Returns a collection of child properties of every object in the source collection. - - An of that contains the source collection. - An of that contains the properties of every object in the source collection. - - - - Returns a collection of child values of every object in the source collection with the given key. - - An of that contains the source collection. - The token key. - An of that contains the values of every token in the source collection with the given key. - - - - Returns a collection of child values of every object in the source collection. - - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child values of every object in the source collection with the given key. - - The type to convert the values to. - An of that contains the source collection. - The token key. - An that contains the converted values of every token in the source collection with the given key. - - - - Returns a collection of converted child values of every object in the source collection. - - The type to convert the values to. - An of that contains the source collection. - An that contains the converted values of every token in the source collection. - - - - Converts the value. - - The type to convert the value to. - A cast as a of . - A converted value. - - - - Converts the value. - - The source collection type. - The type to convert the value to. - A cast as a of . - A converted value. - - - - Returns a collection of child tokens of every array in the source collection. - - The source collection type. - An of that contains the source collection. - An of that contains the values of every token in the source collection. - - - - Returns a collection of converted child tokens of every array in the source collection. - - An of that contains the source collection. - The type to convert the values to. - The source collection type. - An that contains the converted values of every token in the source collection. - - - - Returns the input typed as . - - An of that contains the source collection. - The input typed as . - - - - Returns the input typed as . - - The source collection type. - An of that contains the source collection. - The input typed as . - - - - Represents a collection of objects. - - The type of token. - - - - Gets the of with the specified key. - - - - - - Represents a JSON array. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous load. The property contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Initializes a new instance of the class with the specified content. - - The contents of the array. - - - - Loads an from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads an from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the at the specified index. - - - - - - Determines the index of a specific item in the . - - The object to locate in the . - - The index of if found in the list; otherwise, -1. - - - - - Inserts an item to the at the specified index. - - The zero-based index at which should be inserted. - The object to insert into the . - - is not a valid index in the . - - - - - Removes the item at the specified index. - - The zero-based index of the item to remove. - - is not a valid index in the . - - - - - Returns an enumerator that iterates through the collection. - - - A of that can be used to iterate through the collection. - - - - - Adds an item to the . - - The object to add to the . - - - - Removes all items from the . - - - - - Determines whether the contains a specific value. - - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - - Copies the elements of the to an array, starting at a particular array index. - - The array. - Index of the array. - - - - Gets a value indicating whether the is read-only. - - true if the is read-only; otherwise, false. - - - - Removes the first occurrence of a specific object from the . - - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . - - - - - Represents a JSON constructor. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets or sets the name of this constructor. - - The constructor name. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name and content. - - The constructor name. - The contents of the constructor. - - - - Initializes a new instance of the class with the specified name. - - The constructor name. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified key. - - The with the specified key. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a token that can contain other tokens. - - - - - Occurs when the items list of the collection has changed, or the collection is reset. - - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Raises the event. - - The instance containing the event data. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Get the first child token of this token. - - - A containing the first child token of the . - - - - - Get the last child token of this token. - - - A containing the last child token of the . - - - - - Returns a collection of the child tokens of this token, in document order. - - - An of containing the child tokens of this , in document order. - - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - - A containing the child values of this , in document order. - - - - - Returns a collection of the descendant tokens for this token in document order. - - An of containing the descendant tokens of the . - - - - Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. - - An of containing this token, and all the descendant tokens of the . - - - - Adds the specified content as children of this . - - The content to be added. - - - - Adds the specified content as the first children of this . - - The content to be added. - - - - Creates a that can be used to add tokens to the . - - A that is ready to have content written to it. - - - - Replaces the child nodes of this token with the specified content. - - The content. - - - - Removes the child nodes from this token. - - - - - Merge the specified content into this . - - The content to be merged. - - - - Merge the specified content into this using . - - The content to be merged. - The used to merge the content. - - - - Gets the count of child JSON tokens. - - The count of child JSON tokens. - - - - Represents a collection of objects. - - The type of token. - - - - An empty collection of objects. - - - - - Initializes a new instance of the struct. - - The enumerable. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Gets the of with the specified key. - - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Determines whether the specified is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Represents a JSON object. - - - - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous load. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Occurs when a property value changes. - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Initializes a new instance of the class with the specified content. - - The contents of the object. - - - - Gets the node type for this . - - The type. - - - - Gets an of of this object's properties. - - An of of this object's properties. - - - - Gets a with the specified name. - - The property name. - A with the specified name or null. - - - - Gets the with the specified name. - The exact name will be searched for first and if no matching property is found then - the will be used to match a property. - - The property name. - One of the enumeration values that specifies how the strings will be compared. - A matched with the specified name or null. - - - - Gets a of of this object's property values. - - A of of this object's property values. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets or sets the with the specified property name. - - - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - is not valid JSON. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - is not valid JSON. - - - - - - - - Creates a from an object. - - The object that will be used to create . - A with the values of the specified object. - - - - Creates a from an object. - - The object that will be used to create . - The that will be used to read the object. - A with the values of the specified object. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Gets the with the specified property name. - - Name of the property. - The with the specified property name. - - - - Gets the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - One of the enumeration values that specifies how the strings will be compared. - The with the specified property name. - - - - Tries to get the with the specified property name. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - Name of the property. - The value. - One of the enumeration values that specifies how the strings will be compared. - true if a value was successfully retrieved; otherwise, false. - - - - Adds the specified property name. - - Name of the property. - The value. - - - - Determines whether the JSON object has the specified property name. - - Name of the property. - true if the JSON object has the specified property name; otherwise, false. - - - - Removes the property with the specified name. - - Name of the property. - true if item was successfully removed; otherwise, false. - - - - Tries to get the with the specified property name. - - Name of the property. - The value. - true if a value was successfully retrieved; otherwise, false. - - - - Returns an enumerator that can be used to iterate through the collection. - - - A that can be used to iterate through the collection. - - - - - Raises the event with the provided arguments. - - Name of the property. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Represents a JSON property. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Asynchronously loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns a that contains the JSON that was read from the specified . - - - - Gets the container's children tokens. - - The container's children tokens. - - - - Gets the property name. - - The property name. - - - - Gets or sets the property value. - - The property value. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Gets the node type for this . - - The type. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Initializes a new instance of the class. - - The property name. - The property content. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Loads a from a . - - A that will be read for the content of the . - A that contains the JSON that was read from the specified . - - - - Loads a from a . - - A that will be read for the content of the . - The used to load the JSON. - If this is null, default load settings will be used. - A that contains the JSON that was read from the specified . - - - - Represents a raw JSON string. - - - - - Asynchronously creates an instance of with the content of the reader's current token. - - The reader. - The token to monitor for cancellation requests. The default value is . - A representing the asynchronous creation. The - property returns an instance of with the content of the reader's current token. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class. - - The raw json. - - - - Creates an instance of with the content of the reader's current token. - - The reader. - An instance of with the content of the reader's current token. - - - - Specifies the settings used when loading JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets how JSON comments are handled when loading JSON. - The default value is . - - The JSON comment handling. - - - - Gets or sets how JSON line info is handled when loading JSON. - The default value is . - - The JSON line info handling. - - - - Gets or sets how duplicate property names in JSON objects are handled when loading JSON. - The default value is . - - The JSON duplicate property name handling. - - - - Specifies the settings used when merging JSON. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the method used when merging JSON arrays. - - The method used when merging JSON arrays. - - - - Gets or sets how null value properties are merged. - - How null value properties are merged. - - - - Gets or sets the comparison used to match property names while merging. - The exact property name will be searched for first and if no matching property is found then - the will be used to match a property. - - The comparison used to match property names while merging. - - - - Represents an abstract JSON token. - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Writes this token to a asynchronously. - - A into which this method will write. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains - the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Asynchronously creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - The token to monitor for cancellation requests. The default value is . - - A that represents the asynchronous creation. The - property returns a that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Gets a comparer that can compare two tokens for value equality. - - A that can compare two nodes for value equality. - - - - Gets or sets the parent. - - The parent. - - - - Gets the root of this . - - The root of this . - - - - Gets the node type for this . - - The type. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Compares the values of two tokens, including the values of all descendant tokens. - - The first to compare. - The second to compare. - true if the tokens are equal; otherwise false. - - - - Gets the next sibling token of this node. - - The that contains the next sibling token. - - - - Gets the previous sibling token of this node. - - The that contains the previous sibling token. - - - - Gets the path of the JSON token. - - - - - Adds the specified content immediately after this token. - - A content object that contains simple content or a collection of content objects to be added after this token. - - - - Adds the specified content immediately before this token. - - A content object that contains simple content or a collection of content objects to be added before this token. - - - - Returns a collection of the ancestor tokens of this token. - - A collection of the ancestor tokens of this token. - - - - Returns a collection of tokens that contain this token, and the ancestors of this token. - - A collection of tokens that contain this token, and the ancestors of this token. - - - - Returns a collection of the sibling tokens after this token, in document order. - - A collection of the sibling tokens after this tokens, in document order. - - - - Returns a collection of the sibling tokens before this token, in document order. - - A collection of the sibling tokens before this token, in document order. - - - - Gets the with the specified key. - - The with the specified key. - - - - Gets the with the specified key converted to the specified type. - - The type to convert the token to. - The token key. - The converted token value. - - - - Get the first child token of this token. - - A containing the first child token of the . - - - - Get the last child token of this token. - - A containing the last child token of the . - - - - Returns a collection of the child tokens of this token, in document order. - - An of containing the child tokens of this , in document order. - - - - Returns a collection of the child tokens of this token, in document order, filtered by the specified type. - - The type to filter the child tokens on. - A containing the child tokens of this , in document order. - - - - Returns a collection of the child values of this token, in document order. - - The type to convert the values to. - A containing the child values of this , in document order. - - - - Removes this token from its parent. - - - - - Replaces this token with the specified token. - - The value. - - - - Writes this token to a . - - A into which this method will write. - A collection of which will be used when writing the token. - - - - Returns the indented JSON for this token. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - The indented JSON for this token. - - - - - Returns the JSON for this token using the given formatting and converters. - - Indicates how the output should be formatted. - A collection of s which will be used when writing the token. - The JSON for this token using the given formatting and converters. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to []. - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to of . - - The value. - The result of the conversion. - - - - Performs an explicit conversion from to . - - The value. - The result of the conversion. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from [] to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from to . - - The value to create a from. - The initialized with the specified value. - - - - Performs an implicit conversion from of to . - - The value to create a from. - The initialized with the specified value. - - - - Creates a for this token. - - A that can be used to read this token and its descendants. - - - - Creates a from an object. - - The object that will be used to create . - A with the value of the specified object. - - - - Creates a from an object using the specified . - - The object that will be used to create . - The that will be used when reading the object. - A with the value of the specified object. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the . - - The object type that the token will be deserialized to. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates an instance of the specified .NET type from the using the specified . - - The object type that the token will be deserialized to. - The that will be used when creating the object. - The new object created from the JSON value. - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - An positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Load a from a string that contains JSON. - - A that contains JSON. - A populated from the string that contains JSON. - - - - Load a from a string that contains JSON. - - A that contains JSON. - The used to load the JSON. - If this is null, default load settings will be used. - A populated from the string that contains JSON. - - - - Creates a from a . - - A positioned at the token to read into this . - The used to load the JSON. - If this is null, default load settings will be used. - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Creates a from a . - - A positioned at the token to read into this . - - A that contains the token and its descendant tokens - that were read from the reader. The runtime type of the token is determined - by the token type of the first token encountered in the reader. - - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A , or null. - - - - Selects a using a JSONPath expression. Selects the token that matches the object path. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - A . - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - An of that contains the selected elements. - - - - Selects a collection of elements using a JSONPath expression. - - - A that contains a JSONPath expression. - - A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. - An of that contains the selected elements. - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Creates a new instance of the . All child tokens are recursively cloned. - - A new instance of the . - - - - Adds an object to the annotation list of this . - - The annotation to add. - - - - Get the first annotation object of the specified type from this . - - The type of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets the first annotation object of the specified type from this . - - The of the annotation to retrieve. - The first annotation object that matches the specified type, or null if no annotation is of the specified type. - - - - Gets a collection of annotations of the specified type for this . - - The type of the annotations to retrieve. - An that contains the annotations for this . - - - - Gets a collection of annotations of the specified type for this . - - The of the annotations to retrieve. - An of that contains the annotations that match the specified type for this . - - - - Removes the annotations of the specified type from this . - - The type of annotations to remove. - - - - Removes the annotations of the specified type from this . - - The of annotations to remove. - - - - Compares tokens to determine whether they are equal. - - - - - Determines whether the specified objects are equal. - - The first object of type to compare. - The second object of type to compare. - - true if the specified objects are equal; otherwise, false. - - - - - Returns a hash code for the specified object. - - The for which a hash code is to be returned. - A hash code for the specified object. - The type of is a reference type and is null. - - - - Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. - - - - - Gets the at the reader's current position. - - - - - Initializes a new instance of the class. - - The token to read from. - - - - Initializes a new instance of the class. - - The token to read from. - The initial path of the token. It is prepended to the returned . - - - - Reads the next JSON token from the underlying . - - - true if the next token was read successfully; false if there are no more tokens to read. - - - - - Gets the path of the current JSON token. - - - - - Specifies the type of token. - - - - - No token type has been set. - - - - - A JSON object. - - - - - A JSON array. - - - - - A JSON constructor. - - - - - A JSON object property. - - - - - A comment. - - - - - An integer value. - - - - - A float value. - - - - - A string value. - - - - - A boolean value. - - - - - A null value. - - - - - An undefined value. - - - - - A date value. - - - - - A raw JSON value. - - - - - A collection of bytes value. - - - - - A Guid value. - - - - - A Uri value. - - - - - A TimeSpan value. - - - - - Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. - - - - - Gets the at the writer's current position. - - - - - Gets the token being written. - - The token being written. - - - - Initializes a new instance of the class writing to the given . - - The container being written to. - - - - Initializes a new instance of the class. - - - - - Flushes whatever is in the buffer to the underlying . - - - - - Closes this writer. - If is set to true, the JSON is auto-completed. - - - Setting to true has no additional effect, since the underlying is a type that cannot be closed. - - - - - Writes the beginning of a JSON object. - - - - - Writes the beginning of a JSON array. - - - - - Writes the start of a constructor with the given name. - - The name of the constructor. - - - - Writes the end. - - The token. - - - - Writes the property name of a name/value pair on a JSON object. - - The name of the property. - - - - Writes a value. - An error will be raised if the value cannot be written as a single JSON token. - - The value to write. - - - - Writes a null value. - - - - - Writes an undefined value. - - - - - Writes raw JSON. - - The raw JSON to write. - - - - Writes a comment /*...*/ containing the specified text. - - Text to place inside the comment. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a [] value. - - The [] value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Writes a value. - - The value to write. - - - - Represents a value in JSON (string, integer, date, etc). - - - - - Writes this token to a asynchronously. - - A into which this method will write. - The token to monitor for cancellation requests. - A collection of which will be used when writing the token. - A that represents the asynchronous write operation. - - - - Initializes a new instance of the class from another object. - - A object to copy from. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Initializes a new instance of the class with the given value. - - The value. - - - - Gets a value indicating whether this token has child tokens. - - - true if this token has child values; otherwise, false. - - - - - Creates a comment with the given value. - - The value. - A comment with the given value. - - - - Creates a string with the given value. - - The value. - A string with the given value. - - - - Creates a null value. - - A null value. - - - - Creates a undefined value. - - A undefined value. - - - - Gets the node type for this . - - The type. - - - - Gets or sets the underlying token value. - - The underlying token value. - - - - Writes this token to a . - - A into which this method will write. - A collection of s which will be used when writing the token. - - - - Indicates whether the current object is equal to another object of the same type. - - - true if the current object is equal to the parameter; otherwise, false. - - An object to compare with this object. - - - - Determines whether the specified is equal to the current . - - The to compare with the current . - - true if the specified is equal to the current ; otherwise, false. - - - - - Serves as a hash function for a particular type. - - - A hash code for the current . - - - - - Returns a that represents this instance. - - - ToString() returns a non-JSON string value for tokens with a type of . - If you want the JSON for all token types then you should use . - - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format provider. - - A that represents this instance. - - - - - Returns a that represents this instance. - - The format. - The format provider. - - A that represents this instance. - - - - - Returns the responsible for binding operations performed on this object. - - The expression tree representation of the runtime value. - - The to bind this object. - - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: - Value - Meaning - Less than zero - This instance is less than . - Zero - This instance is equal to . - Greater than zero - This instance is greater than . - - - is not of the same type as this instance. - - - - - Specifies how line information is handled when loading JSON. - - - - - Ignore line information. - - - - - Load line information. - - - - - Specifies how JSON arrays are merged together. - - - - Concatenate arrays. - - - Union arrays, skipping items that already exist. - - - Replace all array items. - - - Merge array items together, matched by index. - - - - Specifies how null value properties are merged. - - - - - The content's null value properties will be ignored during merging. - - - - - The content's null value properties will be merged. - - - - - Specifies the member serialization options for the . - - - - - All public members are serialized by default. Members can be excluded using or . - This is the default member serialization mode. - - - - - Only members marked with or are serialized. - This member serialization mode can also be set by marking the class with . - - - - - All public and private fields are serialized. Members can be excluded using or . - This member serialization mode can also be set by marking the class with - and setting IgnoreSerializableAttribute on to false. - - - - - Specifies metadata property handling options for the . - - - - - Read metadata properties located at the start of a JSON object. - - - - - Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. - - - - - Do not try to read metadata properties. - - - - - Specifies missing member handling options for the . - - - - - Ignore a missing member and do not attempt to deserialize it. - - - - - Throw a when a missing member is encountered during deserialization. - - - - - Specifies null value handling options for the . - - - - - - - - - Include null values when serializing and deserializing objects. - - - - - Ignore null values when serializing and deserializing objects. - - - - - Specifies how object creation is handled by the . - - - - - Reuse existing objects, create new objects when needed. - - - - - Only reuse existing objects. - - - - - Always create new objects. - - - - - Specifies reference handling options for the . - Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement . - - - - - - - - Do not preserve references when serializing types. - - - - - Preserve references when serializing into a JSON object structure. - - - - - Preserve references when serializing into a JSON array structure. - - - - - Preserve references when serializing. - - - - - Specifies reference loop handling options for the . - - - - - Throw a when a loop is encountered. - - - - - Ignore loop references and do not serialize. - - - - - Serialize loop references. - - - - - Indicating whether a property is required. - - - - - The property is not required. The default state. - - - - - The property must be defined in JSON but can be a null value. - - - - - The property must be defined in JSON and cannot be a null value. - - - - - The property is not required but it cannot be a null value. - - - - - - Contains the JSON schema extension methods. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - true if the specified is valid; otherwise, false. - - - - - - Determines whether the is valid. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - When this method returns, contains any error messages generated while validating. - - true if the specified is valid; otherwise, false. - - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - - - - - Validates the specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - The source to test. - The schema to test with. - The validation event handler. - - - - - An in-memory representation of a JSON Schema. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the id. - - - - - Gets or sets the title. - - - - - Gets or sets whether the object is required. - - - - - Gets or sets whether the object is read-only. - - - - - Gets or sets whether the object is visible to users. - - - - - Gets or sets whether the object is transient. - - - - - Gets or sets the description of the object. - - - - - Gets or sets the types of values allowed by the object. - - The type. - - - - Gets or sets the pattern. - - The pattern. - - - - Gets or sets the minimum length. - - The minimum length. - - - - Gets or sets the maximum length. - - The maximum length. - - - - Gets or sets a number that the value should be divisible by. - - A number that the value should be divisible by. - - - - Gets or sets the minimum. - - The minimum. - - - - Gets or sets the maximum. - - The maximum. - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the minimum attribute (). - - A flag indicating whether the value can not equal the number defined by the minimum attribute (). - - - - Gets or sets a flag indicating whether the value can not equal the number defined by the maximum attribute (). - - A flag indicating whether the value can not equal the number defined by the maximum attribute (). - - - - Gets or sets the minimum number of items. - - The minimum number of items. - - - - Gets or sets the maximum number of items. - - The maximum number of items. - - - - Gets or sets the of items. - - The of items. - - - - Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . - - - true if items are validated using their array position; otherwise, false. - - - - - Gets or sets the of additional items. - - The of additional items. - - - - Gets or sets a value indicating whether additional items are allowed. - - - true if additional items are allowed; otherwise, false. - - - - - Gets or sets whether the array items must be unique. - - - - - Gets or sets the of properties. - - The of properties. - - - - Gets or sets the of additional properties. - - The of additional properties. - - - - Gets or sets the pattern properties. - - The pattern properties. - - - - Gets or sets a value indicating whether additional properties are allowed. - - - true if additional properties are allowed; otherwise, false. - - - - - Gets or sets the required property if this property is present. - - The required property if this property is present. - - - - Gets or sets the a collection of valid enum values allowed. - - A collection of valid enum values allowed. - - - - Gets or sets disallowed types. - - The disallowed types. - - - - Gets or sets the default value. - - The default value. - - - - Gets or sets the collection of that this schema extends. - - The collection of that this schema extends. - - - - Gets or sets the format. - - The format. - - - - Initializes a new instance of the class. - - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The object representing the JSON Schema. - - - - Reads a from the specified . - - The containing the JSON Schema to read. - The to use when resolving schema references. - The object representing the JSON Schema. - - - - Load a from a string that contains JSON Schema. - - A that contains JSON Schema. - A populated from the string that contains JSON Schema. - - - - Load a from a string that contains JSON Schema using the specified . - - A that contains JSON Schema. - The resolver. - A populated from the string that contains JSON Schema. - - - - Writes this schema to a . - - A into which this method will write. - - - - Writes this schema to a using the specified . - - A into which this method will write. - The resolver used. - - - - Returns a that represents the current . - - - A that represents the current . - - - - - - Returns detailed information about the schema exception. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the line number indicating where the error occurred. - - The line number indicating where the error occurred. - - - - Gets the line position indicating where the error occurred. - - The line position indicating where the error occurred. - - - - Gets the path to the JSON where the error occurred. - - The path to the JSON where the error occurred. - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class - with a specified error message. - - The error message that explains the reason for the exception. - - - - Initializes a new instance of the class - with a specified error message and a reference to the inner exception that is the cause of this exception. - - The error message that explains the reason for the exception. - The exception that is the cause of the current exception, or null if no inner exception is specified. - - - - - Generates a from a specified . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets how undefined schemas are handled by the serializer. - - - - - Gets or sets the contract resolver. - - The contract resolver. - - - - Generate a from the specified type. - - The type to generate a from. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - Generate a from the specified type. - - The type to generate a from. - The used to resolve schema references. - Specify whether the generated root will be nullable. - A generated from the specified type. - - - - - Resolves from an id. - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets or sets the loaded schemas. - - The loaded schemas. - - - - Initializes a new instance of the class. - - - - - Gets a for the specified reference. - - The id. - A for the specified reference. - - - - - The value types allowed by the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - No type specified. - - - - - String type. - - - - - Float type. - - - - - Integer type. - - - - - Boolean type. - - - - - Object type. - - - - - Array type. - - - - - Null type. - - - - - Any type. - - - - - - Specifies undefined schema Id handling options for the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Do not infer a schema Id. - - - - - Use the .NET type name as the schema Id. - - - - - Use the assembly qualified .NET type name as the schema Id. - - - - - - Returns detailed information related to the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Gets the associated with the validation error. - - The JsonSchemaException associated with the validation error. - - - - Gets the path of the JSON location where the validation error occurred. - - The path of the JSON location where the validation error occurred. - - - - Gets the text description corresponding to the validation error. - - The text description. - - - - - Represents the callback method that will handle JSON schema validation events and the . - - - JSON Schema validation has been moved to its own package. See https://www.newtonsoft.com/jsonschema for more details. - - - - - - Allows users to control class loading and mandate what class to load. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - A camel case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Resolves member mappings for a type, camel casing property names. - - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used by to resolve a for a given . - - - - - Gets a value indicating whether members are being get and set using dynamic code generation. - This value is determined by the runtime permissions available. - - - true if using dynamic code generation; otherwise, false. - - - - - Gets or sets a value indicating whether compiler generated members should be serialized. - - - true if serialized compiler generated members; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore IsSpecified members when serializing and deserializing types. - - - true if the IsSpecified members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets a value indicating whether to ignore ShouldSerialize members when serializing and deserializing types. - - - true if the ShouldSerialize members will be ignored when serializing and deserializing types; otherwise, false. - - - - - Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. - - The naming strategy used to resolve how property names and dictionary keys are serialized. - - - - Initializes a new instance of the class. - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Gets the serializable members for the type. - - The type to get serializable members for. - The serializable members for the type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates the constructor parameters. - - The constructor to create properties for. - The type's member properties. - Properties for the given . - - - - Creates a for the given . - - The matching member property. - The constructor parameter. - A created for the given . - - - - Resolves the default for the contract. - - Type of the object. - The contract's default . - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Creates a for the given type. - - Type of the object. - A for the given type. - - - - Determines which contract type is created for the given type. - - Type of the object. - A for the given type. - - - - Creates properties for the given . - - The type to create properties for. - /// The member serialization mode for the type. - Properties for the given . - - - - Creates the used by the serializer to get and set values from a member. - - The member. - The used by the serializer to get and set values from a member. - - - - Creates a for the given . - - The member's parent . - The member to create a for. - A created for the given . - - - - Resolves the name of the property. - - Name of the property. - Resolved name of the property. - - - - Resolves the name of the extension data. By default no changes are made to extension data names. - - Name of the extension data. - Resolved name of the extension data. - - - - Resolves the key of the dictionary. By default is used to resolve dictionary keys. - - Key of the dictionary. - Resolved key of the dictionary. - - - - Gets the resolved name of the property. - - Name of the property. - Name of the property. - - - - The default naming strategy. Property names and dictionary keys are unchanged. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - The default serialization binder used when resolving and loading classes from type names. - - - - - Initializes a new instance of the class. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - The type of the object the formatter creates a new instance of. - - - - - When overridden in a derived class, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Provides information surrounding an error. - - - - - Gets the error. - - The error. - - - - Gets the original object that caused the error. - - The original object that caused the error. - - - - Gets the member that caused the error. - - The member that caused the error. - - - - Gets the path of the JSON location where the error occurred. - - The path of the JSON location where the error occurred. - - - - Gets or sets a value indicating whether this is handled. - - true if handled; otherwise, false. - - - - Provides data for the Error event. - - - - - Gets the current object the error event is being raised against. - - The current object the error event is being raised against. - - - - Gets the error context. - - The error context. - - - - Initializes a new instance of the class. - - The current object. - The error context. - - - - Get and set values for a using dynamic methods. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Provides methods to get attributes. - - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Used by to resolve a for a given . - - - - - - - - - Resolves the contract for a given type. - - The type to resolve a contract for. - The contract for a given type. - - - - Used to resolve references when serializing and deserializing JSON by the . - - - - - Resolves a reference to its object. - - The serialization context. - The reference to resolve. - The object that was resolved from the reference. - - - - Gets the reference for the specified object. - - The serialization context. - The object to get a reference for. - The reference to the object. - - - - Determines whether the specified object is referenced. - - The serialization context. - The object to test for a reference. - - true if the specified object is referenced; otherwise, false. - - - - - Adds a reference to the specified object. - - The serialization context. - The reference. - The object to reference. - - - - Allows users to control class loading and mandate what class to load. - - - - - When implemented, controls the binding of a serialized object to a type. - - Specifies the name of the serialized object. - Specifies the name of the serialized object - The type of the object the formatter creates a new instance of. - - - - When implemented, controls the binding of a serialized object to a type. - - The type of the object the formatter creates a new instance of. - Specifies the name of the serialized object. - Specifies the name of the serialized object. - - - - Represents a trace writer. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - The that will be used to filter the trace messages passed to the writer. - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Provides methods to get and set values. - - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - Contract details for a used by the . - - - - - Gets the of the collection items. - - The of the collection items. - - - - Gets a value indicating whether the collection type is a multidimensional array. - - true if the collection type is a multidimensional array; otherwise, false. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the collection values. - - true if the creator has a parameter with the collection values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the default collection items . - - The converter. - - - - Gets or sets a value indicating whether the collection items preserve object references. - - true if collection items preserve object references; otherwise, false. - - - - Gets or sets the collection item reference loop handling. - - The reference loop handling. - - - - Gets or sets the collection item type name handling. - - The type name handling. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Handles serialization callback events. - - The object that raised the callback event. - The streaming context. - - - - Handles serialization error callback events. - - The object that raised the callback event. - The streaming context. - The error context. - - - - Sets extension data for an object during deserialization. - - The object to set extension data on. - The extension data key. - The extension data value. - - - - Gets extension data for an object during serialization. - - The object to set extension data on. - - - - Contract details for a used by the . - - - - - Gets the underlying type for the contract. - - The underlying type for the contract. - - - - Gets or sets the type created during deserialization. - - The type created during deserialization. - - - - Gets or sets whether this type contract is serialized as a reference. - - Whether this type contract is serialized as a reference. - - - - Gets or sets the default for this contract. - - The converter. - - - - Gets the internally resolved for the contract's type. - This converter is used as a fallback converter when no other converter is resolved. - Setting will always override this converter. - - - - - Gets or sets all methods called immediately after deserialization of the object. - - The methods called immediately after deserialization of the object. - - - - Gets or sets all methods called during deserialization of the object. - - The methods called during deserialization of the object. - - - - Gets or sets all methods called after serialization of the object graph. - - The methods called after serialization of the object graph. - - - - Gets or sets all methods called before serialization of the object. - - The methods called before serialization of the object. - - - - Gets or sets all method called when an error is thrown during the serialization of the object. - - The methods called when an error is thrown during the serialization of the object. - - - - Gets or sets the default creator method used to create the object. - - The default creator method used to create the object. - - - - Gets or sets a value indicating whether the default creator is non-public. - - true if the default object creator is non-public; otherwise, false. - - - - Contract details for a used by the . - - - - - Gets or sets the dictionary key resolver. - - The dictionary key resolver. - - - - Gets the of the dictionary keys. - - The of the dictionary keys. - - - - Gets the of the dictionary values. - - The of the dictionary values. - - - - Gets or sets the function used to create the object. When set this function will override . - - The function used to create the object. - - - - Gets a value indicating whether the creator has a parameter with the dictionary values. - - true if the creator has a parameter with the dictionary values; otherwise, false. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets the object's properties. - - The object's properties. - - - - Gets or sets the property name resolver. - - The property name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Gets or sets the object member serialization. - - The member object serialization. - - - - Gets or sets the missing member handling used when deserializing this object. - - The missing member handling. - - - - Gets or sets a value that indicates whether the object's properties are required. - - - A value indicating whether the object's properties are required. - - - - - Gets or sets how the object's properties with null values are handled during serialization and deserialization. - - How the object's properties with null values are handled during serialization and deserialization. - - - - Gets the object's properties. - - The object's properties. - - - - Gets a collection of instances that define the parameters used with . - - - - - Gets or sets the function used to create the object. When set this function will override . - This function is called with a collection of arguments which are defined by the collection. - - The function used to create the object. - - - - Gets or sets the extension data setter. - - - - - Gets or sets the extension data getter. - - - - - Gets or sets the extension data value type. - - - - - Gets or sets the extension data name resolver. - - The extension data name resolver. - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Maps a JSON property to a .NET member or constructor parameter. - - - - - Gets or sets the name of the property. - - The name of the property. - - - - Gets or sets the type that declared this property. - - The type that declared this property. - - - - Gets or sets the order of serialization of a member. - - The numeric order of serialization. - - - - Gets or sets the name of the underlying member or parameter. - - The name of the underlying member or parameter. - - - - Gets the that will get and set the during serialization. - - The that will get and set the during serialization. - - - - Gets or sets the for this property. - - The for this property. - - - - Gets or sets the type of the property. - - The type of the property. - - - - Gets or sets the for the property. - If set this converter takes precedence over the contract converter for the property type. - - The converter. - - - - Gets or sets the member converter. - - The member converter. - - - - Gets or sets a value indicating whether this is ignored. - - true if ignored; otherwise, false. - - - - Gets or sets a value indicating whether this is readable. - - true if readable; otherwise, false. - - - - Gets or sets a value indicating whether this is writable. - - true if writable; otherwise, false. - - - - Gets or sets a value indicating whether this has a member attribute. - - true if has a member attribute; otherwise, false. - - - - Gets the default value. - - The default value. - - - - Gets or sets a value indicating whether this is required. - - A value indicating whether this is required. - - - - Gets a value indicating whether has a value specified. - - - - - Gets or sets a value indicating whether this property preserves object references. - - - true if this instance is reference; otherwise, false. - - - - - Gets or sets the property null value handling. - - The null value handling. - - - - Gets or sets the property default value handling. - - The default value handling. - - - - Gets or sets the property reference loop handling. - - The reference loop handling. - - - - Gets or sets the property object creation handling. - - The object creation handling. - - - - Gets or sets or sets the type name handling. - - The type name handling. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets a predicate used to determine whether the property should be deserialized. - - A predicate used to determine whether the property should be deserialized. - - - - Gets or sets a predicate used to determine whether the property should be serialized. - - A predicate used to determine whether the property should be serialized. - - - - Gets or sets an action used to set whether the property has been deserialized. - - An action used to set whether the property has been deserialized. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Gets or sets the converter used when serializing the property's collection items. - - The collection's items converter. - - - - Gets or sets whether this property's collection items are serialized as a reference. - - Whether this property's collection items are serialized as a reference. - - - - Gets or sets the type name handling used when serializing the property's collection items. - - The collection's items type name handling. - - - - Gets or sets the reference loop handling used when serializing the property's collection items. - - The collection's items reference loop handling. - - - - A collection of objects. - - - - - Initializes a new instance of the class. - - The type. - - - - When implemented in a derived class, extracts the key from the specified element. - - The element from which to extract the key. - The key for the specified element. - - - - Adds a object. - - The property to add to the collection. - - - - Gets the closest matching object. - First attempts to get an exact case match of and then - a case insensitive match. - - Name of the property. - A matching property if found. - - - - Gets a property by property name. - - The name of the property to get. - Type property name string comparison. - A matching property if found. - - - - Contract details for a used by the . - - - - - Initializes a new instance of the class. - - The underlying type for the contract. - - - - Lookup and create an instance of the type described by the argument. - - The type to create. - Optional arguments to pass to an initializing constructor of the JsonConverter. - If null, the default constructor is used. - - - - A kebab case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Represents a trace writer that writes to memory. When the trace message limit is - reached then old trace messages will be removed as new messages are added. - - - - - Gets the that will be used to filter the trace messages passed to the writer. - For example a filter level of will exclude messages and include , - and messages. - - - The that will be used to filter the trace messages passed to the writer. - - - - - Initializes a new instance of the class. - - - - - Writes the specified trace level, message and optional exception. - - The at which to write this trace. - The trace message. - The trace exception. This parameter is optional. - - - - Returns an enumeration of the most recent trace messages. - - An enumeration of the most recent trace messages. - - - - Returns a of the most recent trace messages. - - - A of the most recent trace messages. - - - - - A base class for resolving how property names and dictionary keys are serialized. - - - - - A flag indicating whether dictionary keys should be processed. - Defaults to false. - - - - - A flag indicating whether extension data names should be processed. - Defaults to false. - - - - - A flag indicating whether explicitly specified property names, - e.g. a property name customized with a , should be processed. - Defaults to false. - - - - - Gets the serialized name for a given property name. - - The initial property name. - A flag indicating whether the property has had a name explicitly specified. - The serialized property name. - - - - Gets the serialized name for a given extension data name. - - The initial extension data name. - The serialized extension data name. - - - - Gets the serialized key for a given dictionary key. - - The initial dictionary key. - The serialized dictionary key. - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Hash code calculation - - - - - - Object equality implementation - - - - - - - Compare to another NamingStrategy - - - - - - - Represents a method that constructs an object. - - The object type to create. - - - - When applied to a method, specifies that the method is called when an error occurs serializing an object. - - - - - Provides methods to get attributes from a , , or . - - - - - Initializes a new instance of the class. - - The instance to get attributes for. This parameter should be a , , or . - - - - Returns a collection of all of the attributes, or an empty collection if there are no attributes. - - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. - - The type of the attributes. - When true, look up the hierarchy chain for the inherited custom attribute. - A collection of s, or an empty collection. - - - - Get and set values for a using reflection. - - - - - Initializes a new instance of the class. - - The member info. - - - - Sets the value. - - The target to set the value on. - The value to set on the target. - - - - Gets the value. - - The target to get the value from. - The value. - - - - A snake case naming strategy. - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - - - Initializes a new instance of the class. - - - A flag indicating whether dictionary keys should be processed. - - - A flag indicating whether explicitly specified property names should be processed, - e.g. a property name customized with a . - - - A flag indicating whether extension data names should be processed. - - - - - Initializes a new instance of the class. - - - - - Resolves the specified property name. - - The property name to resolve. - The resolved property name. - - - - Specifies how strings are escaped when writing JSON text. - - - - - Only control characters (e.g. newline) are escaped. - - - - - All non-ASCII and control characters (e.g. newline) are escaped. - - - - - HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. - - - - - Specifies what messages to output for the class. - - - - - Output no tracing and debugging messages. - - - - - Output error-handling messages. - - - - - Output warnings and error-handling messages. - - - - - Output informational messages, warnings, and error-handling messages. - - - - - Output all debugging and tracing messages. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the LoadWithPartialName method of the class is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The Load method of the class is used to load the assembly. - - - - - Specifies type name handling options for the . - - - should be used with caution when your application deserializes JSON from an external source. - Incoming types should be validated with a custom - when deserializing with a value other than . - - - - - Do not include the .NET type name when serializing types. - - - - - Include the .NET type name when serializing into a JSON object structure. - - - - - Include the .NET type name when serializing into a JSON array structure. - - - - - Always include the .NET type name when serializing. - - - - - Include the .NET type name when the type of the object being serialized is not the same as its declared type. - Note that this doesn't include the root serialized object by default. To include the root object's type name in JSON - you must specify a root type object with - or . - - - - - Determines whether the collection is null or empty. - - The collection. - - true if the collection is null or empty; otherwise, false. - - - - - Adds the elements of the specified collection to the specified generic . - - The list to add to. - The collection of elements to add. - - - - Converts the value to the specified type. If the value is unable to be converted, the - value is checked whether it assignable to the specified type. - - The value to convert. - The culture to use when converting. - The type to convert or cast the value to. - - The converted type. If conversion was unsuccessful, the initial value - is returned if assignable to the target type. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic that returns a result - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Helper method for generating a MetaObject which calls a - specific method on Dynamic, but uses one of the arguments for - the result. - - - - - Returns a Restrictions object which includes our current restrictions merged - with a restriction limiting our type - - - - - Helper class for serializing immutable collections. - Note that this is used by all builds, even those that don't support immutable collections, in case the DLL is GACed - https://github.com/JamesNK/Newtonsoft.Json/issues/652 - - - - - List of primitive types which can be widened. - - - - - Widening masks for primitive types above. - Index of the value in this array defines a type we're widening, - while the bits in mask define types it can be widened to (including itself). - - For example, value at index 0 defines a bool type, and it only has bit 0 set, - i.e. bool values can be assigned only to bool. - - - - - Checks if value of primitive type can be - assigned to parameter of primitive type . - - Source primitive type. - Target primitive type. - true if source type can be widened to target type, false otherwise. - - - - Checks if a set of values with given can be used - to invoke a method with specified . - - Method parameters. - Argument types. - Try to pack extra arguments into the last parameter when it is marked up with . - true if method can be called with given arguments, false otherwise. - - - - Compares two sets of parameters to determine - which one suits better for given argument types. - - - - - Returns a best method overload for given argument . - - List of method candidates. - Argument types. - Best method overload, or null if none matched. - - - - Gets the type of the typed collection's items. - - The type. - The type of the typed collection's items. - - - - Gets the member's underlying type. - - The member. - The underlying type of the member. - - - - Determines whether the property is an indexed property. - - The property. - - true if the property is an indexed property; otherwise, false. - - - - - Gets the member's value on the object. - - The member. - The target object. - The member's value on the object. - - - - Sets the member's value on the target object. - - The member. - The target. - The value. - - - - Determines whether the specified MemberInfo can be read. - - The MemberInfo to determine whether can be read. - /// if set to true then allow the member to be gotten non-publicly. - - true if the specified MemberInfo can be read; otherwise, false. - - - - - Determines whether the specified MemberInfo can be set. - - The MemberInfo to determine whether can be set. - if set to true then allow the member to be set non-publicly. - if set to true then allow the member to be set if read-only. - - true if the specified MemberInfo can be set; otherwise, false. - - - - - Builds a string. Unlike this class lets you reuse its internal buffer. - - - - - Determines whether the string is all white space. Empty string will return false. - - The string to test whether it is all white space. - - true if the string is all white space; otherwise, false. - - - - - Specifies the state of the . - - - - - An exception has been thrown, which has left the in an invalid state. - You may call the method to put the in the Closed state. - Any other method calls result in an being thrown. - - - - - The method has been called. - - - - - An object is being written. - - - - - An array is being written. - - - - - A constructor is being written. - - - - - A property is being written. - - - - - A write method has not been called. - - - - - Indicates the method that will be used during deserialization for locating and loading assemblies. - - - - - In simple mode, the assembly used during deserialization need not match exactly the assembly used during serialization. Specifically, the version numbers need not match as the method is used to load the assembly. - - - - - In full mode, the assembly used during deserialization must match exactly the assembly used during serialization. The is used to load the assembly. - - - - Specifies that an output will not be null even if the corresponding type allows it. - - - Specifies that when a method returns , the parameter will not be null even if the corresponding type allows it. - - - Initializes the attribute with the specified return value condition. - - The return value condition. If the method returns this value, the associated parameter will not be null. - - - - Gets the return value condition. - - - Specifies that an output may be null even if the corresponding type disallows it. - - - Specifies that null is allowed as an input even if the corresponding type disallows it. - - - - Specifies that the method will not return if the associated Boolean parameter is passed the specified value. - - - - - Initializes a new instance of the class. - - - The condition parameter value. Code after the method will be considered unreachable by diagnostics if the argument to - the associated parameter matches this value. - - - - Gets the condition parameter value. - - - diff --git a/packages/Newtonsoft.Json.12.0.3/packageIcon.png b/packages/Newtonsoft.Json.12.0.3/packageIcon.png deleted file mode 100644 index 10c06a5..0000000 Binary files a/packages/Newtonsoft.Json.12.0.3/packageIcon.png and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/.signature.p7s b/packages/System.Data.SQLite.Core.1.0.112.1/.signature.p7s deleted file mode 100644 index 8d13db1..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/.signature.p7s and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/System.Data.SQLite.Core.1.0.112.1.nupkg b/packages/System.Data.SQLite.Core.1.0.112.1/System.Data.SQLite.Core.1.0.112.1.nupkg deleted file mode 100644 index b5233e3..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/System.Data.SQLite.Core.1.0.112.1.nupkg and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/build/net20/System.Data.SQLite.Core.targets b/packages/System.Data.SQLite.Core.1.0.112.1/build/net20/System.Data.SQLite.Core.targets deleted file mode 100644 index ea1cfd7..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/build/net20/System.Data.SQLite.Core.targets +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - - - - - - - - - - - %(RecursiveDir)%(FileName)%(Extension) - PreserveNewest - - - - - - - - - - - - - - - - - - - - - - - bin\%(RecursiveDir)%(Filename)%(Extension) - - - - - - - - - $(PostBuildEventDependsOn); - CopySQLiteInteropFiles; - - - $(BuildDependsOn); - CopySQLiteInteropFiles; - - - $(CleanDependsOn); - CleanSQLiteInteropFiles; - - - - - - - - CollectSQLiteInteropFiles; - $(PipelineCollectFilesPhaseDependsOn); - - - diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/build/net40/System.Data.SQLite.Core.targets b/packages/System.Data.SQLite.Core.1.0.112.1/build/net40/System.Data.SQLite.Core.targets deleted file mode 100644 index ea1cfd7..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/build/net40/System.Data.SQLite.Core.targets +++ /dev/null @@ -1,142 +0,0 @@ - - - - - - - - - - - - - - - - - - %(RecursiveDir)%(FileName)%(Extension) - PreserveNewest - - - - - - - - - - - - - - - - - - - - - - - bin\%(RecursiveDir)%(Filename)%(Extension) - - - - - - - - - $(PostBuildEventDependsOn); - CopySQLiteInteropFiles; - - - $(BuildDependsOn); - CopySQLiteInteropFiles; - - - $(CleanDependsOn); - CleanSQLiteInteropFiles; - - - - - - - - CollectSQLiteInteropFiles; - $(PipelineCollectFilesPhaseDependsOn); - - - diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll deleted file mode 100644 index 8137b06..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll.config b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll.config deleted file mode 100644 index b14f7b5..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.dll.config +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.xml b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.xml deleted file mode 100644 index 7510396..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net20/System.Data.SQLite.xml +++ /dev/null @@ -1,21406 +0,0 @@ - - - - System.Data.SQLite - - - - - Defines a source code identifier custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code identifier value. - - - The source code identifier value to use. - - - - - Gets the source code identifier value. - - - - - Defines a source code time-stamp custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code time-stamp value. - - - The source code time-stamp value to use. - - - - - Gets the source code time-stamp value. - - - - - This is the method signature for the SQLite core library logging callback - function for use with sqlite3_log() and the SQLITE_CONFIG_LOG. - - WARNING: This delegate is used more-or-less directly by native code, do - not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET - - - - - This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement - a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite. - - - - - This base class provides datatype conversion services for the SQLite provider. - - - - - This character is used to escape other characters, including itself, in - connection string property names and values. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - The character is used to separate the name and value for a connection - string property. This character cannot be present in any connection - string property name. This character can be present in a connection - string property value; however, this should be avoided unless deemed - absolutely necessary. - - - - - This character is used to separate connection string properties. When - the "No_SQLiteConnectionNewParser" setting is enabled, this character - may not appear in connection string property names -OR- values. - - - - - The fallback default database type when one cannot be obtained from an - existing connection instance. - - - - - The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. - - - - - These are the characters that are special to the connection string - parser. - - - - - The fallback default database type name when one cannot be obtained from - an existing connection instance. - - - - - The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). - - - - - The value of the OLE Automation epoch represented as a Julian day. This - field cannot be removed as the test suite relies upon it. - - - - - This is the minimum Julian Day value supported by this library - (148731163200000). - - - - - This is the maximum Julian Day value supported by this library - (464269060799000). - - - - - An array of ISO-8601 DateTime formats that we support parsing. - - - - - The internal default format for UTC DateTime values when converting - to a string. - - - - - The internal default format for local DateTime values when converting - to a string. - - - - - An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 - - - - - The default DateTime format for this instance. - - - - - The default DateTimeKind for this instance. - - - - - The default DateTime format string for this instance. - - - - - Initializes the conversion class - - The default date/time format to use for this instance - The DateTimeKind to use. - The DateTime format string to use. - - - - Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. - - The string to convert to UTF-8 - A byte array containing the converted string plus an extra 0 terminating byte at the end of the array. - - - - Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. - - - This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the - string result. - - The DateTime to convert. - The UTF-8 encoded string, including a 0 terminating byte at the end of the array. - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Checks if the specified is within the - supported range for a Julian Day value. - - - The Julian Day value to check. - - - Non-zero if the specified Julian Day value is in the supported - range; otherwise, zero. - - - - - Converts a Julian Day value from a to an - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value from an to a - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeYMD" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day is out of the supported range. If this value is null, - an exception will be thrown instead. - - - A value that contains the year, month, and - day values that are closest to the specified Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeHMS" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day value is out of the supported range. If this value is - null, an exception will be thrown instead. - - - A value that contains the hour, minute, and - second, and millisecond values that are closest to the specified - Julian Day value. - - - - - Converts a to a Julian Day value. - This method was translated from the "computeJD" function in - the "date.c" file belonging to the SQLite core library. - Since the range of Julian Day values supported by this method - includes all possible (valid) values of a - value, it should be extremely difficult for this method to - raise an exception or return an undefined result. - - - The value to convert. This value - will be within the range of - (00:00:00.0000000, January 1, 0001) to - (23:59:59.9999999, December - 31, 9999). - - - The nearest Julian Day value corresponding to the specified - value. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - A DateTime value - - - - Converts a string into a DateTime, using the specified DateTimeFormat, - DateTimeKind and DateTimeFormatString. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - A DateTime value - - - - Converts a julianday value into a DateTime - - The value to convert - A .NET DateTime - - - - Converts a julianday value into a DateTime - - The value to convert - The DateTimeKind to use. - A .NET DateTime - - - - Converts the specified number of seconds from the Unix epoch into a - value. - - - The number of whole seconds since the Unix epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts the specified number of ticks since the epoch into a - value. - - - The number of whole ticks since the epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts a DateTime struct to a JulianDay double - - The DateTime to convert - The JulianDay value the Datetime represents - - - - Converts a DateTime struct to the whole number of seconds since the - Unix epoch. - - The DateTime to convert - The whole number of seconds since the Unix epoch - - - - Returns the DateTime format string to use for the specified DateTimeKind. - If is not null, it will be returned verbatim. - - The DateTimeKind to use. - The DateTime format string to use. - - The DateTime format string to use for the specified DateTimeKind. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. - - - This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls - ToDateTime() on the string to return a DateTime. - - A pointer to the UTF-8 encoded string - The length in bytes of the string - The parsed DateTime value - - - - Smart method of splitting a string. Skips quoted elements, removes the quotes. - - - This split function works somewhat like the String.Split() function in that it breaks apart a string into - pieces and returns the pieces as an array. The primary differences are: - - Only one character can be provided as a separator character - Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed. - - Thus, if splitting the following string looking for a comma:
- One,Two, "Three, Four", Five
-
- The resulting array would contain
- [0] One
- [1] Two
- [2] Three, Four
- [3] Five
-
- Note that the leading and trailing spaces were removed from each item during the split. -
- Source string to split apart - Separator character - A string array of the split up elements -
- - - Splits the specified string into multiple strings based on a separator - and returns the result as an array of strings. - - - The string to split into pieces based on the separator character. If - this string is null, null will always be returned. If this string is - empty, an array of zero strings will always be returned. - - - The character used to divide the original string into sub-strings. - This character cannot be a backslash or a double-quote; otherwise, no - work will be performed and null will be returned. - - - If this parameter is non-zero, all double-quote characters will be - retained in the returned list of strings; otherwise, they will be - dropped. - - - Upon failure, this parameter will be modified to contain an appropriate - error message. - - - The new array of strings or null if the input string is null -OR- the - separator character is a backslash or a double-quote -OR- the string - contains an unbalanced backslash or double-quote character. - - - - - Queries and returns the string representation for an object, using the - specified (or current) format provider. - - - The object instance to return the string representation for. - - - The format provider to use -OR- null if the current format provider for - the thread should be used instead. - - - The string representation for the object instance -OR- null if the - object instance is also null. - - - - - Attempts to convert an arbitrary object to the Boolean data type. - Null object values are converted to false. Throws an exception - upon failure. - - - The object value to convert. - - - The format provider to use. - - - If non-zero, a string value will be converted using the - - method; otherwise, the - method will be used. - - - The converted boolean value. - - - - - Convert a value to true or false. - - A string or number representing true or false - - - - - Converts an integer to a string that can be round-tripped using the - invariant culture. - - - The integer value to return the string representation for. - - - The string representation of the specified integer value, using the - invariant culture. - - - - - Attempts to convert a into a . - - - The to convert, cannot be null. - - - The converted value. - - - The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1", - as well as any prefix of the strings - and . All strings are treated in a - case-insensitive manner. - - - - - Converts a SQLiteType to a .NET Type object - - The SQLiteType to convert - Returns a .NET Type object - - - - For a given intrinsic type, return a DbType - - The native type to convert - The corresponding (closest match) DbType - - - - Returns the ColumnSize for the given DbType - - The DbType to get the size of - - - - - Determines the default database type name to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default database type name to use. - - - - - If applicable, issues a trace log message warning about falling back to - the default database type name. - - - The database value type. - - - The flags associated with the parent connection object. - - - The textual name of the database type. - - - - - If applicable, issues a trace log message warning about falling back to - the default database value type. - - - The textual name of the database type. - - - The flags associated with the parent connection object. - - - The database value type. - - - - - For a given database value type, return the "closest-match" textual database type name. - - The connection context for custom type mappings, if any. - The database value type. - The flags associated with the parent connection object. - The type name or an empty string if it cannot be determined. - - - - Convert a DbType to a Type - - The DbType to convert from - The closest-match .NET type - - - - For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. - - The type to evaluate - The flags associated with the connection. - The SQLite type affinity for that type. - - - - Builds and returns a map containing the database column types - recognized by this provider. - - - A map containing the database column types recognized by this - provider. - - - - - Determines if a database type is considered to be a string. - - - The database type to check. - - - Non-zero if the database type is considered to be a string, zero - otherwise. - - - - - Determines and returns the runtime configuration setting string that - should be used in place of the specified object value. - - - The object value to convert to a string. - - - Either the string to use in place of the object value -OR- null if it - cannot be determined. - - - - - Determines the default value to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default value to use. - - - - - Converts the object value, which is assumed to have originated - from a , to a string value. - - - The value to be converted to a string. - - - A null value will be returned if the original value is null -OR- - the original value is . Otherwise, - the original value will be converted to a string, using its - (possibly overridden) method and - then returned. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be an - value. - - - The textual value to inspect. - - - Non-zero if the text looks like an value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The object instance configured with - the chosen format. - - - The textual value to inspect. - - - Non-zero if the text looks like a in the - configured format, zero otherwise. - - - - - For a given textual database type name, return the "closest-match" database type. - This method is called during query result processing; therefore, its performance - is critical. - - The connection context for custom type mappings, if any. - The textual name of the database type to match. - The flags associated with the parent connection object. - The .NET DBType the text evaluates to. - - - - The error code used for logging exceptions caught in user-provided - code. - - - - - Returns non-zero if this connection to the database is read-only. - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Shutdown the SQLite engine so that it can be restarted with different config options. - We depend on auto initialization to recover. - - - - - Determines if the associated native connection handle is open. - - - Non-zero if a database connection is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - Opens a database. - - - Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection - to bind all attributed user-defined functions and collating sequences to the new connection. - - The filename of the database to open. SQLite automatically creates it if it doesn't exist. - The name of the VFS to use -OR- null to use the default VFS. - The flags associated with the parent connection object - The open flags to use when creating the connection - The maximum size of the pool for the given filename - If true, the connection can be pulled from the connection pool - - - - Closes the currently-open database. - - - After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated - memory associated with the user-defined functions and collating sequences tied to the closed connection. - - Non-zero if connection is being disposed, zero otherwise. - - - - Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. - - The number of milliseconds to wait before returning SQLITE_BUSY - - - - Returns the text of the last error issued by SQLite - - - - - - Returns the text of the last error issued by SQLite -OR- the specified default error text if - none is available from the SQLite core library. - - - The error text to return in the event that one is not available from the SQLite core library. - - - The error text. - - - - - When pooling is enabled, force this connection to be disposed rather than returned to the pool - - - - - When pooling is enabled, returns the number of pool entries matching the current file name. - - The number of pool entries matching the current file name. - - - - Prepares a SQL statement for execution. - - The source connection preparing the command. Can be null for any caller except LINQ - The SQL command text to prepare - The previous statement in a multi-statement command, or null if no previous statement exists - The timeout to wait before aborting the prepare - The remainder of the statement that was not processed. Each call to prepare parses the - SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned - here for a subsequent call to Prepare() until all the text has been processed. - Returns an initialized SQLiteStatement. - - - - Steps through a prepared statement. - - The SQLiteStatement to step through - True if a row was returned, False if not. - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA, - transparently attempt to rebuild the SQL statement and throw an error if that was not possible. - - The statement to reset - Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined function from the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Returns the current and/or highwater values for the specified database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Enables or disables extened result codes returned by SQLite - - true to enable extended result codes, false to disable. - - - - - Returns the numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Result code - - - - Returns the extended numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Extended result code - - - - Add a log message via the SQLite sqlite3_log interface. - - Error code to be logged with the message. - String to be logged. Unlike the SQLite sqlite3_log() - interface, this should be pre-formatted. Consider using the - String.Format() function. - - - - - Checks if the SQLite core library has been initialized in the current process. - - - Non-zero if the SQLite core library has been initialized in the current process, - zero otherwise. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy or negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Returns the error message for the specified SQLite return code using - the internal static lookup table. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns a string representing the active version of SQLite - - - - - Returns an integer representing the active version of SQLite - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of changes the last executing insert/update caused. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection - value, it is global to the process. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - This is not really a per-connection value, it is global to the process. - - - - - Returns non-zero if the underlying native connection handle is owned by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - This field is used to refer to memory allocated for the - SQLITE_DBCONFIG_MAINDBNAME value used with the native - "sqlite3_db_config" API. If allocated, the associated - memeory will be freed when the underlying connection is - closed. - - - - - The opaque pointer returned to us by the sqlite provider - - - - - The user-defined functions registered on this connection - - - - - This is the name of the native library file that contains the - "vtshim" extension [wrapper]. - - - - - This is the flag indicate whether the native library file that - contains the "vtshim" extension must be dynamically loaded by - this class prior to use. - - - - - This is the name of the native entry point for the "vtshim" - extension [wrapper]. - - - - - The modules created using this connection. - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - This method attempts to dispose of all the derived - object instances currently associated with the native database connection. - - - - - Returns the number of times the method has been - called. - - - - - This method determines whether or not a - with a return code of should - be thrown after making a call into the SQLite core library. - - - Non-zero if a to be thrown. This method - will only return non-zero if the method was called - one or more times during a call into the SQLite core library (e.g. when - the sqlite3_prepare*() or sqlite3_step() APIs are used). - - - - - Resets the value of the field. - - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound and removed. - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - Returns a standard SQLite result code. - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. This parameter has no - effect on non-Windows operating systems. - - Returns a standard SQLite result code. - - - - Determines if the associated native connection handle is open. - - - Non-zero if the associated native connection handle is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - This method attempts to determine if a database connection opened - with the specified should be - allowed into the connection pool. - - - The that were specified when the - connection was opened. - - - Non-zero if the connection should (eventually) be allowed into the - connection pool; otherwise, zero. - - - - - Has the sqlite3_errstr() core library API been checked for yet? - If so, is it present? - - - - - Returns the error message for the specified SQLite return code using - the sqlite3_errstr() function, falling back to the internal lookup - table if necessary. - - WARNING: Do not remove this method, it is used via reflection. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Has the sqlite3_stmt_readonly() core library API been checked for yet? - If so, is it present? - - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - This field is used to keep track of whether or not the - "SQLite_ForceLogPrepare" environment variable has been queried. If so, - it will only be non-zero if the environment variable was present. - - - - - Determines if all calls to prepare a SQL query will be logged, - regardless of the flags for the associated connection. - - - Non-zero to log all calls to prepare a SQL query. - - - - - Determines the file name of the native library containing the native - "vtshim" extension -AND- whether it should be dynamically loaded by - this class. - - - This output parameter will be set to non-zero if the returned native - library file name should be dynamically loaded prior to attempting - the creation of native disposable extension modules. - - - The file name of the native library containing the native "vtshim" - extension -OR- null if it cannot be determined. - - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Returns the current and/or highwater values for the specified - database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - Enables or disables extended result codes returned by SQLite - - - Gets the last SQLite error code - - - Gets the last SQLite extended error code - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Allows the setting of a logging callback invoked by SQLite when a - log event occurs. Only one callback may be set. If NULL is passed, - the logging callback is unregistered. - - The callback function to invoke. - Returns a result code - - - - Appends an error message and an appropriate line-ending to a - instance. This is useful because the .NET Compact Framework has a slightly different set - of supported methods for the class. - - - The instance to append to. - - - The message to append. It will be followed by an appropriate line-ending. - - - - - This method attempts to cause the SQLite native library to invalidate - its function pointers that refer to this instance. This is necessary - to prevent calls from native code into delegates that may have been - garbage collected. Normally, these types of issues can only arise for - connections that are added to the pool; howver, it is good practice to - unconditionally invalidate function pointers that may refer to objects - being disposed. - - - Non-zero to also invalidate global function pointers (i.e. those that - are not directly associated with this connection on the native side). - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - This method attempts to free the cached database name used with the - method. - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy, negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Helper function to retrieve a column of data from an active statement. - - The statement being step()'d through - The flags associated with the connection. - The column index to retrieve - The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information. - Returns the data in the column - - - - Returns non-zero if the underlying native connection handle is owned - by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8 - - A pointer to a UTF-16 string - The length (IN BYTES) of the string - A .NET string - - - - Represents a single SQL backup in SQLite. - - - - - The underlying SQLite object this backup is bound to. - - - - - The actual backup handle. - - - - - The destination database for the backup. - - - - - The destination database name for the backup. - - - - - The source database for the backup. - - - - - The source database name for the backup. - - - - - The last result from the StepBackup method of the SQLite3 class. - This is used to determine if the call to the FinishBackup method of - the SQLite3 class should throw an exception when it receives a non-Ok - return code from the core SQLite library. - - - - - Initializes the backup. - - The base SQLite object. - The backup handle. - The destination database for the backup. - The destination database name for the backup. - The source database for the backup. - The source database name for the backup. - - - - Disposes and finalizes the backup. - - - - - - - - - - Creates temporary tables on the connection so schema information can be queried. - - - The connection upon which to build the schema tables. - - - - - The extra behavioral flags that can be applied to a connection. - - - - - No extra flags. - - - - - Enable logging of all SQL statements to be prepared. - - - - - Enable logging of all bound parameter types and raw values. - - - - - Enable logging of all bound parameter strongly typed values. - - - - - Enable logging of all exceptions caught from user-provided - managed code called from native code via delegates. - - - - - Enable logging of backup API errors. - - - - - Skip adding the extension functions provided by the native - interop assembly. - - - - - When binding parameter values with the - type, use the interop method that accepts an - value. - - - - - When binding parameter values, always bind them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - When returning column values, always return them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - Prevent this object instance from - loading extensions. - - - - - Prevent this object instance from - creating virtual table modules. - - - - - Skip binding any functions provided by other managed assemblies when - opening the connection. - - - - - Skip setting the logging related properties of the - object instance that was passed to - the method. - - - - - Enable logging of all virtual table module errors seen by the - method. - - - - - Enable logging of certain virtual table module exceptions that cannot - be easily discovered via other means. - - - - - Enable tracing of potentially important [non-fatal] error conditions - that cannot be easily reported through other means. - - - - - When binding parameter values, always use the invariant culture when - converting their values from strings. - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings. - - - - - Disable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. These - per-connection mappings, when present, override the corresponding - global mappings. - - - - - Disable using global mappings between type names and - values. This may be useful in some very narrow - cases; however, if there are no per-connection type mappings, the - fallback defaults will be used for both type names and their - associated values. Therefore, use of this flag - is not recommended. - - - - - When the property is used, it - should return non-zero if there were ever any rows in the associated - result sets. - - - - - Enable "strict" transaction enlistment semantics. Setting this flag - will cause an exception to be thrown if an attempt is made to enlist - in a transaction with an unavailable or unsupported isolation level. - In the future, more extensive checks may be enabled by this flag as - well. - - - - - Enable mapping of unsupported transaction isolation levels to the - closest supported transaction isolation level. - - - - - When returning column values, attempt to detect the affinity of - textual values by checking if they fully conform to those of the - , - , - , - or types. - - - - - When returning column values, attempt to detect the type of - string values by checking if they fully conform to those of - the , - , - , - or types. - - - - - Skip querying runtime configuration settings for use by the - class, including the default - value and default database type name. - NOTE: If the - and/or - properties are not set explicitly nor set via their connection - string properties and repeated calls to determine these runtime - configuration settings are seen to be a problem, this flag - should be set. - - - - - When binding parameter values with the - type, take their into account as - well as that of the associated . - - - - - If an exception is caught when raising the - event, the transaction - should be rolled back. If this is not specified, the transaction - will continue the commit process instead. - - - - - If an exception is caught when raising the - event, the action should - should be denied. If this is not specified, the action will be - allowed instead. - - - - - If an exception is caught when raising the - event, the operation - should be interrupted. If this is not specified, the operation - will simply continue. - - - - - Attempt to unbind all functions provided by other managed assemblies - when closing the connection. - - - - - When returning column values as a , skip - verifying their affinity. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the parameter name. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the database type name - associated with the value. - - - - - When returning column values, skip verifying their affinity. - - - - - Allow transactions to be nested. The outermost transaction still - controls whether or not any changes are ultimately committed or - rolled back. All non-outermost transactions are implemented using - the SAVEPOINT construct. - - - - - When binding parameter values, always bind - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When returning column values, always return - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When binding parameter values, always use - the invariant culture when converting their values to strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable waiting for the enlistment to be reset prior to attempting - to create a new enlistment. This may be necessary due to the - semantics used by distributed transactions, which complete - asynchronously. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable strict conformance to the ADO.NET standard, e.g. use of - thrown exceptions to indicate common error conditions. - - - - - EXPERIMENTAL -- - When opening a connection, attempt to hide the password from the - connection string, etc. Given the memory architecture of the CLR, - (and P/Invoke) this is not 100% reliable and should not be relied - upon for security critical uses or applications. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted). - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings or from strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings - or from strings. - - - - - Enables use of all per-connection value handling callbacks. - - - - - Enables use of all applicable - properties as fallbacks for the database type name. - - - - - Enable all logging. - - - - - The default logging related flags for new connections. - - - - - The default extra flags for new connections. - - - - - The default extra flags for new connections with all logging enabled. - - - - - These are the supported status parameters for use with the native - SQLite library. - - - - - This parameter returns the number of lookaside memory slots - currently checked out. - - - - - This parameter returns the approximate number of bytes of - heap memory used by all pager caches associated with the - database connection. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED is always 0. - - - - - This parameter returns the approximate number of bytes of - heap memory used to store the schema for all databases - associated with the connection - main, temp, and any ATTACH-ed - databases. The full amount of memory used by the schemas is - reported, even if the schema memory is shared with other - database connections due to shared cache mode being enabled. - The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED - is always 0. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - all lookaside memory already being in use. Only the high-water - value is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that were - satisfied using lookaside memory. Only the high-water value - is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number of pager cache hits that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_HIT is always 0. - - - - - This parameter returns the number of pager cache misses that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_MISS is always 0. - - - - - This parameter returns the number of dirty cache entries that - have been written to disk. Specifically, the number of pages - written to the wal file in wal mode databases, or the number - of pages written to the database file in rollback mode - databases. Any pages written as part of transaction rollback - or database recovery operations are not included. If an IO or - other error occurs while writing a page to disk, the effect - on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is - undefined. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_WRITE is always 0. - - - - - This parameter returns zero for the current value if and only - if all foreign key constraints (deferred or immediate) have - been resolved. The highwater mark is always 0. - - - - - This parameter is similar to DBSTATUS_CACHE_USED, except that - if a pager cache is shared between two or more connections the - bytes of heap memory used by that pager cache is divided evenly - between the attached connections. In other words, if none of - the pager caches associated with the database connection are - shared, this request returns the same value as DBSTATUS_CACHE_USED. - Or, if one or more or the pager caches are shared, the value - returned by this call will be smaller than that returned by - DBSTATUS_CACHE_USED. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. - - - - - This parameter returns the number of dirty cache entries that have - been written to disk in the middle of a transaction due to the page - cache overflowing. Transactions are more efficient if they are - written to disk all at once. When pages spill mid-transaction, that - introduces additional overhead. This parameter can be used help - identify inefficiencies that can be resolved by increasing the cache - size. - - - - - These are the supported configuration verbs for use with the native - SQLite library. They are used with the - method. - - - - - This value represents an unknown (or invalid) option, do not use it. - - - - - This option is used to change the name of the "main" database - schema. The sole argument is a pointer to a constant UTF8 string - which will become the new schema name in place of "main". - - - - - This option is used to configure the lookaside memory allocator. - The value must be an array with three elements. The second element - must be an containing the size of each buffer - slot. The third element must be an containing - the number of slots. The first element must be an - that points to a native memory buffer of bytes equal to or greater - than the product of the second and third element values. - - - - - This option is used to enable or disable the enforcement of - foreign key constraints. - - - - - This option is used to enable or disable triggers. - - - - - This option is used to enable or disable the two-argument version - of the fts3_tokenizer() function which is part of the FTS3 full-text - search engine extension. - - - - - This option is used to enable or disable the loading of extensions. - - - - - This option is used to enable or disable the automatic checkpointing - when a WAL database is closed. - - - - - This option is used to enable or disable the query planner stability - guarantee (QPSG). - - - - - This option is used to enable or disable the extra EXPLAIN QUERY PLAN - output for trigger programs. - - - - - This option is used as part of the process to reset a database back - to an empty state. Because resetting a database is destructive and - irreversible, the process requires the use of this obscure flag and - multiple steps to help ensure that it does not happen by accident. - - - - - This option activates or deactivates the "defensive" flag for a - database connection. When the defensive flag is enabled, language - features that allow ordinary SQL to deliberately corrupt the database - file are disabled. The disabled features include but are not limited - to the following: - ]]> - ]]> - The PRAGMA writable_schema=ON statement. - ]]> - ]]> - The PRAGMA journal_mode=OFF statement. - ]]> - ]]> - Writes to the sqlite_dbpage virtual table. - ]]> - ]]> - Direct writes to shadow tables. - ]]> - ]]> - - - - - This option activates or deactivates the "writable_schema" flag. - - - - - This option activates or deactivates the legacy behavior of the ALTER - TABLE RENAME command such it behaves as it did prior to version 3.24.0 - (2018-06-04). - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DML statement only, that is DELETE, INSERT, - SELECT, and UPDATE statements. - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DDL statements, such as CREATE TABLE and CREATE - INDEX. - - - - - This option is used to enable or disable CREATE VIEW. - - - - - This option activates or deactivates the legacy file format flag. - - - - - This option tells SQLite to assume that database schemas (i.e. the - contents of the sqlite_master tables) are untainted by malicious - content. When the trusted schema option is disabled, SQLite takes - additional defensive steps to protect the application from harm - including: - ]]> - ]]> - Prohibit the use of SQL functions inside triggers, views, CHECK - constraints, DEFAULT clauses, expression indexes, partial indexes, - or generated columns unless those functions are tagged with - SQLITE_INNOCUOUS. - ]]> - ]]> - Prohibit the use of virtual tables inside of triggers or views - unless those virtual tables are tagged with SQLITE_VTAB_INNOCUOUS. - ]]> - This setting defaults to "on" for legacy compatibility, however - all applications are advised to turn it off if possible. This - setting can also be controlled using the PRAGMA trusted_schema - statement. - - - - - These constants are used with the sqlite3_trace_v2() API and the - callbacks registered by it. - - - - - These constants are used with the sqlite3_limit() API. - - - - - This value represents an unknown (or invalid) limit, do not use it. - - - - - The maximum size of any string or BLOB or table row, in bytes. - - - - - The maximum length of an SQL statement, in bytes. - - - - - The maximum number of columns in a table definition or in the - result set of a SELECT or the maximum number of columns in an - index or in an ORDER BY or GROUP BY clause. - - - - - The maximum depth of the parse tree on any expression. - - - - - The maximum number of terms in a compound SELECT statement. - - - - - The maximum number of instructions in a virtual machine program - used to implement an SQL statement. If sqlite3_prepare_v2() or - the equivalent tries to allocate space for more than this many - opcodes in a single prepared statement, an SQLITE_NOMEM error - is returned. - - - - - The maximum number of arguments on a function. - - - - - The maximum number of attached databases. - - - - - The maximum length of the pattern argument to the LIKE or GLOB - operators. - - - - - The maximum index number of any parameter in an SQL statement. - - - - - The maximum depth of recursion for triggers. - - - - - The maximum number of auxiliary worker threads that a single - prepared statement may start. - - - - - Represents a single SQL blob in SQLite. - - - - - The underlying SQLite object this blob is bound to. - - - - - The actual blob handle. - - - - - Initializes the blob. - - The base SQLite object. - The blob handle. - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID -OR- if the query - does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The instance with a result set - containing the desired blob column. - - - The index of the blob column. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID. - - - The connection to use when opening the blob object. - - - The name of the database containing the blob object. - - - The name of the table containing the blob object. - - - The name of the column containing the blob object. - - - The integer identifier for the row associated with the desired - blob object. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Throws an exception if the blob object does not appear to be open. - - - - - Throws an exception if an invalid read/write parameter is detected. - - - When reading, this array will be populated with the bytes read from - the underlying database blob. When writing, this array contains new - values for the specified portion of the underlying database blob. - - - The number of bytes to read or write. - - - The byte offset, relative to the start of the underlying database - blob, where the read or write operation will begin. - - - - - Retargets this object to an underlying database blob for a - different row; the database, table, and column remain exactly - the same. If this operation fails for any reason, this blob - object is automatically disposed. - - - The integer identifier for the new row. - - - - - Queries the total number of bytes for the underlying database blob. - - - The total number of bytes for the underlying database blob. - - - - - Reads data from the underlying database blob. - - - This array will be populated with the bytes read from the - underlying database blob. - - - The number of bytes to read. - - - The byte offset, relative to the start of the underlying - database blob, where the read operation will begin. - - - - - Writes data into the underlying database blob. - - - This array contains the new values for the specified portion of - the underlying database blob. - - - The number of bytes to write. - - - The byte offset, relative to the start of the underlying - database blob, where the write operation will begin. - - - - - Closes the blob, freeing the associated resources. - - - - - Disposes and finalizes the blob. - - - - - The destructor. - - - - - SQLite implementation of DbCommand. - - - - - The default connection string to be used when creating a temporary - connection to execute a command via the static - or - - methods. - - - - - The command text this command is based on - - - - - The connection the command is associated with - - - - - The version of the connection the command is associated with - - - - - Indicates whether or not a DataReader is active on the command. - - - - - The timeout for the command, kludged because SQLite doesn't support per-command timeout values - - - - - Designer support - - - - - Used by DbDataAdapter to determine updating behavior - - - - - The collection of parameters for the command - - - - - The SQL command text, broken into individual SQL statements as they are executed - - - - - Unprocessed SQL text that has not been executed - - - - - Transaction associated with this command - - - - - Constructs a new SQLiteCommand - - - Default constructor - - - - - Initializes the command with the given command text - - The SQL command text - - - - Initializes the command with the given SQL command text and attach the command to the specified - connection. - - The SQL command text - The connection to associate with the command - - - - Initializes the command and associates it with the specified connection. - - The connection to associate with the command - - - - Initializes a command with the given SQL, connection and transaction - - The SQL command text - The connection to associate with the command - The transaction the command should be associated with - - - - Disposes of the command and clears all member variables - - Whether or not the class is being explicitly or implicitly disposed - - - - This method attempts to query the flags associated with the database - connection in use. If the database connection is disposed, the default - flags will be returned. - - - The command containing the databse connection to query the flags from. - - - The connection flags value. - - - - - Clears and destroys all statements currently prepared - - - - - Builds an array of prepared statements for each complete SQL statement in the command text - - - - - Not implemented - - - - - Forwards to the local CreateParameter() function - - - - - - Create a new parameter - - - - - - Verifies that all SQL queries associated with the current command text - can be successfully compiled. A will be - raised if any errors occur. - - - - - This function ensures there are no active readers, that we have a valid connection, - that the connection is open, that all statements are prepared and all parameters are assigned - in preparation for allocating a data reader. - - - - - Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements - - The behavior the data reader should adopt - Returns a SQLiteDataReader object - - - - This method creates a new connection, executes the query using the given - execution type, closes the connection, and returns the results. If the - connection string is null, a temporary in-memory database connection will - be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method creates a new connection, executes the query using the given - execution type and command behavior, closes the connection unless a data - reader is created, and returns the results. If the connection string is - null, a temporary in-memory database connection will be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method executes a query using the given execution type and command - behavior and returns the results. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection used to create and execute the command. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - Overrides the default behavior to return a SQLiteDataReader specialization class - - The flags to be associated with the reader. - A SQLiteDataReader - - - - Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class - - A SQLiteDataReader - - - - Called by the SQLiteDataReader when the data reader is closed. - - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The number of rows inserted/updated affected by it. - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The flags to be associated with the reader. - The number of rows inserted/updated affected by it. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The first column of the first row of the first resultset from the query. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The flags to be associated with the reader. - The first column of the first row of the first resultset from the query. - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - Non-zero if the parameter bindings should be cleared as well. - - - If this is zero, a may be thrown for - any unsuccessful return codes from the native library; otherwise, a - will only be thrown if the connection - or its state is invalid. - - - - - Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. - - - - - Clones a command, including all its parameters - - A new SQLiteCommand with the same commandtext, connection and parameters - - - - The SQL command text associated with the command - - - - - The amount of time to wait for the connection to become available before erroring out - - - - - The type of the command. SQLite only supports CommandType.Text - - - - - The connection associated with this command - - - - - Forwards to the local Connection property - - - - - Returns the SQLiteParameterCollection for the given command - - - - - Forwards to the local Parameters property - - - - - The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the - command's underlying connection. - - - - - Forwards to the local Transaction property - - - - - Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. - - - - - Determines if the command is visible at design time. Defaults to True. - - - - - SQLite implementation of DbCommandBuilder. - - - - - Default constructor - - - - - Initializes the command builder and associates it with the specified data adapter. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema - - The parameter to use in applying custom behaviors to a row - The row to apply the parameter to - The type of statement - Whether the application of the parameter is part of a WHERE clause - - - - Returns a valid named parameter - - The name of the parameter - Error - - - - Returns a named parameter for the given ordinal - - The i of the parameter - Error - - - - Returns a placeholder character for the specified parameter i. - - The index of the parameter to provide a placeholder for - Returns a named parameter - - - - Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL - statements that may not have previously been generated. - - A data adapter to receive events on. - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - - Places brackets around an identifier - - The identifier to quote - The bracketed identifier - - - - Removes brackets around an identifier - - The quoted (bracketed) identifier - The undecorated identifier - - - - Override helper, which can help the base command builder choose the right keys for the given query - - - - - - - Gets/sets the DataAdapter for this CommandBuilder - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - This class represents a single value to be returned - from the class via - its , - , - , - , - , - , - , - , - , - , - , - , - , - , - , or - method. If the value of the - associated public field of this class is null upon returning from the - callback, the null value will only be used if the return type for the - method called is not a value type. - If the value to be returned from the - method is unsuitable (e.g. null with a value type), an exception will - be thrown. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method. - - - - - This class represents the parameters that are provided - to the methods, with - the exception of the column index (provided separately). - - - - - This class represents the parameters that are provided to - the method, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - This class represents the parameters that are provided - to the and - methods, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - This class represents the parameters and return values for the - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , and - methods. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs a new instance of this class. Depending on the method - being called, the and/or - parameters may be null. - - - The name of the method that was - responsible for invoking this callback. - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - This may be used by the callback to set the return value for the - called method. - - - - - The name of the method that was - responsible for invoking this callback. - - - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - - - This may be used by the callback to set the return value for the - called method. - - - - - This represents a method that will be called in response to a request to - bind a parameter to a command. If an exception is thrown, it will cause - the parameter binding operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The instance being bound to the command. - - - The database type name associated with this callback. - - - The ordinal of the parameter being bound to the command. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the parameter binding call should - be skipped (i.e. the parameter should not be bound at all). Great care - should be used when setting this to non-zero. - - - - - This represents a method that will be called in response to a request - to read a value from a data reader. If an exception is thrown, it will - cause the data reader operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The parameter and return type data for the column being read from the - data reader. - - - The database type name associated with this callback. - - - The zero based index of the column being read from the data reader. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - This class represents the custom data type handling callbacks - for a single type name. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - Creates an instance of the class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - The database type name that the callbacks contained in this class - will apply to. This value may not be null. - - - - - The custom paramater binding callback. This value may be null. - - - - - The custom data reader value callback. This value may be null. - - - - - The extra data to pass into the parameter binding callback. This - value may be null. - - - - - The extra data to pass into the data reader value callback. This - value may be null. - - - - - This class represents the mappings between database type names - and their associated custom data type handling callbacks. - - - - - Constructs an (empty) instance of this class. - - - - - Event data for connection event handlers. - - - - - The type of event being raised. - - - - - The associated with this event, if any. - - - - - The transaction associated with this event, if any. - - - - - The command associated with this event, if any. - - - - - The data reader associated with this event, if any. - - - - - The critical handle associated with this event, if any. - - - - - Command or message text associated with this event, if any. - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - The type of event being raised. - The base associated - with this event, if any. - The transaction associated with this event, if any. - The command associated with this event, if any. - The data reader associated with this event, if any. - The critical handle associated with this event, if any. - The command or message text, if any. - The extra data, if any. - - - - Raised when an event pertaining to a connection occurs. - - The connection involved. - Extra information about the event. - - - - SQLite implentation of DbConnection. - - - The property can contain the following parameter(s), delimited with a semi-colon: - - - Parameter - Values - Required - Default - - - Data Source - - This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7). - Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a - UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db" - would become "\\\\Network\Share\test.db"). - - Y - - - - Uri - - If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading - "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open - the database. - - N - null - - - FullUri - - If specified, this must be a URI in a format recognized by the SQLite core library (starting with - SQLite 3.7.7). It will be passed verbatim to the SQLite core library. - - N - null - - - Version - 3 - N - 3 - - - UseUTF16Encoding - - True - The UTF-16 encoding should be used. -
- False - The UTF-8 encoding should be used. -
- N - False -
- - DefaultDbType - - This is the default to use when one cannot be determined based on the - column metadata and the configured type mappings. - - N - null - - - DefaultTypeName - - This is the default type name to use when one cannot be determined based on the column metadata - and the configured type mappings. - - N - null - - - NoDefaultFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - NoSharedFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - VfsName - - The name of the VFS to use when opening the database connection. - If this is not specified, the default VFS will be used. - - N - null - - - ZipVfsVersion - - If non-null, this is the "version" of ZipVFS to use. This requires - the System.Data.SQLite interop assembly -AND- primary managed assembly - to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. The valid values are "v2" and "v3". Using - anyother value will cause an exception to be thrown. Please see the - ZipVFS documentation for more information on how to use this parameter. - - N - null - - - DateTimeFormat - - Ticks - Use the value of DateTime.Ticks.
- ISO8601 - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC - DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).
- JulianDay - The interval of time in days and fractions of a day since January 1, 4713 BC.
- UnixEpoch - The whole number of seconds since the Unix epoch (January 1, 1970).
- InvariantCulture - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
- CurrentCulture - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.
- N - ISO8601 -
- - DateTimeKind - - Unspecified - Not specified as either UTC or local time. -
- Utc - The time represented is UTC. -
- Local - The time represented is local time. -
- N - Unspecified -
- - DateTimeFormatString - - The exact DateTime format string to use for all formatting and parsing of all DateTime - values for this connection. - - N - null - - - BaseSchemaName - - Some base data classes in the framework (e.g. those that build SQL queries dynamically) - assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting - alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used - as a placeholder and removed prior to preparing any SQL statements that may contain it. - - N - sqlite_default_schema - - - BinaryGUID - - True - Store GUID columns in binary form -
- False - Store GUID columns as text -
- N - True -
- - Cache Size - - If the argument N is positive then the suggested cache size is set to N. - If the argument N is negative, then the number of cache pages is adjusted - to use approximately abs(N*4096) bytes of memory. Backwards compatibility - note: The behavior of cache_size with a negative N was different in SQLite - versions prior to 3.7.10. In version 3.7.9 and earlier, the number of - pages in the cache was set to the absolute value of N. - - N - -2000 - - - Synchronous - - Normal - Normal file flushing behavior -
- Full - Full flushing after all writes -
- Off - Underlying OS flushes I/O's -
- N - Full -
- - Page Size - {size in bytes} - N - 4096 - - - Password - - {password} - Using this parameter requires that the legacy CryptoAPI based - codec (or the SQLite Encryption Extension) be enabled at compile-time for - both the native interop assembly and the core managed assemblies; otherwise, - using this parameter may result in an exception being thrown when attempting - to open the connection. - - N - - - - HexPassword - - {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded - byte values without a leading "0x" prefix. Using this parameter requires - that the legacy CryptoAPI based codec (or the SQLite Encryption Extension) - be enabled at compile-time for both the native interop assembly and the - core managed assemblies; otherwise, using this parameter may result in an - exception being thrown when attempting to open the connection. - - N - - - - Enlist - - Y - Automatically enlist in distributed transactions -
- N - No automatic enlistment -
- N - Y -
- - Pooling - - True - Use connection pooling.
- False - Do not use connection pooling.

- WARNING: When using the default connection pool implementation, - setting this property to True should be avoided by applications that make - use of COM (either directly or indirectly) due to possible deadlocks that - can occur during the finalization of some COM objects. -
- N - False -
- - FailIfMissing - - True - Don't create the database if it does not exist, throw an error instead -
- False - Automatically create the database if it does not exist -
- N - False -
- - Max Page Count - {size in pages} - Limits the maximum number of pages (limits the size) of the database - N - 0 - - - Legacy Format - - True - Use the more compatible legacy 3.x database format -
- False - Use the newer 3.3x database format which compresses numbers more effectively -
- N - False -
- - Default Timeout - {time in seconds}
The default command timeout
- N - 30 -
- - BusyTimeout - {time in milliseconds}
Sets the busy timeout for the core library.
- N - 0 -
- - WaitTimeout - {time in milliseconds}
- EXPERIMENTAL -- The wait timeout to use with - method. This is only used when - waiting for the enlistment to be reset prior to enlisting in a transaction, - and then only when the appropriate connection flag is set.
- N - 30000 -
- - Journal Mode - - Delete - Delete the journal file after a commit. -
- Persist - Zero out and leave the journal file on disk after a - commit. -
- Off - Disable the rollback journal entirely. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Truncate - Truncate the journal file to zero-length instead of - deleting it. -
- Memory - Store the journal in volatile RAM. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Wal - Use a write-ahead log instead of a rollback journal. -
- N - Delete -
- - Read Only - - True - Open the database for read only access -
- False - Open the database for normal read/write access -
- N - False -
- - Max Pool Size - The maximum number of connections for the given connection string that can be in the connection pool - N - 100 - - - Default IsolationLevel - The default transaciton isolation level - N - Serializable - - - Foreign Keys - Enable foreign key constraints - N - False - - - Flags - Extra behavioral flags for the connection. See the enumeration for possible values. - N - Default - - - SetDefaults - - True - Apply the default connection settings to the opened database.
- False - Skip applying the default connection settings to the opened database. -
- N - True -
- - ToFullPath - - True - Attempt to expand the data source file name to a fully qualified path before opening. -
- False - Skip attempting to expand the data source file name to a fully qualified path before opening. -
- N - True -
- - PrepareRetries - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - N - 3 - - - ProgressOps - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as well. - - N - 0 - - - Recursive Triggers - - True - Enable the recursive trigger capability. - False - Disable the recursive trigger capability. - - N - False - -
-
-
- - - The "invalid value" for the enumeration used - by the property. This constant is shared - by this class and the SQLiteConnectionStringBuilder class. - - - - - The default "stub" (i.e. placeholder) base schema name to use when - returning column schema information. Used as the initial value of - the BaseSchemaName property. This should start with "sqlite_*" - because those names are reserved for use by SQLite (i.e. they cannot - be confused with the names of user objects). - - - - - The managed assembly containing this type. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - The extra connection flags to be used for all opened connections. - - - - - The instance (for this thread) that - had the most recent call to . - - - - - State of the current connection - - - - - The connection string - - - - - Nesting level of the transactions open on the connection - - - - - Transaction counter for the connection. Currently, this is only used - to build SAVEPOINT names. - - - - - If this flag is non-zero, the method will have - no effect; however, the method will continue to - behave as normal. - - - - - If set, then the connection is currently being disposed. - - - - - The default isolation level for new transactions - - - - - This object is used with lock statements to synchronize access to the - field, below. - - - - - Whether or not the connection is enlisted in a distrubuted transaction - - - - - The per-connection mappings between type names and - values. These mappings override the corresponding global mappings. - - - - - The per-connection mappings between type names and optional callbacks - for parameter binding and value reading. - - - - - The base SQLite object to interop with - - - - - The database filename minus path and extension - - - - - Temporary password storage, emptied after the database has been opened - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. - - - - - The extra behavioral flags for this connection, if any. See the - enumeration for a list of - possible values. - - - - - The cached values for all settings that have been fetched on behalf - of this connection. This cache may be cleared by calling the - method. - - - - - The default databse type for this connection. This value will only - be used if the - flag is set. - - - - - The default databse type name for this connection. This value will only - be used if the - flag is set. - - - - - The name of the VFS to be used when opening the database connection. - - - - - Default command timeout - - - - - The default busy timeout to use with the SQLite core library. This is - only used when opening a connection. - - - - - The default wait timeout to use with - method. This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the appropriate - connection flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when opening the database. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Constructs a new SQLiteConnection object - - - Default constructor - - - - - Initializes the connection with the specified connection string. - - The connection string to use. - - - - Initializes the connection with a pre-existing native connection handle. - This constructor overload is intended to be used only by the private - method. - - - The native connection handle to use. - - - The file name corresponding to the native connection handle. - - - Non-zero if this instance owns the native connection handle and - should dispose of it when it is no longer needed. - - - - - Initializes the connection with the specified connection string. - - - The connection string to use. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Clones the settings and connection string from an existing connection. If the existing connection is already open, this - function will open its own connection, enumerate any attached databases of the original connection, and automatically - attach to them. - - The connection to copy the settings from. - - - - Attempts to lookup the native handle associated with the connection. An exception will - be thrown if this cannot be accomplished. - - - The connection associated with the desired native handle. - - - The native handle associated with the connection or if it - cannot be determined. - - - - - Raises the event. - - - The connection associated with this event. If this parameter is not - null and the specified connection cannot raise events, then the - registered event handlers will not be invoked. - - - A that contains the event data. - - - - - Creates and returns a new managed database connection handle. This - method is intended to be used by implementations of the - interface only. In theory, it - could be used by other classes; however, that usage is not supported. - - - This must be a native database connection handle returned by the - SQLite core library and it must remain valid and open during the - entire duration of the calling method. - - - The new managed database connection handle or null if it cannot be - created. - - - - - Backs up the database, using the specified database connection as the - destination. - - The destination database connection. - The destination database name. - The source database name. - - The number of pages to copy at a time -OR- a negative value to copy all - pages. When a negative value is used, the - may never be invoked. - - - The method to invoke between each step of the backup process. This - parameter may be null (i.e. no callbacks will be performed). If the - callback returns false -OR- throws an exception, the backup is canceled. - - - The number of milliseconds to sleep after encountering a locking error - during the backup process. A value less than zero means that no sleep - should be performed. - - - - - Clears the per-connection cached settings. - - - The total number of per-connection settings cleared. - - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for this connection, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by . - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - Clears the per-connection type mappings. - - - The total number of per-connection type mappings cleared. - - - - - Returns the per-connection type mappings. - - - The per-connection type mappings -OR- null if they are unavailable. - - - - - Adds a per-connection type mapping, possibly replacing one or more - that already exist. - - - The case-insensitive database type name (e.g. "MYDATE"). The value - of this parameter cannot be null. Using an empty string value (or - a string value consisting entirely of whitespace) for this parameter - is not recommended. - - - The value that should be associated with the - specified type name. - - - Non-zero if this mapping should be considered to be the primary one - for the specified . - - - A negative value if nothing was done. Zero if no per-connection type - mappings were replaced (i.e. it was a pure add operation). More than - zero if some per-connection type mappings were replaced. - - - - - Clears the per-connection type callbacks. - - - The total number of per-connection type callbacks cleared. - - - - - Attempts to get the per-connection type callbacks for the specified - database type name. - - - The database type name. - - - Upon success, this parameter will contain the object holding the - callbacks for the database type name. Upon failure, this parameter - will be null. - - - Non-zero upon success; otherwise, zero. - - - - - Sets, resets, or clears the per-connection type callbacks for the - specified database type name. - - - The database type name. - - - The object holding the callbacks for the database type name. If - this parameter is null, any callbacks for the database type name - will be removed if they are present. - - - Non-zero if callbacks were set or removed; otherwise, zero. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - A object instance that helps implement the - function to be bound. For scalar functions, this corresponds to the - type. For aggregate functions, - this corresponds to the type. For - collation functions, this corresponds to the - type. - - - A object instance that helps implement the - function to be bound. For aggregate functions, this corresponds to the - type. For other callback types, it - is not used and must be null. - - - - - Attempts to unbind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be unbound. - - Non-zero if the function was unbound. - - - - This method unbinds all registered (known) functions -OR- all previously - bound user-defined functions from this connection. - - - Non-zero to unbind all registered (known) functions -OR- zero to unbind - all functions currently bound to the connection. - - - Non-zero if all the specified user-defined functions were unbound. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Attempts to escape the specified connection string property name or - value in a way that is compatible with the connection string parser. - - - The connection string property name or value to escape. - - - Non-zero if the equals sign is permitted in the string. If this is - zero and the string contains an equals sign, an exception will be - thrown. - - - The original string, with all special characters escaped. If the - original string contains equals signs, they will not be escaped. - Instead, they will be preserved verbatim. - - - - - Builds a connection string from a list of key/value pairs. - - - The list of key/value pairs corresponding to the parameters to be - specified within the connection string. - - - The connection string. Depending on how the connection string was - originally parsed, the returned connection string value may not be - usable in a subsequent call to the method. - - - - - Disposes and finalizes the connection, if applicable. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection - will also be opened. - - - - - - Creates a database file. This just creates a zero-byte file which SQLite - will turn into a database when the file is opened properly. - - The file to create - - - - Raises the state change event when the state of the connection changes - - The new connection state. If this is different - from the previous state, the event is - raised. - The event data created for the raised event, if - it was actually raised. - - - - Determines and returns the fallback default isolation level when one cannot be - obtained from an existing connection instance. - - - The fallback default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - Determines and returns the default isolation level for this connection instance. - - - The default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - This parameter is ignored. - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already active on the connection. - - Supported isolation levels are Serializable, ReadCommitted and Unspecified. - - Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the - connection string, Serializable is used. - Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads - may begin a transaction. Other threads may read from the database, but not write. - With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start - a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread - has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached. - - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already - active on the connection. - - Returns the new transaction object. - - - - Forwards to the local function - - Supported isolation levels are Unspecified, Serializable, and ReadCommitted - - - - - This method is not implemented; however, the - event will still be raised. - - - - - - When the database connection is closed, all commands linked to this connection are automatically reset. - - - - - Clears the connection pool associated with the connection. Any other active connections using the same database file - will be discarded instead of returned to the pool when they are closed. - - - - - - Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. - - - - - Create a new and associate it with this connection. - - Returns a new command object already assigned to this connection. - - - - Forwards to the local function. - - - - - - Attempts to create a new object instance - using this connection and the specified database name. - - - The name of the database for the newly created session. - - - The newly created session -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object - instance using this connection. - - - The newly created change group -OR- null if it cannot be created. - - - - - Determines if the legacy connection string parser should be used. - - - The connection that will be using the parsed connection string. - - - Non-zero if the legacy connection string parser should be used. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string using the built-in (i.e. framework provided) - connection string parser class and returns the key/value pairs. An - exception may be thrown if the connection string is invalid or cannot be - parsed. When compiled for the .NET Compact Framework, the custom - connection string parser is always used instead because the framework - provided one is unavailable there. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to throw an exception if any connection string values are not of - the type. This is not applicable when running on - the .NET Compact Framework. - - The list of key/value pairs. - - - - Manual distributed transaction enlistment support - - The distributed transaction to enlist in - - - - EXPERIMENTAL -- - Waits for the enlistment associated with this connection to be reset. - This method always throws when - running on the .NET Compact Framework. - - - The approximate maximum number of milliseconds to wait before timing - out the wait operation. - - - The return value to use if the connection has been disposed; if this - value is null, will be raised - if the connection has been disposed. - - - Non-zero if the enlistment assciated with this connection was reset; - otherwise, zero. It should be noted that this method returning a - non-zero value does not necessarily guarantee that the connection - can enlist in a new transaction (i.e. due to potentical race with - other threads); therefore, callers should generally use try/catch - when calling the method. - - - - - Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value - - The list to look in - The key to find - The default value to return if the key is not found - The value corresponding to the specified key, or the default value if not found. - - - - Attempts to convert the string value to an enumerated value of the specified type. - - The enumerated type to convert the string value to. - The string value to be converted. - Non-zero to make the conversion case-insensitive. - The enumerated value upon success or null upon error. - - - - Attempts to convert an input string into a byte value. - - - The string value to be converted. - - - The number styles to use for the conversion. - - - Upon sucess, this will contain the parsed byte value. - Upon failure, the value of this parameter is undefined. - - - Non-zero upon success; zero on failure. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - - - Enables or disables extension loading. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Creates a disposable module containing the implementation of a virtual - table. - - - The module object to be used when creating the disposable module. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - Creates and returns a string containing the hexadecimal encoded byte - values from the input array. - - - The input array of bytes. - - - The resulting string or null upon failure. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - Upon failure, this will contain an appropriate error message. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - This method figures out what the default connection pool setting should - be based on the connection flags. When present, the "Pooling" connection - string property value always overrides the value returned by this method. - - - Non-zero if the connection pool should be enabled by default; otherwise, - zero. - - - - - Determines the transaction isolation level that should be used by - the caller, primarily based upon the one specified by the caller. - If mapping of transaction isolation levels is enabled, the returned - transaction isolation level may be significantly different than the - originally specified one. - - - The originally specified transaction isolation level. - - - The transaction isolation level that should be used. - - - - - Opens the connection using the parameters found in the . - - - - - Opens the connection using the parameters found in the and then returns it. - - The current connection object. - - - - This method causes any pending database operation to abort and return at - its earliest opportunity. This routine is typically called in response - to a user action such as pressing "Cancel" or Ctrl-C where the user wants - a long query operation to halt immediately. It is safe to call this - routine from any thread. However, it is not safe to call this routine - with a database connection that is closed or might close before this method - returns. - - - - - Checks if this connection to the specified database should be considered - read-only. An exception will be thrown if the database name specified - via cannot be found. - - - The name of a database associated with this connection -OR- null for the - main database. - - - Non-zero if this connection to the specified database should be considered - read-only. - - - - - Returns various global memory statistics for the SQLite core library via - a dictionary of key/value pairs. Currently, only the "MemoryUsed" and - "MemoryHighwater" keys are returned and they have values that correspond - to the values that could be obtained via the - and connection properties. - - - This dictionary will be populated with the global memory statistics. It - will be created if necessary. - - - - - Attempts to free as much heap memory as possible for this database connection. - - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for the last connection that used - the method, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by using the cached - setting names and values for the last connection that used the - method, when available. - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - Passes a shutdown request to the SQLite core library. Does not throw - an exception if the shutdown request fails. - - - A standard SQLite return code (i.e. zero for success and non-zero for - failure). - - - - - Passes a shutdown request to the SQLite core library. Throws an - exception if the shutdown request fails and the no-throw parameter - is non-zero. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. - - - When non-zero, throw an exception if the shutdown request fails. - - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Change the password (or assign a password) to an open database. - - - No readers or writers may be active for this process. The database must already be open - and if it already was password protected, the existing password must already have been supplied. - - The new password to assign to the database - - - - Change the password (or assign a password) to an open database. - - - No readers or writers may be active for this process. The database must already be open - and if it already was password protected, the existing password must already have been supplied. - - The new password to assign to the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - - - - Queries or modifies the number of retries or the retry interval (in milliseconds) for - certain I/O operations that may fail due to anti-virus software. - - The number of times to retry the I/O operation. A negative value - will cause the current count to be queried and replace that negative value. - The number of milliseconds to wait before retrying the I/O - operation. This number is multiplied by the number of retry attempts so far to come - up with the final number of milliseconds to wait. A negative value will cause the - current interval to be queried and replace that negative value. - Zero for success, non-zero for error. - - - - Sets the chunk size for the primary file associated with this database - connection. - - - The new chunk size for the main database, in bytes. - - - Zero for success, non-zero for error. - - - - - Removes one set of surrounding single -OR- double quotes from the string - value and returns the resulting string value. If the string is null, empty, - or contains quotes that are not balanced, nothing is done and the original - string value will be returned. - - The string value to process. - - The string value, modified to remove one set of surrounding single -OR- - double quotes, if applicable. - - - - - Determines the directory to be used when dealing with the "|DataDirectory|" - macro in a database file name. - - - The directory to use in place of the "|DataDirectory|" macro -OR- null if it - cannot be determined. - - - - - Expand the filename of the data source, resolving the |DataDirectory| - macro as appropriate. - - The database filename to expand - - Non-zero if the returned file name should be converted to a full path - (except when using the .NET Compact Framework). - - The expanded path and filename of the filename - - - - The following commands are used to extract schema information out of the database. Valid schema types are: - - - MetaDataCollections - - - DataSourceInformation - - - Catalogs - - - Columns - - - ForeignKeys - - - Indexes - - - IndexColumns - - - Tables - - - Views - - - ViewColumns - - - - - Returns the MetaDataCollections schema - - A DataTable of the MetaDataCollections schema - - - - Returns schema information of the specified collection - - The schema collection to retrieve - A DataTable of the specified collection - - - - Retrieves schema information using the specified constraint(s) for the specified collection - - The collection to retrieve. - - The restrictions to impose. Typically, this may include: - - - restrictionValues element index - usage - - - 0 - The database (or catalog) name, if applicable. - - - 1 - The schema name. This is not used by this provider. - - - 2 - The table name, if applicable. - - - 3 - - Depends on . - When "IndexColumns", it is the index name; otherwise, it is the column name. - - - - 4 - - Depends on . - When "IndexColumns", it is the column name; otherwise, it is not used. - - - - - A DataTable of the specified collection - - - - Builds a MetaDataCollections schema datatable - - DataTable - - - - Builds a DataSourceInformation datatable - - DataTable - - - - Build a Columns schema - - The catalog (attached database) to query, can be null - The table to retrieve schema information for, can be null - The column to retrieve schema information for, can be null - DataTable - - - - Returns index information for the given database and catalog - - The catalog (attached database) to query, can be null - The name of the index to retrieve information for, can be null - The table to retrieve index information for, can be null - DataTable - - - - Retrieves table schema information for the database and catalog - - The catalog (attached database) to retrieve tables on - The table to retrieve, can be null - The table type, can be null - DataTable - - - - Retrieves view schema information for the database - - The catalog (attached database) to retrieve views on - The view name, can be null - DataTable - - - - Retrieves catalog (attached databases) schema information for the database - - The catalog to retrieve, can be null - DataTable - - - - Returns the base column information for indexes in a database - - The catalog to retrieve indexes for (can be null) - The table to restrict index information by (can be null) - The index to restrict index information by (can be null) - The source column to restrict index information by (can be null) - A DataTable containing the results - - - - Returns detailed column information for a specified view - - The catalog to retrieve columns for (can be null) - The view to restrict column information by (can be null) - The source column to restrict column information by (can be null) - A DataTable containing the results - - - - Retrieves foreign key information from the specified set of filters - - An optional catalog to restrict results on - An optional table to restrict results on - An optional foreign key name to restrict results on - A DataTable with the results of the query - - - - Static variable to store the connection event handlers to call. - - - - - This event is raised whenever the database is opened or closed. - - - - - This event is raised when events related to the lifecycle of a - SQLiteConnection object occur. - - - - - This property is used to obtain or set the custom connection pool - implementation to use, if any. Setting this property to null will - cause the default connection pool implementation to be used. - - - - - Returns the number of pool entries for the file name associated with this connection. - - - - - The connection string containing the parameters for the connection - - - For the complete list of supported connection string properties, - please see . - - - - - Returns the data source file name without extension or path. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - - - Returns the string "main". - - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - This can also be set in the ConnectionString with "Default Timeout" - - - - - Gets/sets the default busy timeout to use with the SQLite core library. This is only used when - opening a connection. - - - - - EXPERIMENTAL -- - The wait timeout to use with method. - This is only used when waiting for the enlistment to be reset prior to - enlisting in a transaction, and then only when the appropriate connection - flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when the underlying native progress - callback needs to be changed. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Gets/sets the extra behavioral flags for this connection. See the - enumeration for a list of - possible values. - - - - - Gets/sets the default database type for this connection. This value - will only be used when not null. - - - - - Gets/sets the default database type name for this connection. This - value will only be used when not null. - - - - - Gets/sets the VFS name for this connection. This value will only be - used when opening the database. - - - - - Returns non-zero if the underlying native connection handle is - owned by this instance. - - - - - Returns the version of the underlying SQLite database engine - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on - this connection. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - - - - - Returns a string containing the define constants (i.e. compile-time - options) used to compile the core managed assembly, delimited with - spaces. - - - - - Returns the version of the underlying SQLite core library. - - - - - This method returns the string whose value is the same as the - SQLITE_SOURCE_ID C preprocessor macro used when compiling the - SQLite core library. - - - - - Returns a string containing the compile-time options used to - compile the SQLite core native library, delimited with spaces. - - - - - This method returns the version of the interop SQLite assembly - used. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the interop - assembly. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - Returns a string containing the compile-time options used to - compile the SQLite interop assembly, delimited with spaces. - - - - - This method returns the version of the managed components used - to interact with the SQLite core library. If the necessary - information cannot be obtained for any reason, a null value may - be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the managed - components currently executing. If the necessary information - cannot be obtained for any reason, a null value may be returned. - - - - - The default connection flags to be used for all opened connections - when they are not present in the connection string. - - - - - The extra connection flags to be used for all opened connections. - - - - - Returns the state of the connection. - - - - - This event is raised periodically during long running queries. Changing - the value of the property will - determine if the operation in progress will continue or be interrupted. - For the entire duration of the event, the associated connection and - statement objects must not be modified, either directly or indirectly, by - the called code. - - - - - This event is raised whenever SQLite encounters an action covered by the - authorizer during query preparation. Changing the value of the - property will determine if - the specific action will be allowed, ignored, or denied. For the entire - duration of the event, the associated connection and statement objects - must not be modified, either directly or indirectly, by the called code. - - - - - This event is raised whenever SQLite makes an update/delete/insert into the database on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is committing a transaction. - Return non-zero to trigger a rollback. - - - - - This event is raised whenever SQLite statement first begins executing on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is rolling back a transaction. - - - - - Returns the instance. - - - - - The I/O file cache flushing behavior for the connection - - - - - Normal file flushing at critical sections of the code - - - - - Full file flushing after every write operation - - - - - Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing - - - - - Raised each time the number of virtual machine instructions is - approximately equal to the value of the - property. - - The connection performing the operation. - A that contains the - event data. - - - - Raised when authorization is required to perform an action contained - within a SQL query. - - The connection performing the action. - A that contains the - event data. - - - - Raised when a transaction is about to be committed. To roll back a transaction, set the - rollbackTrans boolean value to true. - - The connection committing the transaction - Event arguments on the transaction - - - - Raised when data is inserted, updated and deleted on a given connection - - The connection committing the transaction - The event parameters which triggered the event - - - - Raised when a statement first begins executing on a given connection - - The connection executing the statement - Event arguments of the trace - - - - Raised between each backup step. - - - The source database connection. - - - The source database name. - - - The destination database connection. - - - The destination database name. - - - The number of pages copied with each step. - - - The number of pages remaining to be copied. - - - The total number of pages in the source database. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True to continue with the backup process or false to halt the backup - process, rolling back any changes that have been made so far. - - - - - The event data associated with progress reporting events. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The return code for the current call into the progress callback. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The progress return code. - - - - - The data associated with a call into the authorizer. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The action code responsible for the current call into the authorizer. - - - - - The first string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The second string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The database name for the current call into the authorizer, if - applicable. - - - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - - - The return code for the current call into the authorizer. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The authorizer action code. - - - The first authorizer argument. - - - The second authorizer argument. - - - The database name, if applicable. - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - The authorizer return code. - - - - - Whenever an update event is triggered on a connection, this enum will indicate - exactly what type of operation is being performed. - - - - - A row is being deleted from the given database and table - - - - - A row is being inserted into the table. - - - - - A row is being updated in the table. - - - - - Passed during an Update callback, these event arguments detail the type of update operation being performed - on the given connection. - - - - - The name of the database being updated (usually "main" but can be any attached or temporary database) - - - - - The name of the table being updated - - - - - The type of update being performed (insert/update/delete) - - - - - The RowId affected by this update. - - - - - Event arguments raised when a transaction is being committed - - - - - Set to true to abort the transaction and trigger a rollback - - - - - Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text - - - - - SQL statement text as the statement first begins executing - - - - - This interface represents a custom connection pool implementation - usable by System.Data.SQLite. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This default method implementations in this class should not be used by - applications that make use of COM (either directly or indirectly) due - to possible deadlocks that can occur during finalization of some COM - objects. - - - - - This field is used to synchronize access to the private static data - in this class. - - - - - When this field is non-null, it will be used to provide the - implementation of all the connection pool methods; otherwise, - the default method implementations will be used. - - - - - The dictionary of connection pools, based on the normalized file - name of the SQLite database. - - - - - The default version number new pools will get. - - - - - The number of connections successfully opened from any pool. - This value is incremented by the Remove method. - - - - - The number of connections successfully closed from any pool. - This value is incremented by the Add method. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This method is used to obtain a reference to the custom connection - pool implementation currently in use, if any. - - - The custom connection pool implementation or null if the default - connection pool implementation should be used. - - - - - This method is used to set the reference to the custom connection - pool implementation to use, if any. - - - The custom connection pool implementation to use or null if the - default connection pool implementation should be used. - - - - - We do not have to thread-lock anything in this function, because it - is only called by other functions above which already take the lock. - - - The pool queue to resize. - - - If a function intends to add to the pool, this is true, which - forces the resize to take one more than it needs from the pool. - - - - - Keeps track of connections made on a specified file. The PoolVersion - dictates whether old objects get returned to the pool or discarded - when no longer in use. - - - - - The queue of weak references to the actual database connection - handles. - - - - - This pool version associated with the database connection - handles in this pool queue. - - - - - The maximum size of this pool queue. - - - - - Constructs a connection pool queue using the specified version - and maximum size. Normally, all the database connection - handles in this pool are associated with a single database file - name. - - - The initial pool version for this connection pool queue. - - - The initial maximum size for this connection pool queue. - - - - - SQLite implementation of DbConnectionStringBuilder. - - - - - Properties of this class - - - - - Constructs a new instance of the class - - - Default constructor - - - - - Constructs a new instance of the class using the specified connection string. - - The connection string to parse - - - - Private initializer, which assigns the connection string and resets the builder - - The connection string to assign - - - - Helper function for retrieving values from the connectionstring - - The keyword to retrieve settings for - The resulting parameter value - Returns true if the value was found and returned - - - - Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties() - - The hashtable to fill with property descriptors - - - - Gets/Sets the default version of the SQLite engine to instantiate. Currently the only valid value is 3, indicating version 3 of the sqlite library. - - - - - Gets/Sets the synchronization mode (file flushing) of the connection string. Default is "Normal". - - - - - Gets/Sets the encoding for the connection string. The default is "False" which indicates UTF-8 encoding. - - - - - Gets/Sets whether or not to use connection pooling. The default is "False" - - - - - Gets/Sets whethor not to store GUID's in binary format. The default is True - which saves space in the database. - - - - - Gets/Sets the filename to open on the connection string. - - - - - An alternate to the data source property - - - - - An alternate to the data source property that uses the SQLite URI syntax. - - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - - - - - Gets/sets the busy timeout to use with the SQLite core library. - - - - - EXPERIMENTAL -- - The wait timeout to use with - method. - This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the - appropriate connection flag is set. - - - - - Gets/sets the maximum number of retries when preparing SQL to be executed. - This normally only applies to preparation errors resulting from the database - schema being changed. - - - - - Gets/sets the approximate number of virtual machine instructions between - progress events. In order for progress events to actually fire, the event - handler must be added to the event - as well. - - - - - Determines whether or not the connection will automatically participate - in the current distributed transaction (if one exists) - - - - - If set to true, will throw an exception if the database specified in the connection - string does not exist. If false, the database will be created automatically. - - - - - If enabled, uses the legacy 3.xx format for maximum compatibility, but results in larger - database sizes. - - - - - When enabled, the database will be opened for read-only access and writing will be disabled. - - - - - Gets/sets the database encryption password - - - - - Gets/sets the database encryption hexadecimal password - - - - - Gets/Sets the page size for the connection. - - - - - Gets/Sets the maximum number of pages the database may hold - - - - - Gets/Sets the cache size for the connection. - - - - - Gets/Sets the DateTime format for the connection. - - - - - Gets/Sets the DateTime kind for the connection. - - - - - Gets/sets the DateTime format string used for formatting - and parsing purposes. - - - - - Gets/Sets the placeholder base schema name used for - .NET Framework compatibility purposes. - - - - - Determines how SQLite handles the transaction journal file. - - - - - Sets the default isolation level for transactions on the connection. - - - - - Gets/sets the default database type for the connection. - - - - - Gets/sets the default type name for the connection. - - - - - Gets/sets the VFS name for the connection. - - - - - If enabled, use foreign key constraints - - - - - Enable or disable the recursive trigger capability. - - - - - If non-null, this is the version of ZipVFS to use. This requires the - System.Data.SQLite interop assembly -AND- primary managed assembly to - be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. - - - - - Gets/Sets the extra behavioral flags. - - - - - If enabled, apply the default connection settings to opened databases. - - - - - If enabled, attempt to resolve the provided data source file name to a - full path before opening. - - - - - If enabled, skip using the configured default connection flags. - - - - - If enabled, skip using the configured shared connection flags. - - - - - SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite - understands. The DateTime extension to the spec is for internal use only. - - - - - Not used - - - - - All integers in SQLite default to Int64 - - - - - All floating point numbers in SQLite default to double - - - - - The default data type of SQLite is text - - - - - Typically blob types are only seen when returned from a function - - - - - Null types can be returned from functions - - - - - Used internally by this provider - - - - - Used internally by this provider - - - - - These are the event types associated with the - - delegate (and its corresponding event) and the - class. - - - - - Not used. - - - - - Not used. - - - - - The connection is being opened. - - - - - The connection string has been parsed. - - - - - The connection was opened. - - - - - The method was called on the - connection. - - - - - A transaction was created using the connection. - - - - - The connection was enlisted into a transaction. - - - - - A command was created using the connection. - - - - - A data reader was created using the connection. - - - - - An instance of a derived class has - been created to wrap a native resource. - - - - - The connection is being closed. - - - - - The connection was closed. - - - - - A command is being disposed. - - - - - A data reader is being disposed. - - - - - A data reader is being closed. - - - - - A native resource was opened (i.e. obtained) from the pool. - - - - - A native resource was closed (i.e. released) to the pool. - - - - - This implementation of SQLite for ADO.NET can process date/time fields in - databases in one of six formats. - - - ISO8601 format is more compatible, readable, fully-processable, but less - accurate as it does not provide time down to fractions of a second. - JulianDay is the numeric format the SQLite uses internally and is arguably - the most compatible with 3rd party tools. It is not readable as text - without post-processing. Ticks less compatible with 3rd party tools that - query the database, and renders the DateTime field unreadable as text - without post-processing. UnixEpoch is more compatible with Unix systems. - InvariantCulture allows the configured format for the invariant culture - format to be used and is human readable. CurrentCulture allows the - configured format for the current culture to be used and is also human - readable. - - The preferred order of choosing a DateTime format is JulianDay, ISO8601, - and then Ticks. Ticks is mainly present for legacy code support. - - - - - Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ. - - - - - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and - "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values). - - - - - The interval of time in days and fractions of a day since January 1, 4713 BC. - - - - - The whole number of seconds since the Unix epoch (January 1, 1970). - - - - - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime. - - - - - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. - - - - - The default format for this provider. - - - - - This enum determines how SQLite treats its journal file. - - - By default SQLite will create and delete the journal file when needed during a transaction. - However, for some computers running certain filesystem monitoring tools, the rapid - creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite. - - If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file" - when starting a transaction. If this is happening, you may want to change the default journal mode to Persist. - - - - - The default mode, this causes SQLite to use the existing journaling mode for the database. - - - - - SQLite will create and destroy the journal file as-needed. - - - - - When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased, - and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed. - - - - - This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database - corruption in this mode! - - - - - SQLite will truncate the journal file to zero-length instead of deleting it. - - - - - SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. - If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the - database file will very likely go corrupt. - - - - - SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; - after being set it stays in effect across multiple database connections and after closing and reopening the database. A database - in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later. - - - - - Possible values for the "synchronous" database setting. This setting determines - how often the database engine calls the xSync method of the VFS. - - - - - Use the default "synchronous" database setting. Currently, this should be - the same as using the FULL mode. - - - - - The database engine continues without syncing as soon as it has handed - data off to the operating system. If the application running SQLite - crashes, the data will be safe, but the database might become corrupted - if the operating system crashes or the computer loses power before that - data has been written to the disk surface. - - - - - The database engine will still sync at the most critical moments, but - less often than in FULL mode. There is a very small (though non-zero) - chance that a power failure at just the wrong time could corrupt the - database in NORMAL mode. - - - - - The database engine will use the xSync method of the VFS to ensure that - all content is safely written to the disk surface prior to continuing. - This ensures that an operating system crash or power failure will not - corrupt the database. FULL synchronous is very safe, but it is also - slower. - - - - - The requested command execution type. This controls which method of the - object will be called. - - - - - Do nothing. No method will be called. - - - - - The command is not expected to return a result -OR- the result is not - needed. The or - method - will be called. - - - - - The command is expected to return a scalar result -OR- the result should - be limited to a scalar result. The - or method will - be called. - - - - - The command is expected to return result. - The or - method will - be called. - - - - - Use the default command execution type. Using this value is the same - as using the value. - - - - - The action code responsible for the current call into the authorizer. - - - - - No action is being performed. This value should not be used from - external code. - - - - - No longer used. - - - - - An index will be created. The action-specific arguments are the - index name and the table name. - - - - - - A table will be created. The action-specific arguments are the - table name and a null value. - - - - - A temporary index will be created. The action-specific arguments - are the index name and the table name. - - - - - A temporary table will be created. The action-specific arguments - are the table name and a null value. - - - - - A temporary trigger will be created. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be created. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be created. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be created. The action-specific arguments are the view - name and a null value. - - - - - A DELETE statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - An index will be dropped. The action-specific arguments are the - index name and the table name. - - - - - A table will be dropped. The action-specific arguments are the tables - name and a null value. - - - - - A temporary index will be dropped. The action-specific arguments are - the index name and the table name. - - - - - A temporary table will be dropped. The action-specific arguments are - the table name and a null value. - - - - - A temporary trigger will be dropped. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be dropped. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be dropped. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be dropped. The action-specific arguments are the view - name and a null value. - - - - - An INSERT statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - A PRAGMA statement will be executed. The action-specific arguments - are the name of the PRAGMA and the new value or a null value. - - - - - A table column will be read. The action-specific arguments are the - table name and the column name. - - - - - A SELECT statement will be executed. The action-specific arguments - are both null values. - - - - - A transaction will be started, committed, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - COMMIT, or ROLLBACK) and a null value. - - - - - An UPDATE statement will be executed. The action-specific arguments - are the table name and the column name. - - - - - A database will be attached to the connection. The action-specific - arguments are the database file name and a null value. - - - - - A database will be detached from the connection. The action-specific - arguments are the database name and a null value. - - - - - The schema of a table will be altered. The action-specific arguments - are the database name and the table name. - - - - - An index will be deleted and then recreated. The action-specific - arguments are the index name and a null value. - - - - - A table will be analyzed to gathers statistics about it. The - action-specific arguments are the table name and a null value. - - - - - A virtual table will be created. The action-specific arguments are - the table name and the module name. - - - - - A virtual table will be dropped. The action-specific arguments are - the table name and the module name. - - - - - A SQL function will be called. The action-specific arguments are a - null value and the function name. - - - - - A savepoint will be created, released, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - RELEASE, or ROLLBACK) and the savepoint name. - - - - - A recursive query will be executed. The action-specific arguments - are two null values. - - - - - The possible return codes for the progress callback. - - - - - The operation should continue. - - - - - The operation should be interrupted. - - - - - The return code for the current call into the authorizer. - - - - - The action will be allowed. - - - - - The overall action will be disallowed and an error message will be - returned from the query preparation method. - - - - - The specific action will be disallowed; however, the overall action - will continue. The exact effects of this return code vary depending - on the specific action, please refer to the SQLite core library - documentation for futher details. - - - - - Class used internally to determine the datatype of a column in a resultset - - - - - The DbType of the column, or DbType.Object if it cannot be determined - - - - - The affinity of a column, used for expressions or when Type is DbType.Object - - - - - Constructs a default instance of this type. - - - - - Constructs an instance of this type with the specified field values. - - - The type affinity to use for the new instance. - - - The database type to use for the new instance. - - - - - SQLite implementation of DbDataAdapter. - - - - - This class is just a shell around the DbDataAdapter. Nothing from - DbDataAdapter is overridden here, just a few constructors are defined. - - - Default constructor. - - - - - Constructs a data adapter using the specified select command. - - - The select command to associate with the adapter. - - - - - Constructs a data adapter with the supplied select command text and - associated with the specified connection. - - - The select command text to associate with the data adapter. - - - The connection to associate with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Raised by the underlying DbDataAdapter when a row is being updated - - The event's specifics - - - - Raised by DbDataAdapter after a row is updated - - The event's specifics - - - - Row updating event handler - - - - - Row updated event handler - - - - - Gets/sets the select command for this DataAdapter - - - - - Gets/sets the insert command for this DataAdapter - - - - - Gets/sets the update command for this DataAdapter - - - - - Gets/sets the delete command for this DataAdapter - - - - - SQLite implementation of DbDataReader. - - - - - Underlying command this reader is attached to - - - - - The flags pertaining to the associated connection (via the command). - - - - - Index of the current statement in the command being processed - - - - - Current statement being Read() - - - - - State of the current statement being processed. - -1 = First Step() executed, so the first Read() will be ignored - 0 = Actively reading - 1 = Finished reading - 2 = Non-row-returning statement, no records - - - - - Number of records affected by the insert/update statements executed on the command - - - - - Count of fields (columns) in the row-returning statement currently being processed - - - - - The number of calls to Step() that have returned true (i.e. the number of rows that - have been read in the current result set). - - - - - Maps the field (column) names to their corresponding indexes within the results. - - - - - Datatypes of active fields (columns) in the current statement, used for type-restricting data - - - - - The behavior of the datareader - - - - - If set, then dispose of the command object when the reader is finished - - - - - If set, then raise an exception when the object is accessed after being disposed. - - - - - An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified - - - - - Matches the version of the connection. - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. Matches the base schema name used by the - associated connection. - - - - - Internal constructor, initializes the datareader and sets up to begin executing statements - - The SQLiteCommand this data reader is for - The expected behavior of the data reader - - - - Dispose of all resources used by this datareader. - - - - - - Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified. - - - - - Throw an error if the datareader is closed - - - - - Throw an error if a row is not loaded - - - - - Enumerator support - - Returns a DbEnumerator object. - - - - Forces the connection flags cached by this data reader to be refreshed - from the underlying connection. - - - - - This method is used to make sure the result set is open and a row is currently available. - - - - - SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table - and the affinity of returned types are all we have to go on to type-restrict data in the reader. - - This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In - the case of columns that are not backed into a table definition, we attempt to match up the affinity of a column (int, double, string or blob) - to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do. - - - This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity. - - The index of the column to type-check - The type we want to get out of the column - - - - Invokes the data reader value callback configured for the database - type name associated with the specified column. If no data reader - value callback is available for the database type name, do nothing. - - - The index of the column being read. - - - The extra event data to pass into the callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - Attempts to query the integer identifier for the current row. This - will not work for tables that were created WITHOUT ROWID -OR- if the - query does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The index of the BLOB column. - - - The integer identifier for the current row -OR- null if it could not - be determined. - - - - - Retrieves the column as a object. - This will not work for tables that were created WITHOUT ROWID - -OR- if the query does not include the "rowid" column or one - of its aliases -OR- if the was - not created with the - flag. - - The index of the column. - - Non-zero to open the blob object for read-only access. - - A new object. - - - - Retrieves the column as a boolean value - - The index of the column. - bool - - - - Retrieves the column as a single byte value - - The index of the column. - byte - - - - Retrieves a column as an array of bytes (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the bytes into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of bytes written into the array - - To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned. - - - - - Returns the column as a single character - - The index of the column. - char - - - - Retrieves a column as an array of chars (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the characters into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of characters written into the array - - To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned. - - - - - Retrieves the name of the back-end datatype of the column - - The index of the column. - string - - - - Retrieve the column as a date/time value - - The index of the column. - DateTime - - - - Retrieve the column as a decimal value - - The index of the column. - decimal - - - - Returns the column as a double - - The index of the column. - double - - - - Determines and returns the of the - specified column. - - - The index of the column. - - - The associated with the specified - column, if any. - - - - - Returns the .NET type of a given column - - The index of the column. - Type - - - - Returns a column as a float value - - The index of the column. - float - - - - Returns the column as a Guid - - The index of the column. - Guid - - - - Returns the column as a short - - The index of the column. - Int16 - - - - Retrieves the column as an int - - The index of the column. - Int32 - - - - Retrieves the column as a long - - The index of the column. - Int64 - - - - Retrieves the name of the column - - The index of the column. - string - - - - Returns the name of the database associated with the specified column. - - The index of the column. - string - - - - Returns the name of the table associated with the specified column. - - The index of the column. - string - - - - Returns the original name of the specified column. - - The index of the column. - string - - - - Retrieves the i of a column, given its name - - The name of the column to retrieve - The int i of the column - - - - Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done - to gather the necessary information so it can be represented in an ADO.NET manner. - - Returns a DataTable containing the schema information for the active SELECT statement being processed. - - - - Retrieves the column as a string - - The index of the column. - string - - - - Retrieves the column as an object corresponding to the underlying datatype of the column - - The index of the column. - object - - - - Retreives the values of multiple columns, up to the size of the supplied array - - The array to fill with values from the columns in the current resultset - The number of columns retrieved - - - - Returns a collection containing all the column names and values for the - current row of data in the current resultset, if any. If there is no - current row or no current resultset, an exception may be thrown. - - - The collection containing the column name and value information for the - current row of data in the current resultset or null if this information - cannot be obtained. - - - - - Returns True if the specified column is null - - The index of the column. - True or False - - - - Moves to the next resultset in multiple row-returning SQL command. - - True if the command was successful and a new resultset is available, False otherwise. - - - - This method attempts to query the database connection associated with - the data reader in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Retrieves the SQLiteType for a given column and row value. - - - The original SQLiteType structure, based only on the column. - - - The textual value of the column for a given row. - - - The SQLiteType structure. - - - - - Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. - - The flags associated with the parent connection object. - The index of the column. - A SQLiteType structure - - - - Reads the next row from the resultset - - True if a new row was successfully loaded and is ready for processing - - - - Not implemented. Returns 0 - - - - - Returns the number of columns in the current resultset - - - - - Returns the number of rows seen so far in the current result set. - - - - - Returns the number of visible fields in the current resultset - - - - - Returns True if the resultset has rows that can be fetched - - - - - Returns True if the data reader is closed - - - - - Returns the number of rows affected by the statement being executed. - The value returned may not be accurate for DDL statements. Also, it - will be -1 for any statement that does not modify the database (e.g. - SELECT). If an otherwise read-only statement modifies the database - indirectly (e.g. via a virtual table or user-defined function), the - value returned is undefined. - - - - - Indexer to retrieve data from a column given its name - - The name of the column to retrieve data for - The value contained in the column - - - - Indexer to retrieve data from a column given its i - - The index of the column. - The value contained in the column - - - - SQLite exception class. - - - - - This value was copied from the "WinError.h" file included with the - Platform SDK for Windows 10. - - - - - Private constructor for use with serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - Public constructor for generating a SQLite exception given the error - code and message. - - - The SQLite return code to report. - - - Message text to go along with the return code message text. - - - - - Public constructor that uses the base class constructor for the error - message. - - Error message text. - - - - Public constructor that uses the default base class constructor. - - - - - Public constructor that uses the base class constructor for the error - message and inner exception. - - Error message text. - The original (inner) exception. - - - - Adds extra information to the serialized object data specific to this - class type. This is only used for serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - This method performs extra initialization tasks. It may be called by - any of the constructors of this class. It must not throw exceptions. - - - - - Maps a Win32 error code to an HRESULT. - - - The specified Win32 error code. It must be within the range of zero - (0) to 0xFFFF (65535). - - - Non-zero if the HRESULT should indicate success; otherwise, zero. - - - The integer value of the HRESULT. - - - - - Attempts to map the specified onto an - existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The - mappings may not have perfectly matching semantics; however, they do - have the benefit of being unique within the context of this exception - type. - - - The to map. - - - The integer HRESULT value -OR- null if there is no known mapping. - - - - - Returns the error message for the specified SQLite return code. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns the composite error message based on the SQLite return code - and the optional detailed error message. - - The SQLite return code. - Optional detailed error message. - Error message text for the return code. - - - - Gets the associated SQLite result code for this exception as a - . This property returns the same - underlying value as the property. - - - - - Gets the associated SQLite return code for this exception as an - . For desktop versions of the .NET Framework, - this property overrides the property of the same name within the - - class. This property returns the same underlying value as the - property. - - - - - SQLite error codes. Actually, this enumeration represents a return code, - which may also indicate success in one of several ways (e.g. SQLITE_OK, - SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is - something of a misnomer. - - - - - The error code is unknown. This error code - is only used by the managed wrapper itself. - - - - - Successful result - - - - - SQL error or missing database - - - - - Internal logic error in SQLite - - - - - Access permission denied - - - - - Callback routine requested an abort - - - - - The database file is locked - - - - - A table in the database is locked - - - - - A malloc() failed - - - - - Attempt to write a readonly database - - - - - Operation terminated by sqlite3_interrupt() - - - - - Some kind of disk I/O error occurred - - - - - The database disk image is malformed - - - - - Unknown opcode in sqlite3_file_control() - - - - - Insertion failed because database is full - - - - - Unable to open the database file - - - - - Database lock protocol error - - - - - Database is empty - - - - - The database schema changed - - - - - String or BLOB exceeds size limit - - - - - Abort due to constraint violation - - - - - Data type mismatch - - - - - Library used incorrectly - - - - - Uses OS features not supported on host - - - - - Authorization denied - - - - - Auxiliary database format error - - - - - 2nd parameter to sqlite3_bind out of range - - - - - File opened that is not a database file - - - - - Notifications from sqlite3_log() - - - - - Warnings from sqlite3_log() - - - - - sqlite3_step() has another row ready - - - - - sqlite3_step() has finished executing - - - - - Used to mask off extended result codes - - - - - A collation sequence was referenced by a schema and it cannot be - found. - - - - - An internal operation failed and it may succeed if retried. - - - - - The specified snapshot has been overwritten by a checkpoint. - - - - - A file read operation failed. - - - - - A file read operation returned less data than requested. - - - - - A file write operation failed. - - - - - A file synchronization operation failed. - - - - - A directory synchronization operation failed. - - - - - A file truncate operation failed. - - - - - A file metadata operation failed. - - - - - A file unlock operation failed. - - - - - A file lock operation failed. - - - - - A file delete operation failed. - - - - - Not currently used. - - - - - Out-of-memory during a file operation. - - - - - A file existence/status operation failed. - - - - - A check for a reserved lock failed. - - - - - A file lock operation failed. - - - - - A file close operation failed. - - - - - A directory close operation failed. - - - - - A shared memory open operation failed. - - - - - A shared memory size operation failed. - - - - - A shared memory lock operation failed. - - - - - A shared memory map operation failed. - - - - - A file seek operation failed. - - - - - A file delete operation failed because it does not exist. - - - - - A file memory mapping operation failed. - - - - - The temporary directory path could not be obtained. - - - - - A path string conversion operation failed. - - - - - Reserved. - - - - - An attempt to authenticate failed. - - - - - An attempt to begin a file system transaction failed. - - - - - An attempt to commit a file system transaction failed. - - - - - An attempt to rollback a file system transaction failed. - - - - - A database table is locked in shared-cache mode. - - - - - A virtual table in the database is locked. - - - - - A database file is locked due to a recovery operation. - - - - - A database file is locked due to snapshot semantics. - - - - - A database file cannot be opened because no temporary directory is available. - - - - - A database file cannot be opened because its path represents a directory. - - - - - A database file cannot be opened because its full path could not be obtained. - - - - - A database file cannot be opened because a path string conversion operation failed. - - - - - No longer used. - - - - - A database file is a symbolic link and cannot be opened. - - - - - A virtual table is malformed. - - - - - A required sequence table is missing or corrupt. - - - - - A database file is read-only due to a recovery operation. - - - - - A database file is read-only because a lock could not be obtained. - - - - - A database file is read-only because it needs rollback processing. - - - - - A database file is read-only because it was moved while open. - - - - - The shared-memory file is read-only and it should be read-write. - - - - - Unable to create journal file because the directory is read-only. - - - - - An operation is being aborted due to rollback processing. - - - - - A CHECK constraint failed. - - - - - A commit hook produced a unsuccessful return code. - - - - - A FOREIGN KEY constraint failed. - - - - - Not currently used. - - - - - A NOT NULL constraint failed. - - - - - A PRIMARY KEY constraint failed. - - - - - The RAISE function was used by a trigger-program. - - - - - A UNIQUE constraint failed. - - - - - Not currently used. - - - - - A ROWID constraint failed. - - - - - A database cursor is busy and cannot be moved. - - - - - Frames were recovered from the WAL log file. - - - - - Pages were recovered from the journal file. - - - - - An automatic index was created to process a query. - - - - - User authentication failed. - - - - - Success. Prevents the extension from unloading until the process - terminates. - - - - - Success. The specified file name refers to a symbolic link. - - - - - SQLite implementation of . - - - SQLite implementation of . - - - - - Constructs a new instance. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - - - Cleans up resources associated with the current instance. - - - - - Static instance member which returns an instanced class. - - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Will provide a object in .NET 3.5. - - The class or interface type to query for. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. This event is provided for backward compatibility only. - New code should use the class instead. - - - - - This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each - connection to the database. - - - Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access - to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database - calls during processing. - - It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class - services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement - information in member variables of user-defined function classes. - - For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will - be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes. - - - - - The base connection this function is attached to - - - - - Internal array used to keep track of aggregate function context data - - - - - The connection flags associated with this object (this should be the - same value as the flags associated with the parent connection object). - - - - - Holds a reference to the callback function for user functions - - - - - Holds a reference to the callbakc function for stepping in an aggregate function - - - - - Holds a reference to the callback function for finalizing an aggregate function - - - - - Holds a reference to the callback function for collating sequences - - - - - Current context of the current callback. Only valid during a callback - - - - - This static dictionary contains all the registered (known) user-defined - functions declared using the proper attributes. The contained dictionary - values are always null and are not currently used. - - - - - Internal constructor, initializes the function's internal variables. - - - - - Constructs an instance of this class using the specified data-type - conversion parameters. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - Non-zero to create a UTF-16 data-type conversion context; otherwise, - a UTF-8 data-type conversion context will be created. - - - - - Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if - someone closes the connection while a DataReader is open. - - - - - Placeholder for a user-defined disposal routine - - True if the object is being disposed explicitly - - - - Cleans up resources associated with the current instance. - - - - - Scalar functions override this method to do their magic. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The arguments for the command to process - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - Aggregate functions override this method to do their magic. - - - Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible. - - The arguments for the command to process - The 1-based step number. This is incrememted each time the step method is called. - A placeholder for implementers to store contextual data pertaining to the current context. - - - - Aggregate functions override this method to finish their aggregate processing. - - - If you implemented your aggregate function properly, - you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have - all the information you need in there to figure out what to return. - NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will - be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value - if that is the case. - - Your own assigned contextData, provided for you so you can return your final results. - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - - User-defined collating sequences override this method to provide a custom string sorting algorithm. - - The first string to compare. - The second strnig to compare. - 1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2. - - - - Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The number of arguments - A pointer to the array of arguments - An object array of the arguments once they've been converted to .NET values - - - - Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context. - - The context the return value applies to - The parameter to return to SQLite - - - - Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method. - WARNING: Must not throw exceptions. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method. - WARNING: Must not throw exceptions. - - - This function takes care of doing the lookups and getting the important information put together to call the Step() function. - That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so - binary searches can be done to find the data. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method. - WARNING: Must not throw exceptions. - - A raw context pointer - - - - Using reflection, enumerate all assemblies in the current appdomain looking for classes that - have a SQLiteFunctionAttribute attribute, and registering them accordingly. - - - - - Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work - properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported. - - The type of the function to register - - - - Alternative method of registering a function. This method - does not require the specified type to be annotated with - . - - - The name of the function to register. - - - The number of arguments accepted by the function. - - - The type of SQLite function being resitered (e.g. scalar, - aggregate, or collating sequence). - - - The that actually implements the function. - This will only be used if the - and parameters are null. - - - The to be used for all calls into the - , - , - and virtual methods. - - - The to be used for all calls into the - virtual method. This - parameter is only necessary for aggregate functions. - - - - - Replaces a registered function, disposing of the associated (old) - value if necessary. - - - The attribute that describes the function to replace. - - - The new value to use. - - - Non-zero if an existing registered function was replaced; otherwise, - zero. - - - - - Creates a instance based on the specified - . - - - The containing the metadata about - the function to create. - - - The created function -OR- null if the function could not be created. - - - Non-zero if the function was created; otherwise, zero. - - - - - Called by the SQLiteBase derived classes, this method binds all registered (known) user-defined functions to a connection. - It is done this way so that all user-defined functions will access the database using the same encoding scheme - as the connection (UTF-8 or UTF-16). - - - The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to - all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks. - - The base object on which the functions are to bind. - The flags associated with the parent connection object. - Returns a logical list of functions which the connection should retain until it is closed. - - - - Called by the SQLiteBase derived classes, this method unbinds all registered (known) - functions -OR- all previously bound user-defined functions from a connection. - - The base object from which the functions are to be unbound. - The flags associated with the parent connection object. - - Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions - currently bound to the connection. - - Non-zero if all the specified user-defined functions were unbound. - - - - This function binds a user-defined function to a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined functions from a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert - strings and DateTime's into the current connection's encoding schema. - - - - - This type is used with the - method. - - - This is always the string literal "Invoke". - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This type is used with the - method. - - - This is always the string literal "Step". - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This type is used with the - method. - - - This is always the string literal "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This type is used with the - method. - - - This is always the string literal "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - This class implements a SQLite function using a . - All the virtual methods of the class are - implemented using calls to the , - , , - and strongly typed delegate types - or via the method. - The arguments are presented in the same order they appear in - the associated methods with one exception: - the first argument is the name of the virtual method being implemented. - - - - - This error message is used by the overridden virtual methods when - a required property (e.g. - or ) has not been - set. - - - - - This error message is used by the overridden - method when the result does not have a type of . - - - - - Constructs an empty instance of this class. - - - - - Constructs an instance of this class using the specified - as the - implementation. - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Invoke". - - - The original arguments received by the method. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Step". - - - The original arguments received by the method. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Updates the output arguments for the method, - using an of . The first - argument is always the literal string "Step". Currently, only the - parameter is updated. - - - The original arguments received by the method. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - This virtual method is the implementation for scalar functions. - See the method for more - details. - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This virtual method is part of the implementation for collating - sequences. See the method - for more details. - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call. - - - User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays. - - - - - Obtains the collating sequence in effect for the given function. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - The type of user-defined function to declare - - - - - Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc. - - - - - Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data. - Examples include SUM(), COUNT(), AVG(), etc. - - - - - Collating sequences are used to sort textual data in a custom manner, and appear in an ORDER BY clause. Typically text in an ORDER BY is - sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting - in a user-defined manner. - - - - - An internal callback delegate declaration. - - Raw native context pointer for the user function. - Total number of arguments to the user function. - Raw native pointer to the array of raw native argument pointers. - - - - An internal final callback delegate declaration. - - Raw context pointer for the user function - - - - Internal callback delegate for implementing collating sequences - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. - - - - The type of collating sequence - - - - - The built-in BINARY collating sequence - - - - - The built-in NOCASE collating sequence - - - - - The built-in REVERSE collating sequence - - - - - A custom user-defined collating sequence - - - - - The encoding type the collation sequence uses - - - - - The collation sequence is UTF8 - - - - - The collation sequence is UTF16 little-endian - - - - - The collation sequence is UTF16 big-endian - - - - - A struct describing the collating sequence a function is executing in - - - - - The name of the collating sequence - - - - - The type of collating sequence - - - - - The text encoding of the collation sequence - - - - - Context of the function that requested the collating sequence - - - - - Calls the base collating sequence to compare two strings - - The first string to compare - The second string to compare - -1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2 - - - - Calls the base collating sequence to compare two character arrays - - The first array to compare - The second array to compare - -1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2 - - - - A simple custom attribute to enable us to easily find user-defined functions in - the loaded assemblies and initialize them in SQLite as connections are made. - - - - - Default constructor, initializes the internal variables for the function. - - - - - Constructs an instance of this class. This sets the initial - , , and - properties to null. - - - The name of the function, as seen by the SQLite core library. - - - The number of arguments that the function will accept. - - - The type of function being declared. This will either be Scalar, - Aggregate, or Collation. - - - - - The function's name as it will be used in SQLite command text. - - - - - The number of arguments this function expects. -1 if the number of arguments is variable. - - - - - The type of function this implementation will be. - - - - - The object instance that describes the class - containing the implementation for the associated function. The value of - this property will not be used if either the or - property values are set to non-null. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - This class provides key info for a given SQLite statement. - - Providing key information for a given statement is non-trivial :( - - - - - - This function does all the nasty work at determining what keys need to be returned for - a given statement. - - - - - - - - Make sure all the subqueries are open and ready and sync'd with the current rowid - of the table they're supporting - - - - - Release any readers on any subqueries - - - - - Append all the columns we've added to the original query to the schema - - - - - - How many additional columns of keyinfo we're holding - - - - - Used to support CommandBehavior.KeyInfo - - - - - Used to keep track of the per-table RowId column metadata. - - - - - A single sub-query for a given table/database. - - - - - Event data for logging event handlers. - - - - - The error code. The type of this object value should be - or . - - - - - SQL statement text as the statement first begins executing - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - Should be null. - - The error code. The type of this object value should be - or . - - The error message, if any. - The extra data, if any. - - - - Raised when a log event occurs. - - The current connection - Event arguments of the trace - - - - Manages the SQLite custom logging functionality and the associated - callback for the whole process. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - Member variable to store the AppDomain.DomainUnload event handler. - - - - - The default log event handler. - - - - - The log callback passed to native SQLite engine. This must live - as long as the SQLite library has a pointer to it. - - - - - The base SQLite object to interop with. - - - - - The number of times that the - has been called when the logging subystem was actually eligible - to be initialized (i.e. without the "No_SQLiteLog" environment - variable being set). - - - - - This will be non-zero if an attempt was already made to initialize - the (managed) logging subsystem. - - - - - This will be non-zero if logging is currently enabled. - - - - - Initializes the SQLite logging facilities. - - - - - Initializes the SQLite logging facilities. - - - The name of the managed class that called this method. This - parameter may be null. - - - - - Handles the AppDomain being unloaded. - - Should be null. - The data associated with this event. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The SQLite error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The integer error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - - The error code. The type of this object value should be - System.Int32 or SQLiteErrorCode. - - The message to be logged. - - - - Creates and initializes the default log event handler. - - - - - Adds the default log event handler to the list of handlers. - - - - - Removes the default log event handler from the list of handlers. - - - - - Internal proxy function that calls any registered application log - event handlers. - - WARNING: This method is used more-or-less directly by native code, - do not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - Default logger. Currently, uses the Trace class (i.e. sends events - to the current trace listeners, if any). - - Should be null. - The data associated with this event. - - - - Member variable to store the application log handler to call. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. - - - - - If this property is true, logging is enabled; otherwise, logging is - disabled. When logging is disabled, no logging events will fire. - - - - - MetaDataCollections specific to SQLite - - - - - Returns a list of databases attached to the connection - - - - - Returns column information for the specified table - - - - - Returns index information for the optionally-specified table - - - - - Returns base columns for the given index - - - - - Returns the tables in the given catalog - - - - - Returns user-defined views in the given catalog - - - - - Returns underlying column information on the given view - - - - - Returns foreign key information for the given catalog - - - - - Returns the triggers on the database - - - - - SQLite implementation of DbParameter. - - - - - This value represents an "unknown" . - - - - - The command associated with this parameter. - - - - - The data type of the parameter - - - - - The version information for mapping the parameter - - - - - The value of the data in the parameter - - - - - The source column for the parameter - - - - - The column name - - - - - The data size, unused by SQLite - - - - - The database type name associated with this parameter, if any. - - - - - Constructor used when creating for use with a specific command. - - - The command associated with this parameter. - - - - - Default constructor - - - - - Constructs a named parameter given the specified parameter name - - The parameter name - - - - Constructs a named parameter given the specified parameter name and initial value - - The parameter name - The initial value of the parameter - - - - Constructs a named parameter of the specified type - - The parameter name - The datatype of the parameter - - - - Constructs a named parameter of the specified type and source column reference - - The parameter name - The data type - The source column - - - - Constructs a named parameter of the specified type, source column and row version - - The parameter name - The data type - The source column - The row version information - - - - Constructs an unnamed parameter of the specified data type - - The datatype of the parameter - - - - Constructs an unnamed parameter of the specified data type and sets the initial value - - The datatype of the parameter - The initial value of the parameter - - - - Constructs an unnamed parameter of the specified data type and source column - - The datatype of the parameter - The source column - - - - Constructs an unnamed parameter of the specified data type, source column and row version - - The data type - The source column - The row version information - - - - Constructs a named parameter of the specified type and size - - The parameter name - The data type - The size of the parameter - - - - Constructs a named parameter of the specified type, size and source column - - The name of the parameter - The data type - The size of the parameter - The source column - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - The source column - The row version information - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - Ignored - The source column - The row version information - The initial value to assign the parameter - - - - Constructs a named parameter, yet another flavor - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - The source column - The row version information - Whether or not this parameter is for comparing NULL's - The intial value to assign the parameter - - - - Constructs an unnamed parameter of the specified type and size - - The data type - The size of the parameter - - - - Constructs an unnamed parameter of the specified type, size, and source column - - The data type - The size of the parameter - The source column - - - - Constructs an unnamed parameter of the specified type, size, source column and row version - - The data type - The size of the parameter - The source column - The row version information - - - - Resets the DbType of the parameter so it can be inferred from the value - - - - - Clones a parameter - - A new, unassociated SQLiteParameter - - - - The command associated with this parameter. - - - - - Whether or not the parameter can contain a null value - - - - - Returns the datatype of the parameter - - - - - Supports only input parameters - - - - - Returns the parameter name - - - - - Returns the size of the parameter - - - - - Gets/sets the source column - - - - - Used by DbCommandBuilder to determine the mapping for nullable fields - - - - - Gets and sets the row version - - - - - Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. - - - - - The database type name associated with this parameter, if any. - - - - - SQLite implementation of DbParameterCollection. - - - - - The underlying command to which this collection belongs - - - - - The internal array of parameters in this collection - - - - - Determines whether or not all parameters have been bound to their statement(s) - - - - - Initializes the collection - - The command to which the collection belongs - - - - Retrieves an enumerator for the collection - - An enumerator for the underlying array - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - The source column - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a named/unnamed parameter and its value to the parameter collection. - - Name of the parameter, or null to indicate an unnamed parameter - The initial value of the parameter - Returns the SQLiteParameter object created during the call. - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Clears the array and resets the collection - - - - - Determines if the named parameter exists in the collection - - The name of the parameter to check - True if the parameter is in the collection - - - - Determines if the parameter exists in the collection - - The SQLiteParameter to check - True if the parameter is in the collection - - - - Not implemented - - - - - - - Retrieve a parameter by name from the collection - - The name of the parameter to fetch - A DbParameter object - - - - Retrieves a parameter by its index in the collection - - The index of the parameter to retrieve - A DbParameter object - - - - Returns the index of a parameter given its name - - The name of the parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Returns the index of a parameter - - The parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Inserts a parameter into the array at the specified location - - The zero-based index to insert the parameter at - The parameter to insert - - - - Removes a parameter from the collection - - The parameter to remove - - - - Removes a parameter from the collection given its name - - The name of the parameter to remove - - - - Removes a parameter from the collection given its index - - The zero-based parameter index to remove - - - - Re-assign the named parameter to a new parameter object - - The name of the parameter to replace - The new parameter - - - - Re-assign a parameter at the specified index - - The zero-based index of the parameter to replace - The new parameter - - - - Un-binds all parameters from their statements - - - - - This function attempts to map all parameters in the collection to all statements in a Command. - Since named parameters may span multiple statements, this function makes sure all statements are bound - to the same named parameter. Unnamed parameters are bound in sequence. - - - - - Returns false - - - - - Returns false - - - - - Returns false - - - - - Returns null - - - - - Returns a count of parameters in the collection - - - - - Overloaded to specialize the return value of the default indexer - - Name of the parameter to get/set - The specified named SQLite parameter - - - - Overloaded to specialize the return value of the default indexer - - The index of the parameter to get/set - The specified SQLite parameter - - - - Represents a single SQL statement in SQLite. - - - - - The underlying SQLite object this statement is bound to - - - - - The command text of this SQL statement - - - - - The actual statement pointer - - - - - An index from which unnamed parameters begin - - - - - Names of the parameters as SQLite understands them to be - - - - - Parameters for this statement - - - - - Command this statement belongs to (if any) - - - - - The flags associated with the parent connection object. - - - - - Initializes the statement and attempts to get all information about parameters in the statement - - The base SQLite object - The flags associated with the parent connection object - The statement - The command text for this statement - The previous command in a multi-statement command - - - - Disposes and finalizes the statement - - - - - If the underlying database connection is open, fetches the number of changed rows - resulting from the most recent query; otherwise, does nothing. - - - The number of changes when true is returned. - Undefined if false is returned. - - - The read-only flag when true is returned. - Undefined if false is returned. - - Non-zero if the number of changed rows was fetched. - - - - Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to - this statement, and if so, keeps a reference to the parameter so it can be bound later. - - The parameter name to map - The parameter to assign it - - - - Bind all parameters, making sure the caller didn't miss any - - - - - This method attempts to query the database connection associated with - the statement in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Invokes the parameter binding callback configured for the database - type name associated with the specified column. If no parameter - binding callback is available for the database type name, do - nothing. - - - The index of the column being read. - - - The instance being bound to the - command. - - - Non-zero if the default handling for the parameter binding call - should be skipped (i.e. the parameter should not be bound at all). - Great care should be used when setting this to non-zero. - - - - - Perform the bind operation for an individual parameter - - The index of the parameter to bind - The parameter we're binding - - - - SQLite implementation of DbTransaction that does not support nested transactions. - - - - - Base class used by to implement DbTransaction for SQLite. - - - - - The connection to which this transaction is bound. - - - - - Matches the version of the connection. - - - - - The isolation level for this transaction. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Rolls back the active transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Checks the state of this transaction, optionally throwing an exception if a state - inconsistency is found. - - - Non-zero to throw an exception if a state inconsistency is found. - - - Non-zero if this transaction is valid; otherwise, false. - - - - - Gets the isolation level of the transaction. SQLite only supports Serializable transactions. - - - - - Returns the underlying connection to which this transaction applies. - - - - - Forwards to the local Connection property - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - SQLite implementation of DbTransaction that does support nested transactions. - - - - - The original transaction level for the associated connection - when this transaction was created (i.e. begun). - - - - - The SAVEPOINT name for this transaction, if any. This will - only be non-null if this transaction is a nested one. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Constructs the name of a new savepoint for this transaction. It - should only be called from the constructor of this class. - - - The name of the new savepoint -OR- null if it cannot be constructed. - - - - - This static class provides some methods that are shared between the - native library pre-loader and other classes. - - - - - This lock is used to protect the static and - fields. - - - - - This type is only present when running on Mono. - - - - - This type is only present when running on .NET Core. - - - - - Keeps track of whether we are running on Mono. Initially null, it is - set by the method on its first call. Later, it - is returned verbatim by the method. - - - - - Keeps track of whether we are running on .NET Core. Initially null, - it is set by the method on its first - call. Later, it is returned verbatim by the - method. - - - - - Keeps track of whether we successfully invoked the - method. Initially null, it is set by - the method on its first call. - - - - - Determines the ID of the current process. Only used for debugging. - - - The ID of the current process -OR- zero if it cannot be determined. - - - - - Determines whether or not this assembly is running on Mono. - - - Non-zero if this assembly is running on Mono. - - - - - Determines whether or not this assembly is running on .NET Core. - - - Non-zero if this assembly is running on .NET Core. - - - - - Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger" - configuration setting. - - - - - If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is - present (e.g. via the environment), give the interactive user an - opportunity to attach a debugger to the current process; otherwise, - do nothing. - - - - - Determines the ID of the current thread. Only used for debugging. - - - The ID of the current thread -OR- zero if it cannot be determined. - - - - - Determines if the specified flags are present within the flags - associated with the parent connection object. - - - The flags associated with the parent connection object. - - - The flags to check for. - - - Non-zero if the specified flag or flags were present; otherwise, - zero. - - - - - Determines if preparing a query should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the query preparation should be logged; otherwise, zero. - - - - - Determines if pre-parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the pre-parameter binding should be logged; otherwise, - zero. - - - - - Determines if parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the parameter binding should be logged; otherwise, zero. - - - - - Determines if an exception in a native callback should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be logged; otherwise, zero. - - - - - Determines if backup API errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the backup API error should be logged; otherwise, zero. - - - - - Determines if logging for the class is - disabled. - - - The flags associated with the parent connection object. - - - Non-zero if logging for the class is - disabled; otherwise, zero. - - - - - Determines if errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the error should be logged; - otherwise, zero. - - - - - Determines if exceptions should be - logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be - logged; otherwise, zero. - - - - - Determines if the current process is running on one of the Windows - [sub-]platforms. - - - Non-zero when running on Windows; otherwise, zero. - - - - - This is a wrapper around the - method. - On Mono, it has to call the method overload without the - parameter, due to a bug in Mono. - - - This is used for culture-specific formatting. - - - The format string. - - - An array the objects to format. - - - The resulting string. - - - - - This static class provides a thin wrapper around the native library - loading features of the underlying platform. - - - - - Attempts to load the specified native library file using the Win32 - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the Win32 API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file using the POSIX - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the POSIX API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - This delegate is used to wrap the concept of loading a native - library, based on a file name, and returning the loaded module - handle. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This delegate is used to wrap the concept of querying the machine - name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - This class declares P/Invoke methods to call native POSIX APIs. - - - - - For use with dlopen(), bind function calls lazily. - - - - - For use with dlopen(), bind function calls immediately. - - - - - For use with dlopen(), make symbols globally available. - - - - - For use with dlopen(), opposite of RTLD_GLOBAL, and the default. - - - - - For use with dlopen(), the defaults used by this class. - - - - - This is the P/Invoke method that wraps the native Unix uname - function. See the POSIX documentation for full details on what it - does. - - - Structure containing a preallocated byte buffer to fill with the - requested information. - - - Zero for success and less than zero upon failure. - - - - - This is the P/Invoke method that wraps the native Unix dlopen - function. See the POSIX documentation for full details on what it - does. - - - The name of the executable library. - - - This must be a combination of the individual bit flags RTLD_LAZY, - RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Unix dlclose - function. See the POSIX documentation for full details on what it - does. - - - The handle to the loaded native library. - - - Zero upon success -OR- non-zero on failure. - - - - - These are the characters used to separate the string fields within - the raw buffer returned by the P/Invoke method. - - - - - This method is a wrapper around the P/Invoke - method that extracts and returns the human readable strings from - the raw buffer. - - - This structure, which contains strings, will be filled based on the - data placed in the raw buffer returned by the - P/Invoke method. - - - Non-zero upon success; otherwise, zero. - - - - - This structure is used when running on POSIX operating systems - to store information about the current machine, including the - human readable name of the operating system as well as that of - the underlying hardware. - - - - - This structure is passed directly to the P/Invoke method to - obtain the information about the current machine, including - the human readable name of the operating system as well as - that of the underlying hardware. - - - - - This class declares P/Invoke methods to call native Win32 APIs. - - - - - This is the P/Invoke method that wraps the native Win32 LoadLibrary - function. See the MSDN documentation for full details on what it - does. - - - The name of the executable library. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Win32 GetSystemInfo - function. See the MSDN documentation for full details on what it - does. - - - The system information structure to be filled in by the function. - - - - - This enumeration contains the possible values for the processor - architecture field of the system information structure. - - - - - This structure contains information about the current computer. This - includes the processor type, page size, memory addresses, etc. - - - - - This class declares P/Invoke methods to call native SQLite APIs. - - - - - The file extension used for dynamic link libraries. - - - - - The file extension used for the XML configuration file. - - - - - This is the name of the XML configuration file specific to the - System.Data.SQLite assembly. - - - - - This is the XML configuratrion file token that will be replaced with - the qualified path to the directory containing the XML configuration - file. - - - - - This is the environment variable token that will be replaced with - the qualified path to the directory containing this assembly. - - - - - This is the environment variable token that will be replaced with an - abbreviation of the target framework attribute value associated with - this assembly. - - - - - This lock is used to protect the static _SQLiteNativeModuleFileName, - _SQLiteNativeModuleHandle, and processorArchitecturePlatforms fields. - - - - - This dictionary stores the mappings between target framework names - and their associated (NuGet) abbreviations. These mappings are only - used by the method. - - - - - This dictionary stores the mappings between processor architecture - names and platform names. These mappings are now used for two - purposes. First, they are used to determine if the assembly code - base should be used instead of the location, based upon whether one - or more of the named sub-directories exist within the assembly code - base. Second, they are used to assist in loading the appropriate - SQLite interop assembly into the current process. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable assembly directory. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable XML configuration file name. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - For now, this method simply calls the Initialize method. - - - - - Attempts to initialize this class by pre-loading the native SQLite - library for the processor architecture of the current process. - - - - - Combines two path strings. - - - The first path -OR- null. - - - The second path -OR- null. - - - The combined path string -OR- null if both of the original path - strings are null. - - - - - Resets the cached XML configuration file name value, thus forcing the - next call to method to rely - upon the method to fetch the - XML configuration file name. - - - - - Queries and returns the cached XML configuration file name for the - assembly containing the managed System.Data.SQLite components, if - available. If the cached XML configuration file name value is not - available, the method will - be used to obtain the XML configuration file name. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - Queries and returns the XML configuration file name for the assembly - containing the managed System.Data.SQLite components. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - If necessary, replaces all supported XML configuration file tokens - with their associated values. - - - The name of the XML configuration file being read. - - - A setting value read from the XML configuration file. - - - The value of the will all supported XML - configuration file tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the - specified XML configuration file. - - - The name of the XML configuration file to read. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - Non-zero to expand any environment variable references contained in - the setting value to be returned. This has no effect on the .NET - Compact Framework. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. - - - - - Attempts to determine the target framework attribute value that is - associated with the specified managed assembly, if applicable. - - - The managed assembly to read the target framework attribute value - from. - - - The value of the target framework attribute value for the specified - managed assembly -OR- null if it cannot be determined. If this - assembly was compiled with a version of the .NET Framework prior to - version 4.0, the value returned MAY reflect that version of the .NET - Framework instead of the one associated with the specified managed - assembly. - - - - - Accepts a long target framework attribute value and makes it into a - much shorter version, suitable for use with NuGet packages. - - - The long target framework attribute value to convert. - - - The short target framework attribute value -OR- null if it cannot - be determined or converted. - - - - - If necessary, replaces all supported environment variable tokens - with their associated values. - - - A setting value read from an environment variable. - - - The value of the will all supported - environment variable tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the XML - configuration file and/or the environment variables for the current - process and/or the current system, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. By default, all references to existing - environment variables will be expanded to their corresponding values - within the value to be returned unless either the "No_Expand" or - "No_Expand_" environment variable is set [to - anything]. - - - - - Resets the cached assembly directory value, thus forcing the next - call to method to rely - upon the method to fetch the - assembly directory. - - - - - Queries and returns the cached directory for the assembly currently - being executed, if available. If the cached assembly directory value - is not available, the method will - be used to obtain the assembly directory. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - Queries and returns the directory for the assembly currently being - executed. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - The name of the environment variable containing the processor - architecture of the current process. - - - - - The native module file name for the native SQLite library or null. - - - - - The native module handle for the native SQLite library or the value - IntPtr.Zero. - - - - - Determines the base file name (without any directory information) - for the native SQLite library to be pre-loaded by this class. - - - The base file name for the native SQLite library to be pre-loaded by - this class -OR- null if its value cannot be determined. - - - - - Searches for the native SQLite library in the directory containing - the assembly currently being executed as well as the base directory - for the current application domain. - - - Upon success, this parameter will be modified to refer to the base - directory containing the native SQLite library. - - - Upon success, this parameter will be modified to refer to the name - of the immediate directory (i.e. the offset from the base directory) - containing the native SQLite library. - - - Upon success, this parameter will be modified to non-zero only if - the base directory itself should be allowed for loading the native - library. - - - Non-zero (success) if the native SQLite library was found; otherwise, - zero (failure). - - - - - Queries and returns the base directory of the current application - domain. - - - The base directory for the current application domain -OR- null if it - cannot be determined. - - - - - Determines if the dynamic link library file name requires a suffix - and adds it if necessary. - - - The original dynamic link library file name to inspect. - - - The dynamic link library file name, possibly modified to include an - extension. - - - - - Queries and returns the processor architecture of the current - process. - - - The processor architecture of the current process -OR- null if it - cannot be determined. - - - - - Given the processor architecture, returns the name of the platform. - - - The processor architecture to be translated to a platform name. - - - The platform name for the specified processor architecture -OR- null - if it cannot be determined. - - - - - Attempts to load the native SQLite library based on the specified - directory and processor architecture. - - - The base directory to use, null for default (the base directory of - the current application domain). This directory should contain the - processor architecture specific sub-directories. - - - The requested processor architecture, null for default (the - processor architecture of the current process). This caller should - almost always specify null for this parameter. - - - Non-zero indicates that the native SQLite library can be loaded - from the base directory itself. - - - The candidate native module file name to load will be stored here, - if necessary. - - - The native module handle as returned by LoadLibrary will be stored - here, if necessary. This value will be IntPtr.Zero if the call to - LoadLibrary fails. - - - Non-zero if the native module was loaded successfully; otherwise, - zero. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to <?xml version="1.0" standalone="yes"?> - <DocumentElement> - <DataTypes> - <TypeName>smallint</TypeName> - <ProviderDbType>10</ProviderDbType> - <ColumnSize>5</ColumnSize> - <DataType>System.Int16</DataType> - <CreateFormat>smallint</CreateFormat> - <IsAutoIncrementable>false</IsAutoIncrementable> - <IsCaseSensitive>false</IsCaseSensitive> - <IsFixedLength>true</IsFixedLength> - <IsFixedPrecisionScale>true</IsFixedPrecisionScale> - <IsLong>false</IsLong> - <IsNullable>true</ [rest of string was truncated]";. - - - - - Looks up a localized string similar to ALL,ALTER,AND,AS,AUTOINCREMENT,BETWEEN,BY,CASE,CHECK,COLLATE,COMMIT,CONSTRAINT,CREATE,CROSS,DEFAULT,DEFERRABLE,DELETE,DISTINCT,DROP,ELSE,ESCAPE,EXCEPT,FOREIGN,FROM,FULL,GROUP,HAVING,IN,INDEX,INNER,INSERT,INTERSECT,INTO,IS,ISNULL,JOIN,LEFT,LIMIT,NATURAL,NOT,NOTNULL,NULL,ON,OR,ORDER,OUTER,PRIMARY,REFERENCES,RIGHT,ROLLBACK,SELECT,SET,TABLE,THEN,TO,TRANSACTION,UNION,UNIQUE,UPDATE,USING,VALUES,WHEN,WHERE. - - - - - Looks up a localized string similar to <?xml version="1.0" encoding="utf-8" ?> - <DocumentElement> - <MetaDataCollections> - <CollectionName>MetaDataCollections</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataCollections> - <CollectionName>DataSourceInformation</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataC [rest of string was truncated]";. - - - - - This interface represents a virtual table implementation written in - native code. - - - - - - int (*xCreate)(sqlite3 *db, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xCreate method is called to create a new instance of a virtual table - in response to a CREATE VIRTUAL TABLE statement. - If the xCreate method is the same pointer as the xConnect method, then the - virtual table is an eponymous virtual table. - If the xCreate method is omitted (if it is a NULL pointer) then the virtual - table is an eponymous-only virtual table. - - - The db parameter is a pointer to the SQLite database connection that - is executing the CREATE VIRTUAL TABLE statement. - The pAux argument is the copy of the client data pointer that was the - fourth argument to the sqlite3_create_module() or - sqlite3_create_module_v2() call that registered the - virtual table module. - The argv parameter is an array of argc pointers to null terminated strings. - The first string, argv[0], is the name of the module being invoked. The - module name is the name provided as the second argument to - sqlite3_create_module() and as the argument to the USING clause of the - CREATE VIRTUAL TABLE statement that is running. - The second, argv[1], is the name of the database in which the new virtual table is being created. The database name is "main" for the primary database, or - "temp" for TEMP database, or the name given at the end of the ATTACH - statement for attached databases. The third element of the array, argv[2], - is the name of the new virtual table, as specified following the TABLE - keyword in the CREATE VIRTUAL TABLE statement. - If present, the fourth and subsequent strings in the argv[] array report - the arguments to the module name in the CREATE VIRTUAL TABLE statement. - - - The job of this method is to construct the new virtual table object - (an sqlite3_vtab object) and return a pointer to it in *ppVTab. - - - As part of the task of creating a new sqlite3_vtab structure, this - method must invoke sqlite3_declare_vtab() to tell the SQLite - core about the columns and datatypes in the virtual table. - The sqlite3_declare_vtab() API has the following prototype: - - - int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) - - - The first argument to sqlite3_declare_vtab() must be the same - database connection pointer as the first parameter to this method. - The second argument to sqlite3_declare_vtab() must a zero-terminated - UTF-8 string that contains a well-formed CREATE TABLE statement that - defines the columns in the virtual table and their data types. - The name of the table in this CREATE TABLE statement is ignored, - as are all constraints. Only the column names and datatypes matter. - The CREATE TABLE statement string need not to be - held in persistent memory. The string can be - deallocated and/or reused as soon as the sqlite3_declare_vtab() - routine returns. - - - The xCreate method need not initialize the pModule, nRef, and zErrMsg - fields of the sqlite3_vtab object. The SQLite core will take care of - that chore. - - - The xCreate should return SQLITE_OK if it is successful in - creating the new virtual table, or SQLITE_ERROR if it is not successful. - If not successful, the sqlite3_vtab structure must not be allocated. - An error message may optionally be returned in *pzErr if unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - If the xCreate method is omitted (left as a NULL pointer) then the - virtual table is an eponymous-only virtual table. New instances of - the virtual table cannot be created using CREATE VIRTUAL TABLE and the - virtual table can only be used via its module name. - Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand - eponymous-only virtual tables and will segfault if an attempt is made - to CREATE VIRTUAL TABLE on an eponymous-only virtual table because - the xCreate method was not checked for null. - - - If the xCreate method is the exact same pointer as the xConnect method, - that indicates that the virtual table does not need to initialize backing - store. Such a virtual table can be used as an eponymous virtual table - or as a named virtual table using CREATE VIRTUAL TABLE or both. - - - If a column datatype contains the special keyword "HIDDEN" - (in any combination of upper and lower case letters) then that keyword - it is omitted from the column datatype name and the column is marked - as a hidden column internally. - A hidden column differs from a normal column in three respects: - - - ]]> - ]]> Hidden columns are not listed in the dataset returned by - "PRAGMA table_info", - ]]>]]> Hidden columns are not included in the expansion of a "*" - expression in the result set of a SELECT, and - ]]>]]> Hidden columns are not included in the implicit column-list - used by an INSERT statement that lacks an explicit column-list. - ]]>]]> - - - For example, if the following SQL is passed to sqlite3_declare_vtab(): - - - CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden); - - - Then the virtual table would be created with two hidden columns, - and with datatypes of "VARCHAR(12)" and "INTEGER". - - - An example use of hidden columns can be seen in the FTS3 virtual - table implementation, where every FTS virtual table - contains an FTS hidden column that is used to pass information from the - virtual table into FTS auxiliary functions and to the FTS MATCH operator. - - - A virtual table that contains hidden columns can be used like - a table-valued function in the FROM clause of a SELECT statement. - The arguments to the table-valued function become constraints on - the HIDDEN columns of the virtual table. - - - For example, the "generate_series" extension (located in the - ext/misc/series.c - file in the source tree) - implements an eponymous virtual table with the following schema: - - - CREATE TABLE generate_series( - value, - start HIDDEN, - stop HIDDEN, - step HIDDEN - ); - - - The sqlite3_module.xBestIndex method in the implementation of this - table checks for equality constraints against the HIDDEN columns, and uses - those as input parameters to determine the range of integer "value" outputs - to generate. Reasonable defaults are used for any unconstrained columns. - For example, to list all integers between 5 and 50: - - - SELECT value FROM generate_series(5,50); - - - The previous query is equivalent to the following: - - - SELECT value FROM generate_series WHERE start=5 AND stop=50; - - - Arguments on the virtual table name are matched to hidden columns - in order. The number of arguments can be less than the - number of hidden columns, in which case the latter hidden columns are - unconstrained. However, an error results if there are more arguments - than there are hidden columns in the virtual table. - - - Beginning with SQLite version 3.14.0 (2016-08-08), - the CREATE TABLE statement that - is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause. - This is useful for cases where the virtual table rows - cannot easily be mapped into unique integers. A CREATE TABLE - statement that includes WITHOUT ROWID must define one or more columns as - the PRIMARY KEY. Every column of the PRIMARY KEY must individually be - NOT NULL and all columns for each row must be collectively unique. - - - Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID - virtual table. Enforcement is the responsibility of the underlying - virtual table implementation. But SQLite does assume that the PRIMARY KEY - constraint is valid - that the identified columns really are UNIQUE and - NOT NULL - and it uses that assumption to optimize queries against the - virtual table. - - - The rowid column is not accessible on a - WITHOUT ROWID virtual table (of course). - - - The xUpdate method was originally designed around having a - ROWID as a single value. The xUpdate method has been expanded to - accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the - PRIMARY KEY must still be only one column. For this reason, SQLite - will reject any WITHOUT ROWID virtual table that has more than one - PRIMARY KEY column and a non-NULL xUpdate method. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - int (*xConnect)(sqlite3*, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xConnect method is very similar to xCreate. - It has the same parameters and constructs a new sqlite3_vtab structure - just like xCreate. - And it must also call sqlite3_declare_vtab() like xCreate. - - - The difference is that xConnect is called to establish a new - connection to an existing virtual table whereas xCreate is called - to create a new virtual table from scratch. - - - The xCreate and xConnect methods are only different when the - virtual table has some kind of backing store that must be initialized - the first time the virtual table is created. The xCreate method creates - and initializes the backing store. The xConnect method just connects - to an existing backing store. When xCreate and xConnect are the same, - the table is an eponymous virtual table. - - - As an example, consider a virtual table implementation that - provides read-only access to existing comma-separated-value (CSV) - files on disk. There is no backing store that needs to be created - or initialized for such a virtual table (since the CSV files already - exist on disk) so the xCreate and xConnect methods will be identical - for that module. - - - Another example is a virtual table that implements a full-text index. - The xCreate method must create and initialize data structures to hold - the dictionary and posting lists for that index. The xConnect method, - on the other hand, only has to locate and use an existing dictionary - and posting lists that were created by a prior xCreate call. - - - The xConnect method must return SQLITE_OK if it is successful - in creating the new virtual table, or SQLITE_ERROR if it is not - successful. If not successful, the sqlite3_vtab structure must not be - allocated. An error message may optionally be returned in *pzErr if - unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - The xConnect method is required for every virtual table implementation, - though the xCreate and xConnect pointers of the sqlite3_module object - may point to the same function if the virtual table does not need to - initialize backing store. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - SQLite uses the xBestIndex method of a virtual table module to determine - the best way to access the virtual table. - The xBestIndex method has a prototype like this: - - - int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); - - - The SQLite core communicates with the xBestIndex method by filling - in certain fields of the sqlite3_index_info structure and passing a - pointer to that structure into xBestIndex as the second parameter. - The xBestIndex method fills out other fields of this structure which - forms the reply. The sqlite3_index_info structure looks like this: - - - struct sqlite3_index_info { - /* Inputs */ - const int nConstraint; /* Number of entries in aConstraint */ - const struct sqlite3_index_constraint { - int iColumn; /* Column constrained. -1 for ROWID */ - unsigned char op; /* Constraint operator */ - unsigned char usable; /* True if this constraint is usable */ - int iTermOffset; /* Used internally - xBestIndex should ignore */ - } *const aConstraint; /* Table of WHERE clause constraints */ - const int nOrderBy; /* Number of terms in the ORDER BY clause */ - const struct sqlite3_index_orderby { - int iColumn; /* Column number */ - unsigned char desc; /* True for DESC. False for ASC. */ - } *const aOrderBy; /* The ORDER BY clause */ - /* Outputs */ - struct sqlite3_index_constraint_usage { - int argvIndex; /* if >0, constraint is part of argv to xFilter */ - unsigned char omit; /* Do not code a test for this constraint */ - } *const aConstraintUsage; - int idxNum; /* Number used to identify the index */ - char *idxStr; /* String, possibly obtained from sqlite3_malloc */ - int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ - int orderByConsumed; /* True if output is already ordered */ - double estimatedCost; /* Estimated cost of using this index */ - ]]>/* Fields below are only available in SQLite 3.8.2 and later */]]> - sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ - ]]>/* Fields below are only available in SQLite 3.9.0 and later */]]> - int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ - ]]>/* Fields below are only available in SQLite 3.10.0 and later */]]> - sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ - }; - - - Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields. - These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively. - Any extension that reads or writes these fields must first check that the - version of the SQLite library in use is greater than or equal to appropriate - version - perhaps comparing the value returned from sqlite3_libversion_number() - against constants 3008002, 3009000, and/or 3010000. The result of attempting - to access these fields in an sqlite3_index_info structure created by an - older version of SQLite are undefined. - - - In addition, there are some defined constants: - - - #define SQLITE_INDEX_CONSTRAINT_EQ 2 - #define SQLITE_INDEX_CONSTRAINT_GT 4 - #define SQLITE_INDEX_CONSTRAINT_LE 8 - #define SQLITE_INDEX_CONSTRAINT_LT 16 - #define SQLITE_INDEX_CONSTRAINT_GE 32 - #define SQLITE_INDEX_CONSTRAINT_MATCH 64 - #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */ - #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ - - - The SQLite core calls the xBestIndex method when it is compiling a query - that involves a virtual table. In other words, SQLite calls this method - when it is running sqlite3_prepare() or the equivalent. - By calling this method, the - SQLite core is saying to the virtual table that it needs to access - some subset of the rows in the virtual table and it wants to know the - most efficient way to do that access. The xBestIndex method replies - with information that the SQLite core can then use to conduct an - efficient search of the virtual table. - - - While compiling a single SQL query, the SQLite core might call - xBestIndex multiple times with different settings in sqlite3_index_info. - The SQLite core will then select the combination that appears to - give the best performance. - - - Before calling this method, the SQLite core initializes an instance - of the sqlite3_index_info structure with information about the - query that it is currently trying to process. This information - derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses - of the query, but also from any ON or USING clauses if the query is a - join. The information that the SQLite core provides to the xBestIndex - method is held in the part of the structure that is marked as "Inputs". - The "Outputs" section is initialized to zero. - - - The information in the sqlite3_index_info structure is ephemeral - and may be overwritten or deallocated as soon as the xBestIndex method - returns. If the xBestIndex method needs to remember any part of the - sqlite3_index_info structure, it should make a copy. Care must be - take to store the copy in a place where it will be deallocated, such - as in the idxStr field with needToFreeIdxStr set to 1. - - - Note that xBestIndex will always be called before xFilter, since - the idxNum and idxStr outputs from xBestIndex are required inputs to - xFilter. However, there is no guarantee that xFilter will be called - following a successful xBestIndex. - - - The xBestIndex method is required for every virtual table implementation. - - - The main thing that the SQLite core is trying to communicate to - the virtual table is the constraints that are available to limit - the number of rows that need to be searched. The aConstraint[] array - contains one entry for each constraint. There will be exactly - nConstraint entries in that array. - - - Each constraint will usually correspond to a term in the WHERE clause - or in a USING or ON clause that is of the form - - - column OP EXPR - - - Where "column" is a column in the virtual table, OP is an operator - like "=" or "<", and EXPR is an arbitrary expression. So, for example, - if the WHERE clause contained a term like this: - - - a = 5 - - - Then one of the constraints would be on the "a" column with - operator "=" and an expression of "5". Constraints need not have a - literal representation of the WHERE clause. The query optimizer might - make transformations to the - WHERE clause in order to extract as many constraints - as it can. So, for example, if the WHERE clause contained something - like this: - - - x BETWEEN 10 AND 100 AND 999>y - - - The query optimizer might translate this into three separate constraints: - - - x >= 10 - x <= 100 - y < 999 - - - For each such constraint, the aConstraint[].iColumn field indicates which - column appears on the left-hand side of the constraint. - The first column of the virtual table is column 0. - The rowid of the virtual table is column -1. - The aConstraint[].op field indicates which operator is used. - The SQLITE_INDEX_CONSTRAINT_* constants map integer constants - into operator values. - Columns occur in the order they were defined by the call to - sqlite3_declare_vtab() in the xCreate or xConnect method. - Hidden columns are counted when determining the column index. - - - If the xFindFunction() method for the virtual table is defined, and - if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, then the constraints might also be of the form: - - - FUNCTION( column, EXPR) - - - In this case the aConstraint[].op value is the same as the value - returned by xFindFunction() for FUNCTION. - - - The aConstraint[] array contains information about all constraints - that apply to the virtual table. But some of the constraints might - not be usable because of the way tables are ordered in a join. - The xBestIndex method must therefore only consider constraints - that have an aConstraint[].usable flag which is true. - - - In addition to WHERE clause constraints, the SQLite core also - tells the xBestIndex method about the ORDER BY clause. - (In an aggregate query, the SQLite core might put in GROUP BY clause - information in place of the ORDER BY clause information, but this fact - should not make any difference to the xBestIndex method.) - If all terms of the ORDER BY clause are columns in the virtual table, - then nOrderBy will be the number of terms in the ORDER BY clause - and the aOrderBy[] array will identify the column for each term - in the order by clause and whether or not that column is ASC or DESC. - - - In SQLite version 3.10.0 (2016-01-06) and later, - the colUsed field is available - to indicate which fields of the virtual table are actually used by the - statement being prepared. If the lowest bit of colUsed is set, that - means that the first column is used. The second lowest bit corresponds - to the second column. And so forth. If the most significant bit of - colUsed is set, that means that one or more columns other than the - first 63 columns are used. If column usage information is needed by the - xFilter method, then the required bits must be encoded into either - the idxNum or idxStr output fields. - - - Given all of the information above, the job of the xBestIndex - method it to figure out the best way to search the virtual table. - - - The xBestIndex method fills the idxNum and idxStr fields with - information that communicates an indexing strategy to the xFilter - method. The information in idxNum and idxStr is arbitrary as far - as the SQLite core is concerned. The SQLite core just copies the - information through to the xFilter method. Any desired meaning can - be assigned to idxNum and idxStr as long as xBestIndex and xFilter - agree on what that meaning is. - - - The idxStr value may be a string obtained from an SQLite - memory allocation function such as sqlite3_mprintf(). - If this is the case, then the needToFreeIdxStr flag must be set to - true so that the SQLite core will know to call sqlite3_free() on - that string when it has finished with it, and thus avoid a memory leak. - The idxStr value may also be a static constant string, in which case - the needToFreeIdxStr boolean should remain false. - - - If the virtual table will output rows in the order specified by - the ORDER BY clause, then the orderByConsumed flag may be set to - true. If the output is not automatically in the correct order - then orderByConsumed must be left in its default false setting. - This will indicate to the SQLite core that it will need to do a - separate sorting pass over the data after it comes out of the virtual table. - - - The estimatedCost field should be set to the estimated number - of disk access operations required to execute this query against - the virtual table. The SQLite core will often call xBestIndex - multiple times with different constraints, obtain multiple cost - estimates, then choose the query plan that gives the lowest estimate. - The SQLite core initializes estimatedCost to a very large value - prior to invoking xBestIndex, so if xBestIndex determines that the - current combination of parameters is undesirable, it can leave the - estimatedCost field unchanged to discourage its use. - - - If the current version of SQLite is 3.8.2 or greater, the estimatedRows - field may be set to an estimate of the number of rows returned by the - proposed query plan. If this value is not explicitly set, the default - estimate of 25 rows is used. - - - If the current version of SQLite is 3.9.0 or greater, the idxFlags field - may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table - will return only zero or one rows given the input constraints. Additional - bits of the idxFlags field might be understood in later versions of SQLite. - - - The aConstraintUsage[] array contains one element for each of - the nConstraint constraints in the inputs section of the - sqlite3_index_info structure. - The aConstraintUsage[] array is used by xBestIndex to tell the - core how it is using the constraints. - - - The xBestIndex method may set aConstraintUsage[].argvIndex - entries to values greater than zero. - Exactly one entry should be set to 1, another to 2, another to 3, - and so forth up to as many or as few as the xBestIndex method wants. - The EXPR of the corresponding constraints will then be passed - in as the argv[] parameters to xFilter. - - - For example, if the aConstraint[3].argvIndex is set to 1, then - when xFilter is called, the argv[0] passed to xFilter will have - the EXPR value of the aConstraint[3] constraint. - - - By default, the SQLite core double checks all constraints on - each row of the virtual table that it receives. If such a check - is redundant, the xBestFilter method can suppress that double-check by - setting aConstraintUsage[].omit. - - - The xBestIndex method should return SQLITE_OK on success. If any - kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM) - should be returned instead. - - - If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an - error. Rather, SQLITE_CONSTRAINT indicates that the particular combination - of input parameters specified should not be used in the query plan. - The SQLITE_CONSTRAINT return is useful for table-valued functions that - have required parameters. If the aConstraint[].usable field is false - for one of the required parameter, then the xBestIndex method should - return SQLITE_CONSTRAINT. - - - The following example will better illustrate the use of SQLITE_CONSTRAINT - as a return value from xBestIndex: - - - SELECT * FROM realtab, tablevaluedfunc(realtab.x); - - - Assuming that the first hidden column of "tablevaluedfunc" is "param1", - the query above is semantically equivalent to this: - - - SELECT * FROM realtab, tablevaluedfunc - WHERE tablevaluedfunc.param1 = realtab.x; - - - The query planner must decide between many possible implementations - of this query, but two plans in particular are of note: - - ]]> - ]]>Scan all - rows of realtab and for each row, find rows in tablevaluedfunc where - param1 is equal to realtab.x - ]]>]]>Scan all rows of tablevalued func and for each row find rows - in realtab where x is equal to tablevaluedfunc.param1. - ]]>]]> - - The xBestIndex method will be invoked once for each of the potential - plans above. For plan 1, the aConstraint[].usable flag for for the - SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because - the right-hand side value for the "param1 = ?" constraint will be known, - since it is determined by the outer realtab loop. - But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false - because the right-hand side value is determined by an inner loop and is thus - an unknown quantity. Because param1 is a required input to the table-valued - functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented - with plan 2, indicating that a required input is missing. This forces the - query planner to select plan 1. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_index_info structure. - - - A standard SQLite return code. - - - - - - int (*xDisconnect)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table. - Only the sqlite3_vtab object is destroyed. - The virtual table is not destroyed and any backing store - associated with the virtual table persists. - - This method undoes the work of xConnect. - - This method is a destructor for a connection to the virtual table. - Contrast this method with xDestroy. The xDestroy is a destructor - for the entire virtual table. - - - The xDisconnect method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xDestroy)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table, just like - the xDisconnect method, and it also destroys the underlying - table implementation. This method undoes the work of xCreate. - - - The xDisconnect method is called whenever a database connection - that uses a virtual table is closed. The xDestroy method is only - called when a DROP TABLE statement is executed against the virtual table. - - - The xDestroy method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); - - - The xOpen method creates a new cursor used for accessing (read and/or - writing) a virtual table. A successful invocation of this method - will allocate the memory for the sqlite3_vtab_cursor (or a subclass), - initialize the new object, and make *ppCursor point to the new object. - The successful call then returns SQLITE_OK. - - - For every successful call to this method, the SQLite core will - later invoke the xClose method to destroy - the allocated cursor. - - - The xOpen method need not initialize the pVtab field of the - sqlite3_vtab_cursor structure. The SQLite core will take care - of that chore automatically. - - - A virtual table implementation must be able to support an arbitrary - number of simultaneously open cursors. - - - When initially opened, the cursor is in an undefined state. - The SQLite core will invoke the xFilter method - on the cursor prior to any attempt to position or read from the cursor. - - - The xOpen method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xClose)(sqlite3_vtab_cursor*); - - - The xClose method closes a cursor previously opened by - xOpen. - The SQLite core will always call xClose once for each cursor opened - using xOpen. - - - This method must release all resources allocated by the - corresponding xOpen call. The routine will not be called again even if it - returns an error. The SQLite core will not use the - sqlite3_vtab_cursor again after it has been closed. - - - The xClose method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, - int argc, sqlite3_value **argv); - - - This method begins a search of a virtual table. - The first argument is a cursor opened by xOpen. - The next two arguments define a particular search index previously - chosen by xBestIndex. The specific meanings of idxNum and idxStr - are unimportant as long as xFilter and xBestIndex agree on what - that meaning is. - - - The xBestIndex function may have requested the values of - certain expressions using the aConstraintUsage[].argvIndex values - of the sqlite3_index_info structure. - Those values are passed to xFilter using the argc and argv parameters. - - - If the virtual table contains one or more rows that match the - search criteria, then the cursor must be left point at the first row. - Subsequent calls to xEof must return false (zero). - If there are no rows match, then the cursor must be left in a state - that will cause the xEof to return true (non-zero). - The SQLite engine will use - the xColumn and xRowid methods to access that row content. - The xNext method will be used to advance to the next row. - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xFilter method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Number used to help identify the selected index. - - - The native pointer to the UTF-8 encoded string containing the - string used to help identify the selected index. - - - The number of native pointers to sqlite3_value structures specified - in . - - - An array of native pointers to sqlite3_value structures containing - filtering criteria for the selected index. - - - A standard SQLite return code. - - - - - - int (*xNext)(sqlite3_vtab_cursor*); - - - The xNext method advances a virtual table cursor - to the next row of a result set initiated by xFilter. - If the cursor is already pointing at the last row when this - routine is called, then the cursor no longer points to valid - data and a subsequent call to the xEof method must return true (non-zero). - If the cursor is successfully advanced to another row of content, then - subsequent calls to xEof must return false (zero). - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xNext method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xEof)(sqlite3_vtab_cursor*); - - - The xEof method must return false (zero) if the specified cursor - currently points to a valid row of data, or true (non-zero) otherwise. - This method is called by the SQL engine immediately after each - xFilter and xNext invocation. - - - The xEof method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Non-zero if no more rows are available; zero otherwise. - - - - - - int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N); - - - The SQLite core invokes this method in order to find the value for - the N-th column of the current row. N is zero-based so the first column - is numbered 0. - The xColumn method may return its result back to SQLite using one of the - following interface: - - - ]]> - ]]> sqlite3_result_blob() - ]]>]]> sqlite3_result_double() - ]]>]]> sqlite3_result_int() - ]]>]]> sqlite3_result_int64() - ]]>]]> sqlite3_result_null() - ]]>]]> sqlite3_result_text() - ]]>]]> sqlite3_result_text16() - ]]>]]> sqlite3_result_text16le() - ]]>]]> sqlite3_result_text16be() - ]]>]]> sqlite3_result_zeroblob() - ]]>]]> - - - If the xColumn method implementation calls none of the functions above, - then the value of the column defaults to an SQL NULL. - - - To raise an error, the xColumn method should use one of the result_text() - methods to set the error message text, then return an appropriate - error code. The xColumn method must return SQLITE_OK on success. - - - The xColumn method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_context structure to be used - for returning the specified column value to the SQLite core - library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - - int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid); - - - A successful invocation of this method will cause *pRowid to be - filled with the rowid of row that the - virtual table cursor pCur is currently pointing at. - This method returns SQLITE_OK on success. - It returns an appropriate error code on failure. - - - The xRowid method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - - int (*xUpdate)( - sqlite3_vtab *pVTab, - int argc, - sqlite3_value **argv, - sqlite_int64 *pRowid - ); - - - All changes to a virtual table are made using the xUpdate method. - This one method can be used to insert, delete, or update. - - - The argc parameter specifies the number of entries in the argv array. - The value of argc will be 1 for a pure delete operation or N+2 for an insert - or replace or update where N is the number of columns in the table. - In the previous sentence, N includes any hidden columns. - - - Every argv entry will have a non-NULL value in C but may contain the - SQL value NULL. In other words, it is always true that - ]]>argv[i]!=0]]> for ]]>i]]> between 0 and ]]>argc-1]]>. - However, it might be the case that - ]]>sqlite3_value_type(argv[i])==SQLITE_NULL]]>. - - - The argv[0] parameter is the rowid of a row in the virtual table - to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. - - - The argv[1] parameter is the rowid of a new row to be inserted - into the virtual table. If argv[1] is an SQL NULL, then the implementation - must choose a rowid for the newly inserted row. Subsequent argv[] - entries contain values of the columns of the virtual table, in the - order that the columns were declared. The number of columns will - match the table declaration that the xConnect or xCreate method made - using the sqlite3_declare_vtab() call. All hidden columns are included. - - - When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL), - on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table), - the implementation must set *pRowid to the rowid of the newly inserted row; - this will become the value returned by the sqlite3_last_insert_rowid() - function. Setting this value in all the other cases is a harmless no-op; - the SQLite engine ignores the *pRowid return value if argc==1 or - argv[1] is not an SQL NULL. - - - Each call to xUpdate will fall into one of cases shown below. - Not that references to ]]>argv[i]]]> mean the SQL value - held within the argv[i] object, not the argv[i] - object itself. - - - ]]> - ]]>]]>argc = 1 ]]> argv[0] ≠ NULL]]> - ]]>]]> - DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted. - No insert occurs. - ]]>]]>]]>argc > 1 ]]> argv[0] = NULL]]> - ]]>]]> - INSERT: A new row is inserted with column values taken from - argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL, - then a new unique rowid is generated automatically. The argv[1] will be NULL - for a WITHOUT ROWID virtual table, in which case the implementation should - take the PRIMARY KEY value from the appropriate column in argv[2] and following. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] = argv[1]]]> - ]]>]]> - UPDATE: - The row with rowid or PRIMARY KEY argv[0] is updated with new values - in argv[2] and following parameters. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] ≠ argv[1]]]> - ]]>]]> - UPDATE with rowid or PRIMARY KEY change: - The row with rowid or PRIMARY KEY argv[0] is updated with - the rowid or PRIMARY KEY in argv[1] - and new values in argv[2] and following parameters. This will occur - when an SQL statement updates a rowid, as in the statement: - - UPDATE table SET rowid=rowid+1 WHERE ...; - - ]]>]]> - - - The xUpdate method must return SQLITE_OK if and only if it is - successful. If a failure occurs, the xUpdate must return an appropriate - error code. On a failure, the pVTab->zErrMsg element may optionally - be replaced with error message text stored in memory allocated from SQLite - using functions such as sqlite3_mprintf() or sqlite3_malloc(). - - - If the xUpdate method violates some constraint of the virtual table - (including, but not limited to, attempting to store a value of the wrong - datatype, attempting to store a value that is too - large or too small, or attempting to change a read-only value) then the - xUpdate must fail with an appropriate error code. - - - If the xUpdate method is performing an UPDATE, then - sqlite3_value_nochange(X) can be used to discover which columns - of the virtual table were actually modified by the UPDATE - statement. The sqlite3_value_nochange(X) interface returns - true for columns that do not change. - On every UPDATE, SQLite will first invoke - xColumn separately for each unchanging column in the table to - obtain the value for that column. The xColumn method can - check to see if the column is unchanged at the SQL level - by invoking sqlite3_vtab_nochange(). If xColumn sees that - the column is not being modified, it should return without setting - a result using one of the sqlite3_result_xxxxx() - interfaces. Only in that case sqlite3_value_nochange() will be - true within the xUpdate method. If xColumn does - invoke one or more sqlite3_result_xxxxx() - interfaces, then SQLite understands that as a change in the value - of the column and the sqlite3_value_nochange() call for that - column within xUpdate will return false. - - - There might be one or more sqlite3_vtab_cursor objects open and in use - on the virtual table instance and perhaps even on the row of the virtual - table when the xUpdate method is invoked. The implementation of - xUpdate must be prepared for attempts to delete or modify rows of the table - out from other existing cursors. If the virtual table cannot accommodate - such changes, the xUpdate method must return an error code. - - - The xUpdate method is optional. - If the xUpdate pointer in the sqlite3_module for a virtual table - is a NULL pointer, then the virtual table is read-only. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of new or modified column values contained in - . - - - The array of native pointers to sqlite3_value structures containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - - int (*xBegin)(sqlite3_vtab *pVTab); - - - This method begins a transaction on a virtual table. - This is method is optional. The xBegin pointer of sqlite3_module - may be NULL. - - - This method is always followed by one call to either the - xCommit or xRollback method. Virtual table transactions do - not nest, so the xBegin method will not be invoked more than once - on a single virtual table - without an intervening call to either xCommit or xRollback. - Multiple calls to other methods can and likely will occur in between - the xBegin and the corresponding xCommit or xRollback. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xSync)(sqlite3_vtab *pVTab); - - - This method signals the start of a two-phase commit on a virtual - table. - This is method is optional. The xSync pointer of sqlite3_module - may be NULL. - - - This method is only invoked after call to the xBegin method and - prior to an xCommit or xRollback. In order to implement two-phase - commit, the xSync method on all virtual tables is invoked prior to - invoking the xCommit method on any virtual table. If any of the - xSync methods fail, the entire transaction is rolled back. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xCommit)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to commit. - This is method is optional. The xCommit pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin and - xSync. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xRollback)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to rollback. - This is method is optional. The xRollback pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xFindFunction)( - sqlite3_vtab *pVtab, - int nArg, - const char *zName, - void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), - void **ppArg - ); - - - This method is called during sqlite3_prepare() to give the virtual - table implementation an opportunity to overload functions. - This method may be set to NULL in which case no overloading occurs. - - - When a function uses a column from a virtual table as its first - argument, this method is called to see if the virtual table would - like to overload the function. The first three parameters are inputs: - the virtual table, the number of arguments to the function, and the - name of the function. If no overloading is desired, this method - returns 0. To overload the function, this method writes the new - function implementation into *pxFunc and writes user data into *ppArg - and returns either 1 or a number between - SQLITE_INDEX_CONSTRAINT_FUNCTION and 255. - - - Historically, the return value from xFindFunction() was either zero - or one. Zero means that the function is not overloaded and one means that - it is overload. The ability to return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in - version 3.25.0 (2018-09-15). If xFindFunction returns - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function - takes two arguments and the function - can be used as a boolean in the WHERE clause of a query and that - the virtual table is able to exploit that function to speed up the query - result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, the value returned becomes the sqlite3_index_info.aConstraint.op - value for one of the constraints passed into xBestIndex() and the second - argument becomes the value corresponding to that constraint that is passed - to xFilter(). This enables the - xBestIndex()/xFilter implementations to use the function to speed - its search. - - - The technique of having xFindFunction() return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation - of the Geopoly module. The xFindFunction() method of that module returns - SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function - and it returns - SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function. - This permits search optimizations for queries such as: - - - SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon); - - - Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse - the order of their arguments. So "like(A,B)" is equivalent to "B like A". - For the form "B like A" the B term is considered the first argument - to the function. But for "like(A,B)" the A term is considered the - first argument. - - - The function pointer returned by this routine must be valid for - the lifetime of the sqlite3_vtab object given in the first parameter. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - delegate responsible for implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - - int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); - - - This method provides notification that the virtual table implementation - that the virtual table will be given a new name. - If this method returns SQLITE_OK then SQLite renames the table. - If this method returns an error code then the renaming is prevented. - - - The xRename method is optional. If omitted, then the virtual - table may not be renamed using the ALTER TABLE RENAME command. - - - The PRAGMA legacy_alter_table setting is enabled prior to invoking this - method, and the value for legacy_alter_table is restored after this - method finishes. This is necessary for the correct operation of virtual - tables that make use of shadow tables where the shadow tables must be - renamed to match the new virtual table name. If the legacy_alter_format is - off, then the xConnect method will be invoked for the virtual table every - time the xRename method tries to change the name of the shadow table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the UTF-8 encoded string containing the new - name for the virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - This class represents a context from the SQLite core library that can - be passed to the sqlite3_result_*() and associated functions. - - - - - This interface represents a native handle provided by the SQLite core - library. - - - - - The native handle value. - - - - - The native context handle. - - - - - Constructs an instance of this class using the specified native - context handle. - - - The native context handle to use. - - - - - Sets the context result to NULL. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. This value will be - converted to the UTF-8 encoding prior to being used. - - - - - Sets the context result to the specified - value containing an error message. - - - The value containing the error message text. - This value will be converted to the UTF-8 encoding prior to being - used. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to contain the error code SQLITE_TOOBIG. - - - - - Sets the context result to contain the error code SQLITE_NOMEM. - - - - - Sets the context result to the specified array - value. - - - The array value to use. - - - - - Sets the context result to a BLOB of zeros of the specified size. - - - The number of zero bytes to use for the BLOB context result. - - - - - Sets the context result to the specified . - - - The to use. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This class represents a value from the SQLite core library that can be - passed to the sqlite3_value_*() and associated functions. - - - - - The native value handle. - - - - - Constructs an instance of this class using the specified native - value handle. - - - The native value handle to use. - - - - - Invalidates the native value handle, thereby preventing further - access to it from this object instance. - - - - - Converts a native pointer to a native sqlite3_value structure into - a managed object instance. - - - The native pointer to a native sqlite3_value structure to convert. - - - The managed object instance or null upon - failure. - - - - - Converts a logical array of native pointers to native sqlite3_value - structures into a managed array of - object instances. - - - The number of elements in the logical array of native sqlite3_value - structures. - - - The native pointer to the logical array of native sqlite3_value - structures to convert. - - - The managed array of object instances or - null upon failure. - - - - - Gets and returns the type affinity associated with this value. - - - The type affinity associated with this value. - - - - - Gets and returns the number of bytes associated with this value, if - it refers to a UTF-8 encoded string. - - - The number of bytes associated with this value. The returned value - may be zero. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with - this value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. The value is - converted from the UTF-8 encoding prior to being returned. - - - - - Gets and returns the array associated with this - value. - - - The array associated with this value. - - - - - Gets and returns an instance associated with - this value. - - - The associated with this value. If the type - affinity of the object is unknown or cannot be determined, a null - value will be returned. - - - - - Uses the native value handle to obtain and store the managed value - for this object instance, thus saving it for later use. The type - of the managed value is determined by the type affinity of the - native value. If the type affinity is not recognized by this - method, no work is done and false is returned. - - - Non-zero if the native value was persisted successfully. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Returns non-zero if the native SQLite value has been successfully - persisted as a managed value within this object instance (i.e. the - property may then be read successfully). - - - - - If the managed value for this object instance is available (i.e. it - has been previously persisted via the ) method, - that value is returned; otherwise, an exception is thrown. The - returned value may be null. - - - - - These are the allowed values for the operators that are part of a - constraint term in the WHERE clause of a query that uses a virtual - table. - - - - - This value represents the equality operator. - - - - - This value represents the greater than operator. - - - - - This value represents the less than or equal to operator. - - - - - This value represents the less than operator. - - - - - This value represents the greater than or equal to operator. - - - - - This value represents the MATCH operator. - - - - - This value represents the LIKE operator. - - - - - This value represents the GLOB operator. - - - - - This value represents the REGEXP operator. - - - - - This value represents the inequality operator. - - - - - This value represents the IS NOT operator. - - - - - This value represents the IS NOT NULL operator. - - - - - This value represents the IS NULL operator. - - - - - This value represents the IS operator. - - - - - These are the allowed values for the index flags from the - method. - - - - - No special handling. This is the default. - - - - - This value indicates that the scan of the index will visit at - most one row. - - - - - This class represents the native sqlite3_index_constraint structure - from the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint structure. - - - The native sqlite3_index_constraint structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column on left-hand side of constraint. - - - Constraint operator (). - - - True if this constraint is usable. - - - Used internally - - should ignore. - - - - - Column on left-hand side of constraint. - - - - - Constraint operator (). - - - - - True if this constraint is usable. - - - - - Used internally - - should ignore. - - - - - This class represents the native sqlite3_index_orderby structure from - the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_orderby structure. - - - The native sqlite3_index_orderby structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column number. - - - True for DESC. False for ASC. - - - - - Column number. - - - - - True for DESC. False for ASC. - - - - - This class represents the native sqlite3_index_constraint_usage - structure from the SQLite core library. - - - - - Constructs a default instance of this class. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint_usage structure. - - - The native sqlite3_index_constraint_usage structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - If greater than 0, constraint is part of argv to xFilter. - - - Do not code a test for this constraint. - - - - - If greater than 0, constraint is part of argv to xFilter. - - - - - Do not code a test for this constraint. - - - - - This class represents the various inputs provided by the SQLite core - library to the method. - - - - - Constructs an instance of this class. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - This class represents the various outputs provided to the SQLite core - library by the method. - - - - - Constructs an instance of this class. - - - The number of instances - to pre-allocate space for. - - - - - Determines if the native estimatedRows field can be used, based on - the available version of the SQLite core library. - - - Non-zero if the property is supported - by the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - An array of object - instances, each containing information to be supplied to the SQLite - core library. - - - - - Number used to help identify the selected index. This value will - later be provided to the - method. - - - - - String used to help identify the selected index. This value will - later be provided to the - method. - - - - - Non-zero if the index string must be freed by the SQLite core - library. - - - - - True if output is already ordered. - - - - - Estimated cost of using this index. Using a null value here - indicates that a default estimated cost value should be used. - - - - - Estimated number of rows returned. Using a null value here - indicates that a default estimated rows value should be used. - This property has no effect if the SQLite core library is not at - least version 3.8.2. - - - - - The flags that should be used with this index. Using a null value - here indicates that a default flags value should be used. This - property has no effect if the SQLite core library is not at least - version 3.9.0. - - - - - - Indicates which columns of the virtual table may be required by the - current scan. Virtual table columns are numbered from zero in the - order in which they appear within the CREATE TABLE statement passed - to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), - the corresponding bit is set within the bit mask if the column may - be required by SQLite. If the table has at least 64 columns and - any column to the right of the first 63 is required, then bit 63 of - colUsed is also set. In other words, column iCol may be required - if the expression - - - (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) - - - evaluates to non-zero. Using a null value here indicates that a - default flags value should be used. This property has no effect if - the SQLite core library is not at least version 3.10.0. - - - - - - This class represents the various inputs and outputs used with the - method. - - - - - Constructs an instance of this class. - - - The number of (and - ) instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - Attempts to determine the structure sizes needed to create and - populate a native - - structure. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - - - Attempts to allocate and initialize a native - - structure. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - The newly allocated native - structure - -OR- if it could not be fully allocated. - - - - - Frees all the memory associated with a native - - structure. - - - The native pointer to the native sqlite3_index_info structure to - free. - - - - - Converts a native pointer to a native sqlite3_index_info structure - into a new object instance. - - - The native pointer to the native sqlite3_index_info structure to - convert. - - - Non-zero to include fields from the outputs portion of the native - structure; otherwise, the "output" fields will not be read. - - - Upon success, this parameter will be modified to contain the newly - created object instance. - - - - - Populates the outputs of a pre-allocated native sqlite3_index_info - structure using an existing object - instance. - - - The existing object instance containing - the output data to use. - - - The native pointer to the pre-allocated native sqlite3_index_info - structure. - - - Non-zero to include fields from the inputs portion of the native - structure; otherwise, the "input" fields will not be written. - - - - - The object instance containing - the inputs to the - method. - - - - - The object instance containing - the outputs from the - method. - - - - - This class represents a managed virtual table implementation. It is - not sealed and should be used as the base class for any user-defined - virtual table classes implemented in managed code. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the module implementing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the database containing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the virtual table. - - - - - Constructs an instance of this class. - - - The original array of strings provided to the - and - methods. - - - - - This method should normally be used by the - method in order to - perform index selection based on the constraints provided by the - SQLite core library. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - Non-zero upon success. - - - - - Attempts to record the renaming of the virtual table associated - with this object instance. - - - The new name for the virtual table. - - - Non-zero upon success. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - The original array of strings provided to the - and - methods. - - - - - The name of the module implementing this virtual table. - - - - - The name of the database containing this virtual table. - - - - - The name of the virtual table. - - - - - The object instance containing all the - data for the inputs and outputs relating to the most recent index - selection. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This class represents a managed virtual table cursor implementation. - It is not sealed and should be used as the base class for any - user-defined virtual table cursor classes implemented in managed code. - - - - - This value represents an invalid integer row sequence number. - - - - - The field holds the integer row sequence number for the current row - pointed to by this cursor object instance. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - - - Constructs an instance of this class. - - - - - Attempts to persist the specified object - instances in order to make them available after the - method returns. - - - The array of object instances to be - persisted. - - - The number of object instances that were - successfully persisted. - - - - - This method should normally be used by the - method in order to - perform filtering of the result rows and/or to record the filtering - criteria provided by the SQLite core library. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - - - Determines the integer row sequence number for the current row. - - - The integer row sequence number for the current row -OR- zero if - it cannot be determined. - - - - - Adjusts the integer row sequence number so that it refers to the - next row. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - The object instance associated - with this object instance. - - - - - Number used to help identify the selected index. This value will - be set via the method. - - - - - String used to help identify the selected index. This value will - be set via the method. - - - - - The values used to filter the rows returned via this cursor object - instance. This value will be set via the - method. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This interface represents a virtual table implementation written in - managed code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This class contains static methods that are used to allocate, - manipulate, and free native memory provided by the SQLite core library. - - - - - Determines if the native sqlite3_msize() API can be used, based on - the available version of the SQLite core library. - - - Non-zero if the native sqlite3_msize() API is supported by the - SQLite core library. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Frees a memory block previously obtained from the - or methods. If - the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts - the number of bytes currently allocated by this class. - - - The native pointer to the memory block previously obtained from the - or methods. - - - - - Frees a memory block previously obtained from the SQLite core - library without adjusting the number of allocated bytes currently - tracked by this class. This is useful when dealing with blocks of - memory that were not allocated using this class. - - - The native pointer to the memory block previously obtained from the - SQLite core library. - - - - - This class contains static methods that are used to deal with native - UTF-8 string pointers to be used with the SQLite core library. - - - - - This is the maximum possible length for the native UTF-8 encoded - strings used with the SQLite core library. - - - - - This is the object instance used to handle - conversions from/to UTF-8. - - - - - Converts the specified managed string into the UTF-8 encoding and - returns the array of bytes containing its representation in that - encoding. - - - The managed string to convert. - - - The array of bytes containing the representation of the managed - string in the UTF-8 encoding or null upon failure. - - - - - Converts the specified array of bytes representing a string in the - UTF-8 encoding and returns a managed string. - - - The array of bytes to convert. - - - The managed string or null upon failure. - - - - - Probes a native pointer to a string in the UTF-8 encoding for its - terminating NUL character, within the specified length limit. - - - The native NUL-terminated string pointer. - - - The maximum length of the native string, in bytes. - - - The length of the native string, in bytes -OR- zero if the length - could not be determined. - - - - - Converts the specified native NUL-terminated UTF-8 string pointer - into a managed string. - - - The native NUL-terminated UTF-8 string pointer. - - - The managed string or null upon failure. - - - - - Converts the specified native UTF-8 string pointer of the specified - length into a managed string. - - - The native UTF-8 string pointer. - - - The length of the native string, in bytes. - - - The managed string or null upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts a logical array of native NUL-terminated UTF-8 string - pointers into an array of managed strings. - - - The number of elements in the logical array of native - NUL-terminated UTF-8 string pointers. - - - The native pointer to the logical array of native NUL-terminated - UTF-8 string pointers to convert. - - - The array of managed strings or null upon failure. - - - - - Converts an array of managed strings into an array of native - NUL-terminated UTF-8 string pointers. - - - The array of managed strings to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The array of native NUL-terminated UTF-8 string pointers or null - upon failure. - - - - - This class contains static methods that are used to deal with native - pointers to memory blocks that logically contain arrays of bytes to be - used with the SQLite core library. - - - - - Converts a native pointer to a logical array of bytes of the - specified length into a managed byte array. - - - The native pointer to the logical array of bytes to convert. - - - The length, in bytes, of the logical array of bytes to convert. - - - The managed byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The native pointer to a logical byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The length, in bytes, of the converted logical array of bytes. - - - The native pointer to a logical byte array or null upon failure. - - - - - This class contains static methods that are used to perform several - low-level data marshalling tasks between native and managed code. - - - - - Returns a new object instance based on the - specified object instance and an integer - offset. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location that the new - object instance should point to. - - - The new object instance. - - - - - Rounds up an integer size to the next multiple of the alignment. - - - The size, in bytes, to be rounded up. - - - The required alignment for the return value. - - - The size, in bytes, rounded up to the next multiple of the - alignment. This value may end up being the same as the original - size. - - - - - Determines the offset, in bytes, of the next structure member. - - - The offset, in bytes, of the current structure member. - - - The size, in bytes, of the current structure member. - - - The alignment, in bytes, of the next structure member. - - - The offset, in bytes, of the next structure member. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - to be read is located. - - - The value at the specified memory location. - - - - - Reads an value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Generates a hash code value for the object. - - - The object instance used to calculate the hash code. - - - Non-zero if different object instances with the same value should - generate different hash codes, where applicable. This parameter - has no effect on the .NET Compact Framework. - - - The hash code value -OR- zero if the object is null. - - - - - This class represents a managed virtual table module implementation. - It is not sealed and must be used as the base class for any - user-defined virtual table module classes implemented in managed code. - - - - - The default version of the native sqlite3_module structure in use. - - - - - This field is used to store the native sqlite3_module structure - associated with this object instance. - - - - - This field is used to store the destructor delegate to be passed to - the SQLite core library via the sqlite3_create_disposable_module() - function. - - - - - This field is used to store a pointer to the native sqlite3_module - structure returned by the sqlite3_create_disposable_module - function. - - - - - This field is used to store the virtual table instances associated - with this module. The native pointer to the sqlite3_vtab derived - structure is used to key into this collection. - - - - - This field is used to store the virtual table cursor instances - associated with this module. The native pointer to the - sqlite3_vtab_cursor derived structure is used to key into this - collection. - - - - - This field is used to store the virtual table function instances - associated with this module. The case-insensitive function name - and the number of arguments (with -1 meaning "any") are used to - construct the string that is used to key into this collection. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Calls the native SQLite core library in order to create a new - disposable module containing the implementation of a virtual table. - - - The native database connection pointer to use. - - - Non-zero upon success. - - - - - This method is called by the SQLite core library when the native - module associated with this object instance is being destroyed due - to its parent connection being closed. It may also be called by - the "vtshim" module if/when the sqlite3_dispose_module() function - is called. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - - - Creates and returns the native sqlite_module structure using the - configured (or default) - interface implementation. - - - The native sqlite_module structure using the configured (or - default) interface - implementation. - - - - - Creates and returns the native sqlite_module structure using the - specified interface - implementation. - - - The interface implementation to - use. - - - The native sqlite_module structure using the specified - interface implementation. - - - - - Creates a copy of the specified - object instance, - using default implementations for the contained delegates when - necessary. - - - The object - instance to copy. - - - The new object - instance. - - - - - Calls one of the virtual table initialization methods. - - - Non-zero to call the - method; otherwise, the - method will be called. - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - Calls one of the virtual table finalization methods. - - - Non-zero to call the - method; otherwise, the - method will be - called. - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - used to get the native pointer to the sqlite3_vtab derived - structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Gets and returns the interface - implementation to be used when creating the native sqlite3_module - structure. Derived classes may override this method to supply an - alternate implementation for the - interface. - - - The interface implementation to - be used when populating the native sqlite3_module structure. If - the returned value is null, the private methods provided by the - class and relating to the - interface will be used to - create the necessary delegates. - - - - - Creates and returns the - interface implementation corresponding to the current - object instance. - - - The interface implementation - corresponding to the current object - instance. - - - - - Allocates a native sqlite3_vtab derived structure and returns a - native pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Zeros out the fields of a native sqlite3_vtab derived structure. - - - The native pointer to the native sqlite3_vtab derived structure to - zero. - - - - - Frees a native sqlite3_vtab structure using the provided native - pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Allocates a native sqlite3_vtab_cursor derived structure and - returns a native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Frees a native sqlite3_vtab_cursor structure using the provided - native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Looks up and returns the object - instance based on the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The object instance or null if - the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab derived - structure and creates an association between it and the specified - object instance. - - - The object instance to be used - when creating the association. - - - The native pointer to a sqlite3_vtab derived structure or - if the method fails for any reason. - - - - - Looks up and returns the - object instance based on the native pointer to the - sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The object instance or null - if the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab_cursor - derived structure and creates an association between it and the - specified object instance. - - - The object instance to be - used when creating the association. - - - The native pointer to a sqlite3_vtab_cursor derived structure or - if the method fails for any reason. - - - - - Deterimines the key that should be used to identify and store the - object instance for the virtual table - (i.e. to be returned via the - method). - - - The number of arguments to the virtual table function. - - - The name of the virtual table function. - - - The object instance associated with - this virtual table function. - - - The string that should be used to identify and store the virtual - table function instance. This method cannot return null. If null - is returned from this method, the behavior is undefined. - - - - - Attempts to declare the schema for the virtual table using the - specified database connection. - - - The object instance to use when - declaring the schema of the virtual table. This parameter may not - be null. - - - The string containing the CREATE TABLE statement that completely - describes the schema for the virtual table. This parameter may not - be null. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual - table function in response to a call into the - - or virtual table - methods. - - - The object instance to use when - declaring the schema of the virtual table. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon - failure, it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated cost. - - - The object instance to modify. - - - The estimated cost value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated cost. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated rows. - - - The object instance to modify. - - - The estimated rows value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated rows. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified flags. - - - The object instance to modify. - - - The index flags value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default index flags. - - - The object instance to modify. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - the method, - the method, - the method, - and the method should be logged using the - class. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - method, and the - method should be logged using the - class. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This class implements the - interface by forwarding those method calls to the - object instance it contains. If the - contained object instance is null, all - the methods simply generate an - error. - - - - - This is the value that is always used for the "logErrors" - parameter to the various static error handling methods provided - by the class. - - - - - This is the value that is always used for the "logExceptions" - parameter to the various static error handling methods provided - by the class. - - - - - This is the error message text used when the contained - object instance is not available - for any reason. - - - - - The object instance used to provide - an implementation of the - interface. - - - - - Constructs an instance of this class. - - - The object instance used to provide - an implementation of the - interface. - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab derived structure. - - - The value of . - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab_cursor derived - structure. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - This class contains some virtual methods that may be useful for other - virtual table classes. It specifically does NOT implement any of the - interface methods. - - - - - This class implements a virtual table module that does nothing by - providing "empty" implementations for all of the - interface methods. The result - codes returned by these "empty" method implementations may be - controlled on a per-method basis by using and/or overriding the - , - , - , - , and - methods from within derived classes. - - - - - This field is used to store the - values to return, on a per-method basis, for all methods that are - part of the interface. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Determines the default value to be - returned by methods of the - interface that lack an overridden implementation in all classes - derived from the class. - - - The value that should be returned - by all interface methods unless - a more specific result code has been set for that interface method. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Determines the value that should be - returned by the specified - interface method if it lack an overridden implementation. If no - specific value is available (or set) - for the specified method, the value - returned by the method will be - returned instead. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - - - Sets the value that should be - returned by the specified - interface method if it lack an overridden implementation. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - The CREATE TABLE statement used to declare the schema for the - virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Determines the SQL statement used to declare the virtual table. - This method should be overridden in derived classes if they require - a custom virtual table schema. - - - The SQL statement used to declare the virtual table -OR- null if it - cannot be determined. - - - - - Sets the table error message to one that indicates the virtual - table cursor is of the wrong type. - - - The object instance. - - - The that the virtual table cursor should be. - - - The value of . - - - - - Determines the string to return as the column value for the object - instance value. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a string representation for. - - - The string representation of the specified object instance or null - upon failure. - - - - - Constructs an unique row identifier from two - values. The first value - must contain the row sequence number for the current row and the - second value must contain the hash code of the key column value - for the current row. - - - The integer row sequence number for the current row. - - - The hash code of the key column value for the current row. - - - The unique row identifier or zero upon failure. - - - - - Determines the unique row identifier for the current row. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a unique row identifier for. - - - The unique row identifier or zero upon failure. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this cursor - was created. - - - - - This value will be non-zero if false has been returned from the - method. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Advances to the next row of the virtual table cursor using the - method of the - object instance. - - - Non-zero if the current row is valid; zero otherwise. If zero is - returned, no further rows are available. - - - - - Resets the virtual table cursor position, also invalidating the - current row, using the method of - the object instance. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if the virtual - table cursor has been closed. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - Returns non-zero if the end of the virtual table cursor has been - seen (i.e. no more rows are available, including the current one). - - - - - Returns non-zero if the virtual table cursor is open. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. The following short - example shows it being used to treat an array of strings as a table - data source: - - public static class Sample - { - public static void Main() - { - using (SQLiteConnection connection = new SQLiteConnection( - "Data Source=:memory:;")) - { - connection.Open(); - - connection.CreateModule(new SQLiteModuleEnumerable( - "sampleModule", new string[] { "one", "two", "three" })); - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = - "CREATE VIRTUAL TABLE t1 USING sampleModule;"; - - command.ExecuteNonQuery(); - } - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = "SELECT * FROM t1;"; - - using (SQLiteDataReader dataReader = command.ExecuteReader()) - { - while (dataReader.Read()) - Console.WriteLine(dataReader[0].ToString()); - } - } - - connection.Close(); - } - } - } - - - - - - The instance containing the backing data - for the virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Sets the table error message to one that indicates the virtual - table cursor has no current row. - - - The object instance. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this - cursor was created. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. - - - - - The instance containing the backing - data for the virtual table. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This enumerated type represents a type of conflict seen when apply - changes from a change set or patch set. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is present in the - database, but one or more other (non primary-key) fields modified - by the update do not contain the expected "before" values. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is not present in the - database. There is no conflicting row in this case. - - The results of invoking the - - method are undefined. - - - - - This value is seen when processing an INSERT change if the - operation would result in duplicate primary key values. - The conflicting row in this case is the database row with the - matching primary key. - - - - - If a non-foreign key constraint violation occurs while applying a - change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict - callback will see this value. - - There is no conflicting row in this case. The results of invoking - the - method are undefined. - - - - - If foreign key handling is enabled, and applying a changes leaves - the database in a state containing foreign key violations, this - value will be seen exactly once before the changes are committed. - If the conflict handler - , the changes, - including those that caused the foreign key constraint violation, - are committed. Or, if it returns - , the changes are - rolled back. - - No current or conflicting row information is provided. The only - method it is possible to call on the supplied - object is - . - - - - - This enumerated type represents the result of a user-defined conflict - resolution callback. - - - - - If a conflict callback returns this value no special action is - taken. The change that caused the conflict is not applied. The - application of changes continues with the next change. - - - - - This value may only be returned from a conflict callback if the - type of conflict was - or . If this is - not the case, any changes applied so far are rolled back and the - call to - - will raise a with an error code of - . - - If this value is returned for a - conflict, then the - conflicting row is either updated or deleted, depending on the type - of change. - - If this value is returned for a - conflict, then - the conflicting row is removed from the database and a second - attempt to apply the change is made. If this second attempt fails, - the original row is restored to the database before continuing. - - - - - If this value is returned, any changes applied so far are rolled - back and the call to - - will raise a with an error code of - . - - - - - This enumerated type represents possible flags that may be passed - to the appropriate overloads of various change set creation methods. - - - - - No special handling. - - - - - Invert the change set while iterating through it. - This is equivalent to inverting a change set using - before - applying it. It is an error to specify this flag - with a patch set. - - - - - This callback is invoked when a determination must be made about - whether changes to a specific table should be tracked -OR- applied. - It will not be called for tables that are already attached to a - . - - - The optional application-defined context data that was originally - passed to the or - - methods. This value may be null. - - - The name of the table. - - - Non-zero if changes to the table should be considered; otherwise, - zero. Throwing an exception from this callback will result in - undefined behavior. - - - - - This callback is invoked when there is a conflict while apply changes - to a database. - - - The optional application-defined context data that was originally - passed to the - - method. This value may be null. - - - The type of this conflict. - - - The object associated with - this conflict. This value may not be null; however, only properties - that are applicable to the conflict type will be available. Further - information on this is available within the descriptions of the - available values. - - - A value that indicates the - action to be taken in order to resolve the conflict. Throwing an - exception from this callback will result in undefined behavior. - - - - - This interface contains methods used to manipulate a set of changes for - a database. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - This interface contains methods used to manipulate multiple sets of - changes for a database. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - This interface contains properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - The name of the table the change was made to. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - - - - This interface contains methods to query and manipulate the state of a - change tracking session for a database. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - This class contains some static helper methods for use within this - subsystem. - - - - - This method checks the byte array specified by the caller to make - sure it will be usable. - - - A byte array provided by the caller into one of the public methods - for the classes that belong to this subsystem. This value cannot - be null or represent an empty array; otherwise, an appropriate - exception will be thrown. - - - - - This class is used to hold the native connection handle associated with - a open until this subsystem is totally - done with it. This class is for internal use by this subsystem only. - - - - - The SQL statement used when creating the native statement handle. - There are no special requirements for this other than counting as - an "open statement handle". - - - - - The format of the error message used when reporting, during object - disposal, that the statement handle is still open (i.e. because - this situation is considered a fairly serious programming error). - - - - - The wrapped native connection handle associated with this lock. - - - - - The flags associated with the connection represented by the - value. - - - - - The native statement handle for this lock. The garbage collector - cannot cause this statement to be finalized; therefore, it will - serve to hold the associated native connection open until it is - freed manually using the method. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - lock. - - - The flags associated with the connection represented by the - value. - - - Non-zero if the method should be called prior - to returning from this constructor. - - - - - Queries and returns the wrapped native connection handle for this - instance. - - - The wrapped native connection handle for this instance -OR- null - if it is unavailable. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Queries and returns the native connection handle for this instance. - - - The native connection handle for this instance. If this value is - unavailable or invalid an exception will be thrown. - - - - - This method attempts to "lock" the associated native connection - handle by preparing a SQL statement that will not be finalized - until the method is called (i.e. and which - cannot be done by the garbage collector). If the statement is - already prepared, nothing is done. If the statement cannot be - prepared for any reason, an exception will be thrown. - - - - - This method attempts to "unlock" the associated native connection - handle by finalizing the previously prepared statement. If the - statement is already finalized, nothing is done. If the statement - cannot be finalized for any reason, an exception will be thrown. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator. It is used as the - base class for the and - classes. It knows how to - advance the native iterator handle as well as finalize it. - - - - - The native change set (a.k.a. iterator) handle. - - - - - Non-zero if this instance owns the native iterator handle in the - field. In that case, this instance will - finalize the native iterator handle upon being disposed or - finalized. - - - - - Constructs a new instance of this class using the specified native - iterator handle. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Throws an exception if the native iterator handle is invalid. - - - - - Used to query the native iterator handle. This method is only used - by the class. - - - The native iterator handle -OR- if it - is not available. - - - - - Attempts to advance the native iterator handle to its next item. - - - Non-zero if the native iterator handle was advanced and contains - more data; otherwise, zero. If the underlying native API returns - an unexpected value then an exception will be thrown. - - - - - Attempts to create an instance of this class that is associated - with the specified native iterator handle. Ownership of the - native iterator handle is NOT transferred to the new instance of - this class. - - - The native iterator handle to use. - - - The new instance of this class. No return value is reserved to - indicate an error; however, if the native iterator handle is not - valid, any subsequent attempt to make use of it via the returned - instance of this class may throw exceptions. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator for a set of changes - contained entirely in memory. - - - - - The native memory buffer allocated to contain the set of changes - associated with this instance. This will always be freed when this - instance is disposed or finalized. - - - - - Constructs an instance of this class using the specified native - memory buffer and native iterator handle. - - - The native memory buffer to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class manages the native change set iterator for a set of changes - backed by a instance. - - - - - The instance that is managing - the underlying used as the backing store for - the set of changes associated with this native change set iterator. - - - - - Constructs an instance of this class using the specified native - iterator handle and . - - - The instance to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class is used to act as a bridge between a - instance and the delegates used with the native streaming API. - - - - - The managed stream instance used to in order to service the native - delegates for both input and output. - - - - - The flags associated with the connection. - - - - - The delegate used to provide input to the native streaming API. - It will be null -OR- point to the method. - - - - - The delegate used to provide output to the native streaming API. - It will be null -OR- point to the method. - - - - - Constructs a new instance of this class using the specified managed - stream and connection flags. - - - The managed stream instance to be used in order to service the - native delegates for both input and output. - - - The flags associated with the parent connection. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - This method attempts to read bytes from - the managed stream, writing them to the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer to receive the requested input bytes. - It must be at least bytes in size. - - - Upon entry, the number of bytes to read. Upon exit, the number of - bytes actually read. This value may be zero upon exit. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - This method attempts to write bytes to - the managed stream, reading them from the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer containing the requested output - bytes. It must be at least bytes in - size. - - - The number of bytes to write. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages a collection of - instances. When used, it takes responsibility for creating, returning, - and disposing of its instances. - - - - - The managed collection of - instances, keyed by their associated - instance. - - - - - The flags associated with the connection. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Makes sure the collection of - is created. - - - - - Makes sure the collection of - is disposed. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents a group of change sets (or patch sets). - - - - - The instance associated - with this change group. - - - - - The flags associated with the connection. - - - - - The native handle for this change group. This will be deleted when - this instance is disposed or finalized. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Throws an exception if the native change group handle is invalid. - - - - - Makes sure the native change group handle is valid, creating it if - necessary. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents the change tracking session associated with a - database. - - - - - The instance associated - with this session. - - - - - The name of the database (e.g. "main") for this session. - - - - - The native handle for this session. This will be deleted when - this instance is disposed or finalized. - - - - - The delegate used to provide table filtering to the native API. - It will be null -OR- point to the method. - - - - - The managed callback used to filter tables for this session. Set - via the method. - - - - - The optional application-defined context data that was passed to - the method. This value may be null. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - session. - - - The flags associated with the connection represented by the - value. - - - The name of the database (e.g. "main") for this session. - - - - - Throws an exception if the native session handle is invalid. - - - - - Makes sure the native session handle is valid, creating it if - necessary. - - - - - This method sets up the internal table filtering associated state - of this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - The native - delegate -OR- null to clear any existing table filter. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - This method is called when determining if a table needs to be - included in the tracked changes for the associated database. - - - Optional extra context information. Currently, this will always - have a value of . - - - The native pointer to the name of the table. - - - Non-zero if changes to the specified table should be considered; - otherwise, zero. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents the abstract concept of a set of changes. It - acts as the base class for the - and classes. It derives from - the class, which is used to hold - the underlying native connection handle open until the instances of - this class are disposed or finalized. It also provides the ability - to construct wrapped native delegates of the - and - types. - - - - - Constructs an instance of this class using the specified wrapped - native connection handle. - - - The wrapped native connection handle to be associated with this - change set. - - - The flags associated with the connection represented by the - value. - - - - - Creates and returns a concrete implementation of the - interface. - - - The native iterator handle to use. - - - An instance of the - interface, which can be used to fetch metadata associated with - the current item in this set of changes. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes that are backed by a - instance. - - - - - The instance that is managing - the underlying input used as the backing - store for the set of changes associated with this instance. - - - - - The instance that is managing - the underlying output used as the backing - store for the set of changes generated by the - or methods. - - - - - The instance used as the backing store for - the set of changes associated with this instance. - - - - - The instance used as the backing store for - the set of changes generated by the or - methods. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - Throws an exception if the input stream or its associated stream - adapter are invalid. - - - - - Throws an exception if the output stream or its associated stream - adapter are invalid. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes. It serves as the base class for the - and - classes. It manages and - owns an instance of the class. - - - - - This managed change set iterator is managed and owned by this - class. It will be disposed when this class is disposed. - - - - - Constructs an instance of this class using the specified managed - change set iterator. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Sets the managed iterator instance to a new value. - - - The new managed iterator instance to use. - - - - - Disposes of the managed iterator instance and sets its value to - null. - - - - - Disposes of the existing managed iterator instance and then sets it - to a new value. - - - The new managed iterator instance to use. - - - - - Attempts to advance to the next item in the set of changes. - - - Non-zero if more items are available; otherwise, zero. - - - - - Throws because not all the - derived classes are able to support reset functionality. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - This class represents an that is capable of - enumerating over a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - The flags used to create the change set iterator. - - - - - Resets the enumerator to its initial position. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes backed by a - instance. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This interface implements properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - The instance to use. This - will NOT be owned by this class and will not be disposed upon this - class being disposed or finalized. - - - - - Constructs an instance of this class using the specified iterator - instance. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Populates the underlying data for the , - , , and - properties, using the appropriate native - API. - - - - - Populates the underlying data for the - property using the appropriate - native API. - - - - - Populates the underlying data for the - property using the - appropriate native API. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. - This value will be null if this field has not yet been populated - via the underlying native API. - - - - - Backing field for the - property. This value will be null if this field has not yet been - populated via the underlying native API. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - The name of the table the change was made to. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - -
-
diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll deleted file mode 100644 index 4f5314c..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll.config b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll.config deleted file mode 100644 index b14f7b5..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.dll.config +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.xml b/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.xml deleted file mode 100644 index 7510396..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/net40/System.Data.SQLite.xml +++ /dev/null @@ -1,21406 +0,0 @@ - - - - System.Data.SQLite - - - - - Defines a source code identifier custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code identifier value. - - - The source code identifier value to use. - - - - - Gets the source code identifier value. - - - - - Defines a source code time-stamp custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code time-stamp value. - - - The source code time-stamp value to use. - - - - - Gets the source code time-stamp value. - - - - - This is the method signature for the SQLite core library logging callback - function for use with sqlite3_log() and the SQLITE_CONFIG_LOG. - - WARNING: This delegate is used more-or-less directly by native code, do - not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET - - - - - This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement - a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite. - - - - - This base class provides datatype conversion services for the SQLite provider. - - - - - This character is used to escape other characters, including itself, in - connection string property names and values. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - The character is used to separate the name and value for a connection - string property. This character cannot be present in any connection - string property name. This character can be present in a connection - string property value; however, this should be avoided unless deemed - absolutely necessary. - - - - - This character is used to separate connection string properties. When - the "No_SQLiteConnectionNewParser" setting is enabled, this character - may not appear in connection string property names -OR- values. - - - - - The fallback default database type when one cannot be obtained from an - existing connection instance. - - - - - The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. - - - - - These are the characters that are special to the connection string - parser. - - - - - The fallback default database type name when one cannot be obtained from - an existing connection instance. - - - - - The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). - - - - - The value of the OLE Automation epoch represented as a Julian day. This - field cannot be removed as the test suite relies upon it. - - - - - This is the minimum Julian Day value supported by this library - (148731163200000). - - - - - This is the maximum Julian Day value supported by this library - (464269060799000). - - - - - An array of ISO-8601 DateTime formats that we support parsing. - - - - - The internal default format for UTC DateTime values when converting - to a string. - - - - - The internal default format for local DateTime values when converting - to a string. - - - - - An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 - - - - - The default DateTime format for this instance. - - - - - The default DateTimeKind for this instance. - - - - - The default DateTime format string for this instance. - - - - - Initializes the conversion class - - The default date/time format to use for this instance - The DateTimeKind to use. - The DateTime format string to use. - - - - Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. - - The string to convert to UTF-8 - A byte array containing the converted string plus an extra 0 terminating byte at the end of the array. - - - - Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. - - - This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the - string result. - - The DateTime to convert. - The UTF-8 encoded string, including a 0 terminating byte at the end of the array. - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Checks if the specified is within the - supported range for a Julian Day value. - - - The Julian Day value to check. - - - Non-zero if the specified Julian Day value is in the supported - range; otherwise, zero. - - - - - Converts a Julian Day value from a to an - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value from an to a - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeYMD" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day is out of the supported range. If this value is null, - an exception will be thrown instead. - - - A value that contains the year, month, and - day values that are closest to the specified Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeHMS" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day value is out of the supported range. If this value is - null, an exception will be thrown instead. - - - A value that contains the hour, minute, and - second, and millisecond values that are closest to the specified - Julian Day value. - - - - - Converts a to a Julian Day value. - This method was translated from the "computeJD" function in - the "date.c" file belonging to the SQLite core library. - Since the range of Julian Day values supported by this method - includes all possible (valid) values of a - value, it should be extremely difficult for this method to - raise an exception or return an undefined result. - - - The value to convert. This value - will be within the range of - (00:00:00.0000000, January 1, 0001) to - (23:59:59.9999999, December - 31, 9999). - - - The nearest Julian Day value corresponding to the specified - value. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - A DateTime value - - - - Converts a string into a DateTime, using the specified DateTimeFormat, - DateTimeKind and DateTimeFormatString. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - A DateTime value - - - - Converts a julianday value into a DateTime - - The value to convert - A .NET DateTime - - - - Converts a julianday value into a DateTime - - The value to convert - The DateTimeKind to use. - A .NET DateTime - - - - Converts the specified number of seconds from the Unix epoch into a - value. - - - The number of whole seconds since the Unix epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts the specified number of ticks since the epoch into a - value. - - - The number of whole ticks since the epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts a DateTime struct to a JulianDay double - - The DateTime to convert - The JulianDay value the Datetime represents - - - - Converts a DateTime struct to the whole number of seconds since the - Unix epoch. - - The DateTime to convert - The whole number of seconds since the Unix epoch - - - - Returns the DateTime format string to use for the specified DateTimeKind. - If is not null, it will be returned verbatim. - - The DateTimeKind to use. - The DateTime format string to use. - - The DateTime format string to use for the specified DateTimeKind. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. - - - This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls - ToDateTime() on the string to return a DateTime. - - A pointer to the UTF-8 encoded string - The length in bytes of the string - The parsed DateTime value - - - - Smart method of splitting a string. Skips quoted elements, removes the quotes. - - - This split function works somewhat like the String.Split() function in that it breaks apart a string into - pieces and returns the pieces as an array. The primary differences are: - - Only one character can be provided as a separator character - Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed. - - Thus, if splitting the following string looking for a comma:
- One,Two, "Three, Four", Five
-
- The resulting array would contain
- [0] One
- [1] Two
- [2] Three, Four
- [3] Five
-
- Note that the leading and trailing spaces were removed from each item during the split. -
- Source string to split apart - Separator character - A string array of the split up elements -
- - - Splits the specified string into multiple strings based on a separator - and returns the result as an array of strings. - - - The string to split into pieces based on the separator character. If - this string is null, null will always be returned. If this string is - empty, an array of zero strings will always be returned. - - - The character used to divide the original string into sub-strings. - This character cannot be a backslash or a double-quote; otherwise, no - work will be performed and null will be returned. - - - If this parameter is non-zero, all double-quote characters will be - retained in the returned list of strings; otherwise, they will be - dropped. - - - Upon failure, this parameter will be modified to contain an appropriate - error message. - - - The new array of strings or null if the input string is null -OR- the - separator character is a backslash or a double-quote -OR- the string - contains an unbalanced backslash or double-quote character. - - - - - Queries and returns the string representation for an object, using the - specified (or current) format provider. - - - The object instance to return the string representation for. - - - The format provider to use -OR- null if the current format provider for - the thread should be used instead. - - - The string representation for the object instance -OR- null if the - object instance is also null. - - - - - Attempts to convert an arbitrary object to the Boolean data type. - Null object values are converted to false. Throws an exception - upon failure. - - - The object value to convert. - - - The format provider to use. - - - If non-zero, a string value will be converted using the - - method; otherwise, the - method will be used. - - - The converted boolean value. - - - - - Convert a value to true or false. - - A string or number representing true or false - - - - - Converts an integer to a string that can be round-tripped using the - invariant culture. - - - The integer value to return the string representation for. - - - The string representation of the specified integer value, using the - invariant culture. - - - - - Attempts to convert a into a . - - - The to convert, cannot be null. - - - The converted value. - - - The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1", - as well as any prefix of the strings - and . All strings are treated in a - case-insensitive manner. - - - - - Converts a SQLiteType to a .NET Type object - - The SQLiteType to convert - Returns a .NET Type object - - - - For a given intrinsic type, return a DbType - - The native type to convert - The corresponding (closest match) DbType - - - - Returns the ColumnSize for the given DbType - - The DbType to get the size of - - - - - Determines the default database type name to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default database type name to use. - - - - - If applicable, issues a trace log message warning about falling back to - the default database type name. - - - The database value type. - - - The flags associated with the parent connection object. - - - The textual name of the database type. - - - - - If applicable, issues a trace log message warning about falling back to - the default database value type. - - - The textual name of the database type. - - - The flags associated with the parent connection object. - - - The database value type. - - - - - For a given database value type, return the "closest-match" textual database type name. - - The connection context for custom type mappings, if any. - The database value type. - The flags associated with the parent connection object. - The type name or an empty string if it cannot be determined. - - - - Convert a DbType to a Type - - The DbType to convert from - The closest-match .NET type - - - - For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. - - The type to evaluate - The flags associated with the connection. - The SQLite type affinity for that type. - - - - Builds and returns a map containing the database column types - recognized by this provider. - - - A map containing the database column types recognized by this - provider. - - - - - Determines if a database type is considered to be a string. - - - The database type to check. - - - Non-zero if the database type is considered to be a string, zero - otherwise. - - - - - Determines and returns the runtime configuration setting string that - should be used in place of the specified object value. - - - The object value to convert to a string. - - - Either the string to use in place of the object value -OR- null if it - cannot be determined. - - - - - Determines the default value to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default value to use. - - - - - Converts the object value, which is assumed to have originated - from a , to a string value. - - - The value to be converted to a string. - - - A null value will be returned if the original value is null -OR- - the original value is . Otherwise, - the original value will be converted to a string, using its - (possibly overridden) method and - then returned. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be an - value. - - - The textual value to inspect. - - - Non-zero if the text looks like an value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The object instance configured with - the chosen format. - - - The textual value to inspect. - - - Non-zero if the text looks like a in the - configured format, zero otherwise. - - - - - For a given textual database type name, return the "closest-match" database type. - This method is called during query result processing; therefore, its performance - is critical. - - The connection context for custom type mappings, if any. - The textual name of the database type to match. - The flags associated with the parent connection object. - The .NET DBType the text evaluates to. - - - - The error code used for logging exceptions caught in user-provided - code. - - - - - Returns non-zero if this connection to the database is read-only. - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Shutdown the SQLite engine so that it can be restarted with different config options. - We depend on auto initialization to recover. - - - - - Determines if the associated native connection handle is open. - - - Non-zero if a database connection is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - Opens a database. - - - Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection - to bind all attributed user-defined functions and collating sequences to the new connection. - - The filename of the database to open. SQLite automatically creates it if it doesn't exist. - The name of the VFS to use -OR- null to use the default VFS. - The flags associated with the parent connection object - The open flags to use when creating the connection - The maximum size of the pool for the given filename - If true, the connection can be pulled from the connection pool - - - - Closes the currently-open database. - - - After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated - memory associated with the user-defined functions and collating sequences tied to the closed connection. - - Non-zero if connection is being disposed, zero otherwise. - - - - Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. - - The number of milliseconds to wait before returning SQLITE_BUSY - - - - Returns the text of the last error issued by SQLite - - - - - - Returns the text of the last error issued by SQLite -OR- the specified default error text if - none is available from the SQLite core library. - - - The error text to return in the event that one is not available from the SQLite core library. - - - The error text. - - - - - When pooling is enabled, force this connection to be disposed rather than returned to the pool - - - - - When pooling is enabled, returns the number of pool entries matching the current file name. - - The number of pool entries matching the current file name. - - - - Prepares a SQL statement for execution. - - The source connection preparing the command. Can be null for any caller except LINQ - The SQL command text to prepare - The previous statement in a multi-statement command, or null if no previous statement exists - The timeout to wait before aborting the prepare - The remainder of the statement that was not processed. Each call to prepare parses the - SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned - here for a subsequent call to Prepare() until all the text has been processed. - Returns an initialized SQLiteStatement. - - - - Steps through a prepared statement. - - The SQLiteStatement to step through - True if a row was returned, False if not. - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA, - transparently attempt to rebuild the SQL statement and throw an error if that was not possible. - - The statement to reset - Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined function from the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Returns the current and/or highwater values for the specified database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Enables or disables extened result codes returned by SQLite - - true to enable extended result codes, false to disable. - - - - - Returns the numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Result code - - - - Returns the extended numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Extended result code - - - - Add a log message via the SQLite sqlite3_log interface. - - Error code to be logged with the message. - String to be logged. Unlike the SQLite sqlite3_log() - interface, this should be pre-formatted. Consider using the - String.Format() function. - - - - - Checks if the SQLite core library has been initialized in the current process. - - - Non-zero if the SQLite core library has been initialized in the current process, - zero otherwise. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy or negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Returns the error message for the specified SQLite return code using - the internal static lookup table. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns a string representing the active version of SQLite - - - - - Returns an integer representing the active version of SQLite - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of changes the last executing insert/update caused. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection - value, it is global to the process. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - This is not really a per-connection value, it is global to the process. - - - - - Returns non-zero if the underlying native connection handle is owned by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - This field is used to refer to memory allocated for the - SQLITE_DBCONFIG_MAINDBNAME value used with the native - "sqlite3_db_config" API. If allocated, the associated - memeory will be freed when the underlying connection is - closed. - - - - - The opaque pointer returned to us by the sqlite provider - - - - - The user-defined functions registered on this connection - - - - - This is the name of the native library file that contains the - "vtshim" extension [wrapper]. - - - - - This is the flag indicate whether the native library file that - contains the "vtshim" extension must be dynamically loaded by - this class prior to use. - - - - - This is the name of the native entry point for the "vtshim" - extension [wrapper]. - - - - - The modules created using this connection. - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - This method attempts to dispose of all the derived - object instances currently associated with the native database connection. - - - - - Returns the number of times the method has been - called. - - - - - This method determines whether or not a - with a return code of should - be thrown after making a call into the SQLite core library. - - - Non-zero if a to be thrown. This method - will only return non-zero if the method was called - one or more times during a call into the SQLite core library (e.g. when - the sqlite3_prepare*() or sqlite3_step() APIs are used). - - - - - Resets the value of the field. - - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound and removed. - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - Returns a standard SQLite result code. - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. This parameter has no - effect on non-Windows operating systems. - - Returns a standard SQLite result code. - - - - Determines if the associated native connection handle is open. - - - Non-zero if the associated native connection handle is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - This method attempts to determine if a database connection opened - with the specified should be - allowed into the connection pool. - - - The that were specified when the - connection was opened. - - - Non-zero if the connection should (eventually) be allowed into the - connection pool; otherwise, zero. - - - - - Has the sqlite3_errstr() core library API been checked for yet? - If so, is it present? - - - - - Returns the error message for the specified SQLite return code using - the sqlite3_errstr() function, falling back to the internal lookup - table if necessary. - - WARNING: Do not remove this method, it is used via reflection. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Has the sqlite3_stmt_readonly() core library API been checked for yet? - If so, is it present? - - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - This field is used to keep track of whether or not the - "SQLite_ForceLogPrepare" environment variable has been queried. If so, - it will only be non-zero if the environment variable was present. - - - - - Determines if all calls to prepare a SQL query will be logged, - regardless of the flags for the associated connection. - - - Non-zero to log all calls to prepare a SQL query. - - - - - Determines the file name of the native library containing the native - "vtshim" extension -AND- whether it should be dynamically loaded by - this class. - - - This output parameter will be set to non-zero if the returned native - library file name should be dynamically loaded prior to attempting - the creation of native disposable extension modules. - - - The file name of the native library containing the native "vtshim" - extension -OR- null if it cannot be determined. - - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Returns the current and/or highwater values for the specified - database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - Enables or disables extended result codes returned by SQLite - - - Gets the last SQLite error code - - - Gets the last SQLite extended error code - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Allows the setting of a logging callback invoked by SQLite when a - log event occurs. Only one callback may be set. If NULL is passed, - the logging callback is unregistered. - - The callback function to invoke. - Returns a result code - - - - Appends an error message and an appropriate line-ending to a - instance. This is useful because the .NET Compact Framework has a slightly different set - of supported methods for the class. - - - The instance to append to. - - - The message to append. It will be followed by an appropriate line-ending. - - - - - This method attempts to cause the SQLite native library to invalidate - its function pointers that refer to this instance. This is necessary - to prevent calls from native code into delegates that may have been - garbage collected. Normally, these types of issues can only arise for - connections that are added to the pool; howver, it is good practice to - unconditionally invalidate function pointers that may refer to objects - being disposed. - - - Non-zero to also invalidate global function pointers (i.e. those that - are not directly associated with this connection on the native side). - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - This method attempts to free the cached database name used with the - method. - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy, negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Helper function to retrieve a column of data from an active statement. - - The statement being step()'d through - The flags associated with the connection. - The column index to retrieve - The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information. - Returns the data in the column - - - - Returns non-zero if the underlying native connection handle is owned - by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8 - - A pointer to a UTF-16 string - The length (IN BYTES) of the string - A .NET string - - - - Represents a single SQL backup in SQLite. - - - - - The underlying SQLite object this backup is bound to. - - - - - The actual backup handle. - - - - - The destination database for the backup. - - - - - The destination database name for the backup. - - - - - The source database for the backup. - - - - - The source database name for the backup. - - - - - The last result from the StepBackup method of the SQLite3 class. - This is used to determine if the call to the FinishBackup method of - the SQLite3 class should throw an exception when it receives a non-Ok - return code from the core SQLite library. - - - - - Initializes the backup. - - The base SQLite object. - The backup handle. - The destination database for the backup. - The destination database name for the backup. - The source database for the backup. - The source database name for the backup. - - - - Disposes and finalizes the backup. - - - - - - - - - - Creates temporary tables on the connection so schema information can be queried. - - - The connection upon which to build the schema tables. - - - - - The extra behavioral flags that can be applied to a connection. - - - - - No extra flags. - - - - - Enable logging of all SQL statements to be prepared. - - - - - Enable logging of all bound parameter types and raw values. - - - - - Enable logging of all bound parameter strongly typed values. - - - - - Enable logging of all exceptions caught from user-provided - managed code called from native code via delegates. - - - - - Enable logging of backup API errors. - - - - - Skip adding the extension functions provided by the native - interop assembly. - - - - - When binding parameter values with the - type, use the interop method that accepts an - value. - - - - - When binding parameter values, always bind them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - When returning column values, always return them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - Prevent this object instance from - loading extensions. - - - - - Prevent this object instance from - creating virtual table modules. - - - - - Skip binding any functions provided by other managed assemblies when - opening the connection. - - - - - Skip setting the logging related properties of the - object instance that was passed to - the method. - - - - - Enable logging of all virtual table module errors seen by the - method. - - - - - Enable logging of certain virtual table module exceptions that cannot - be easily discovered via other means. - - - - - Enable tracing of potentially important [non-fatal] error conditions - that cannot be easily reported through other means. - - - - - When binding parameter values, always use the invariant culture when - converting their values from strings. - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings. - - - - - Disable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. These - per-connection mappings, when present, override the corresponding - global mappings. - - - - - Disable using global mappings between type names and - values. This may be useful in some very narrow - cases; however, if there are no per-connection type mappings, the - fallback defaults will be used for both type names and their - associated values. Therefore, use of this flag - is not recommended. - - - - - When the property is used, it - should return non-zero if there were ever any rows in the associated - result sets. - - - - - Enable "strict" transaction enlistment semantics. Setting this flag - will cause an exception to be thrown if an attempt is made to enlist - in a transaction with an unavailable or unsupported isolation level. - In the future, more extensive checks may be enabled by this flag as - well. - - - - - Enable mapping of unsupported transaction isolation levels to the - closest supported transaction isolation level. - - - - - When returning column values, attempt to detect the affinity of - textual values by checking if they fully conform to those of the - , - , - , - or types. - - - - - When returning column values, attempt to detect the type of - string values by checking if they fully conform to those of - the , - , - , - or types. - - - - - Skip querying runtime configuration settings for use by the - class, including the default - value and default database type name. - NOTE: If the - and/or - properties are not set explicitly nor set via their connection - string properties and repeated calls to determine these runtime - configuration settings are seen to be a problem, this flag - should be set. - - - - - When binding parameter values with the - type, take their into account as - well as that of the associated . - - - - - If an exception is caught when raising the - event, the transaction - should be rolled back. If this is not specified, the transaction - will continue the commit process instead. - - - - - If an exception is caught when raising the - event, the action should - should be denied. If this is not specified, the action will be - allowed instead. - - - - - If an exception is caught when raising the - event, the operation - should be interrupted. If this is not specified, the operation - will simply continue. - - - - - Attempt to unbind all functions provided by other managed assemblies - when closing the connection. - - - - - When returning column values as a , skip - verifying their affinity. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the parameter name. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the database type name - associated with the value. - - - - - When returning column values, skip verifying their affinity. - - - - - Allow transactions to be nested. The outermost transaction still - controls whether or not any changes are ultimately committed or - rolled back. All non-outermost transactions are implemented using - the SAVEPOINT construct. - - - - - When binding parameter values, always bind - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When returning column values, always return - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When binding parameter values, always use - the invariant culture when converting their values to strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable waiting for the enlistment to be reset prior to attempting - to create a new enlistment. This may be necessary due to the - semantics used by distributed transactions, which complete - asynchronously. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable strict conformance to the ADO.NET standard, e.g. use of - thrown exceptions to indicate common error conditions. - - - - - EXPERIMENTAL -- - When opening a connection, attempt to hide the password from the - connection string, etc. Given the memory architecture of the CLR, - (and P/Invoke) this is not 100% reliable and should not be relied - upon for security critical uses or applications. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted). - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings or from strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings - or from strings. - - - - - Enables use of all per-connection value handling callbacks. - - - - - Enables use of all applicable - properties as fallbacks for the database type name. - - - - - Enable all logging. - - - - - The default logging related flags for new connections. - - - - - The default extra flags for new connections. - - - - - The default extra flags for new connections with all logging enabled. - - - - - These are the supported status parameters for use with the native - SQLite library. - - - - - This parameter returns the number of lookaside memory slots - currently checked out. - - - - - This parameter returns the approximate number of bytes of - heap memory used by all pager caches associated with the - database connection. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED is always 0. - - - - - This parameter returns the approximate number of bytes of - heap memory used to store the schema for all databases - associated with the connection - main, temp, and any ATTACH-ed - databases. The full amount of memory used by the schemas is - reported, even if the schema memory is shared with other - database connections due to shared cache mode being enabled. - The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED - is always 0. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - all lookaside memory already being in use. Only the high-water - value is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that were - satisfied using lookaside memory. Only the high-water value - is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number of pager cache hits that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_HIT is always 0. - - - - - This parameter returns the number of pager cache misses that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_MISS is always 0. - - - - - This parameter returns the number of dirty cache entries that - have been written to disk. Specifically, the number of pages - written to the wal file in wal mode databases, or the number - of pages written to the database file in rollback mode - databases. Any pages written as part of transaction rollback - or database recovery operations are not included. If an IO or - other error occurs while writing a page to disk, the effect - on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is - undefined. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_WRITE is always 0. - - - - - This parameter returns zero for the current value if and only - if all foreign key constraints (deferred or immediate) have - been resolved. The highwater mark is always 0. - - - - - This parameter is similar to DBSTATUS_CACHE_USED, except that - if a pager cache is shared between two or more connections the - bytes of heap memory used by that pager cache is divided evenly - between the attached connections. In other words, if none of - the pager caches associated with the database connection are - shared, this request returns the same value as DBSTATUS_CACHE_USED. - Or, if one or more or the pager caches are shared, the value - returned by this call will be smaller than that returned by - DBSTATUS_CACHE_USED. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. - - - - - This parameter returns the number of dirty cache entries that have - been written to disk in the middle of a transaction due to the page - cache overflowing. Transactions are more efficient if they are - written to disk all at once. When pages spill mid-transaction, that - introduces additional overhead. This parameter can be used help - identify inefficiencies that can be resolved by increasing the cache - size. - - - - - These are the supported configuration verbs for use with the native - SQLite library. They are used with the - method. - - - - - This value represents an unknown (or invalid) option, do not use it. - - - - - This option is used to change the name of the "main" database - schema. The sole argument is a pointer to a constant UTF8 string - which will become the new schema name in place of "main". - - - - - This option is used to configure the lookaside memory allocator. - The value must be an array with three elements. The second element - must be an containing the size of each buffer - slot. The third element must be an containing - the number of slots. The first element must be an - that points to a native memory buffer of bytes equal to or greater - than the product of the second and third element values. - - - - - This option is used to enable or disable the enforcement of - foreign key constraints. - - - - - This option is used to enable or disable triggers. - - - - - This option is used to enable or disable the two-argument version - of the fts3_tokenizer() function which is part of the FTS3 full-text - search engine extension. - - - - - This option is used to enable or disable the loading of extensions. - - - - - This option is used to enable or disable the automatic checkpointing - when a WAL database is closed. - - - - - This option is used to enable or disable the query planner stability - guarantee (QPSG). - - - - - This option is used to enable or disable the extra EXPLAIN QUERY PLAN - output for trigger programs. - - - - - This option is used as part of the process to reset a database back - to an empty state. Because resetting a database is destructive and - irreversible, the process requires the use of this obscure flag and - multiple steps to help ensure that it does not happen by accident. - - - - - This option activates or deactivates the "defensive" flag for a - database connection. When the defensive flag is enabled, language - features that allow ordinary SQL to deliberately corrupt the database - file are disabled. The disabled features include but are not limited - to the following: - ]]> - ]]> - The PRAGMA writable_schema=ON statement. - ]]> - ]]> - The PRAGMA journal_mode=OFF statement. - ]]> - ]]> - Writes to the sqlite_dbpage virtual table. - ]]> - ]]> - Direct writes to shadow tables. - ]]> - ]]> - - - - - This option activates or deactivates the "writable_schema" flag. - - - - - This option activates or deactivates the legacy behavior of the ALTER - TABLE RENAME command such it behaves as it did prior to version 3.24.0 - (2018-06-04). - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DML statement only, that is DELETE, INSERT, - SELECT, and UPDATE statements. - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DDL statements, such as CREATE TABLE and CREATE - INDEX. - - - - - This option is used to enable or disable CREATE VIEW. - - - - - This option activates or deactivates the legacy file format flag. - - - - - This option tells SQLite to assume that database schemas (i.e. the - contents of the sqlite_master tables) are untainted by malicious - content. When the trusted schema option is disabled, SQLite takes - additional defensive steps to protect the application from harm - including: - ]]> - ]]> - Prohibit the use of SQL functions inside triggers, views, CHECK - constraints, DEFAULT clauses, expression indexes, partial indexes, - or generated columns unless those functions are tagged with - SQLITE_INNOCUOUS. - ]]> - ]]> - Prohibit the use of virtual tables inside of triggers or views - unless those virtual tables are tagged with SQLITE_VTAB_INNOCUOUS. - ]]> - This setting defaults to "on" for legacy compatibility, however - all applications are advised to turn it off if possible. This - setting can also be controlled using the PRAGMA trusted_schema - statement. - - - - - These constants are used with the sqlite3_trace_v2() API and the - callbacks registered by it. - - - - - These constants are used with the sqlite3_limit() API. - - - - - This value represents an unknown (or invalid) limit, do not use it. - - - - - The maximum size of any string or BLOB or table row, in bytes. - - - - - The maximum length of an SQL statement, in bytes. - - - - - The maximum number of columns in a table definition or in the - result set of a SELECT or the maximum number of columns in an - index or in an ORDER BY or GROUP BY clause. - - - - - The maximum depth of the parse tree on any expression. - - - - - The maximum number of terms in a compound SELECT statement. - - - - - The maximum number of instructions in a virtual machine program - used to implement an SQL statement. If sqlite3_prepare_v2() or - the equivalent tries to allocate space for more than this many - opcodes in a single prepared statement, an SQLITE_NOMEM error - is returned. - - - - - The maximum number of arguments on a function. - - - - - The maximum number of attached databases. - - - - - The maximum length of the pattern argument to the LIKE or GLOB - operators. - - - - - The maximum index number of any parameter in an SQL statement. - - - - - The maximum depth of recursion for triggers. - - - - - The maximum number of auxiliary worker threads that a single - prepared statement may start. - - - - - Represents a single SQL blob in SQLite. - - - - - The underlying SQLite object this blob is bound to. - - - - - The actual blob handle. - - - - - Initializes the blob. - - The base SQLite object. - The blob handle. - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID -OR- if the query - does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The instance with a result set - containing the desired blob column. - - - The index of the blob column. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID. - - - The connection to use when opening the blob object. - - - The name of the database containing the blob object. - - - The name of the table containing the blob object. - - - The name of the column containing the blob object. - - - The integer identifier for the row associated with the desired - blob object. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Throws an exception if the blob object does not appear to be open. - - - - - Throws an exception if an invalid read/write parameter is detected. - - - When reading, this array will be populated with the bytes read from - the underlying database blob. When writing, this array contains new - values for the specified portion of the underlying database blob. - - - The number of bytes to read or write. - - - The byte offset, relative to the start of the underlying database - blob, where the read or write operation will begin. - - - - - Retargets this object to an underlying database blob for a - different row; the database, table, and column remain exactly - the same. If this operation fails for any reason, this blob - object is automatically disposed. - - - The integer identifier for the new row. - - - - - Queries the total number of bytes for the underlying database blob. - - - The total number of bytes for the underlying database blob. - - - - - Reads data from the underlying database blob. - - - This array will be populated with the bytes read from the - underlying database blob. - - - The number of bytes to read. - - - The byte offset, relative to the start of the underlying - database blob, where the read operation will begin. - - - - - Writes data into the underlying database blob. - - - This array contains the new values for the specified portion of - the underlying database blob. - - - The number of bytes to write. - - - The byte offset, relative to the start of the underlying - database blob, where the write operation will begin. - - - - - Closes the blob, freeing the associated resources. - - - - - Disposes and finalizes the blob. - - - - - The destructor. - - - - - SQLite implementation of DbCommand. - - - - - The default connection string to be used when creating a temporary - connection to execute a command via the static - or - - methods. - - - - - The command text this command is based on - - - - - The connection the command is associated with - - - - - The version of the connection the command is associated with - - - - - Indicates whether or not a DataReader is active on the command. - - - - - The timeout for the command, kludged because SQLite doesn't support per-command timeout values - - - - - Designer support - - - - - Used by DbDataAdapter to determine updating behavior - - - - - The collection of parameters for the command - - - - - The SQL command text, broken into individual SQL statements as they are executed - - - - - Unprocessed SQL text that has not been executed - - - - - Transaction associated with this command - - - - - Constructs a new SQLiteCommand - - - Default constructor - - - - - Initializes the command with the given command text - - The SQL command text - - - - Initializes the command with the given SQL command text and attach the command to the specified - connection. - - The SQL command text - The connection to associate with the command - - - - Initializes the command and associates it with the specified connection. - - The connection to associate with the command - - - - Initializes a command with the given SQL, connection and transaction - - The SQL command text - The connection to associate with the command - The transaction the command should be associated with - - - - Disposes of the command and clears all member variables - - Whether or not the class is being explicitly or implicitly disposed - - - - This method attempts to query the flags associated with the database - connection in use. If the database connection is disposed, the default - flags will be returned. - - - The command containing the databse connection to query the flags from. - - - The connection flags value. - - - - - Clears and destroys all statements currently prepared - - - - - Builds an array of prepared statements for each complete SQL statement in the command text - - - - - Not implemented - - - - - Forwards to the local CreateParameter() function - - - - - - Create a new parameter - - - - - - Verifies that all SQL queries associated with the current command text - can be successfully compiled. A will be - raised if any errors occur. - - - - - This function ensures there are no active readers, that we have a valid connection, - that the connection is open, that all statements are prepared and all parameters are assigned - in preparation for allocating a data reader. - - - - - Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements - - The behavior the data reader should adopt - Returns a SQLiteDataReader object - - - - This method creates a new connection, executes the query using the given - execution type, closes the connection, and returns the results. If the - connection string is null, a temporary in-memory database connection will - be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method creates a new connection, executes the query using the given - execution type and command behavior, closes the connection unless a data - reader is created, and returns the results. If the connection string is - null, a temporary in-memory database connection will be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method executes a query using the given execution type and command - behavior and returns the results. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection used to create and execute the command. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - Overrides the default behavior to return a SQLiteDataReader specialization class - - The flags to be associated with the reader. - A SQLiteDataReader - - - - Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class - - A SQLiteDataReader - - - - Called by the SQLiteDataReader when the data reader is closed. - - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The number of rows inserted/updated affected by it. - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The flags to be associated with the reader. - The number of rows inserted/updated affected by it. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The first column of the first row of the first resultset from the query. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The flags to be associated with the reader. - The first column of the first row of the first resultset from the query. - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - Non-zero if the parameter bindings should be cleared as well. - - - If this is zero, a may be thrown for - any unsuccessful return codes from the native library; otherwise, a - will only be thrown if the connection - or its state is invalid. - - - - - Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. - - - - - Clones a command, including all its parameters - - A new SQLiteCommand with the same commandtext, connection and parameters - - - - The SQL command text associated with the command - - - - - The amount of time to wait for the connection to become available before erroring out - - - - - The type of the command. SQLite only supports CommandType.Text - - - - - The connection associated with this command - - - - - Forwards to the local Connection property - - - - - Returns the SQLiteParameterCollection for the given command - - - - - Forwards to the local Parameters property - - - - - The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the - command's underlying connection. - - - - - Forwards to the local Transaction property - - - - - Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. - - - - - Determines if the command is visible at design time. Defaults to True. - - - - - SQLite implementation of DbCommandBuilder. - - - - - Default constructor - - - - - Initializes the command builder and associates it with the specified data adapter. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema - - The parameter to use in applying custom behaviors to a row - The row to apply the parameter to - The type of statement - Whether the application of the parameter is part of a WHERE clause - - - - Returns a valid named parameter - - The name of the parameter - Error - - - - Returns a named parameter for the given ordinal - - The i of the parameter - Error - - - - Returns a placeholder character for the specified parameter i. - - The index of the parameter to provide a placeholder for - Returns a named parameter - - - - Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL - statements that may not have previously been generated. - - A data adapter to receive events on. - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - - Places brackets around an identifier - - The identifier to quote - The bracketed identifier - - - - Removes brackets around an identifier - - The quoted (bracketed) identifier - The undecorated identifier - - - - Override helper, which can help the base command builder choose the right keys for the given query - - - - - - - Gets/sets the DataAdapter for this CommandBuilder - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - This class represents a single value to be returned - from the class via - its , - , - , - , - , - , - , - , - , - , - , - , - , - , - , or - method. If the value of the - associated public field of this class is null upon returning from the - callback, the null value will only be used if the return type for the - method called is not a value type. - If the value to be returned from the - method is unsuitable (e.g. null with a value type), an exception will - be thrown. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method. - - - - - This class represents the parameters that are provided - to the methods, with - the exception of the column index (provided separately). - - - - - This class represents the parameters that are provided to - the method, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - This class represents the parameters that are provided - to the and - methods, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - This class represents the parameters and return values for the - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , and - methods. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs a new instance of this class. Depending on the method - being called, the and/or - parameters may be null. - - - The name of the method that was - responsible for invoking this callback. - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - This may be used by the callback to set the return value for the - called method. - - - - - The name of the method that was - responsible for invoking this callback. - - - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - - - This may be used by the callback to set the return value for the - called method. - - - - - This represents a method that will be called in response to a request to - bind a parameter to a command. If an exception is thrown, it will cause - the parameter binding operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The instance being bound to the command. - - - The database type name associated with this callback. - - - The ordinal of the parameter being bound to the command. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the parameter binding call should - be skipped (i.e. the parameter should not be bound at all). Great care - should be used when setting this to non-zero. - - - - - This represents a method that will be called in response to a request - to read a value from a data reader. If an exception is thrown, it will - cause the data reader operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The parameter and return type data for the column being read from the - data reader. - - - The database type name associated with this callback. - - - The zero based index of the column being read from the data reader. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - This class represents the custom data type handling callbacks - for a single type name. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - Creates an instance of the class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - The database type name that the callbacks contained in this class - will apply to. This value may not be null. - - - - - The custom paramater binding callback. This value may be null. - - - - - The custom data reader value callback. This value may be null. - - - - - The extra data to pass into the parameter binding callback. This - value may be null. - - - - - The extra data to pass into the data reader value callback. This - value may be null. - - - - - This class represents the mappings between database type names - and their associated custom data type handling callbacks. - - - - - Constructs an (empty) instance of this class. - - - - - Event data for connection event handlers. - - - - - The type of event being raised. - - - - - The associated with this event, if any. - - - - - The transaction associated with this event, if any. - - - - - The command associated with this event, if any. - - - - - The data reader associated with this event, if any. - - - - - The critical handle associated with this event, if any. - - - - - Command or message text associated with this event, if any. - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - The type of event being raised. - The base associated - with this event, if any. - The transaction associated with this event, if any. - The command associated with this event, if any. - The data reader associated with this event, if any. - The critical handle associated with this event, if any. - The command or message text, if any. - The extra data, if any. - - - - Raised when an event pertaining to a connection occurs. - - The connection involved. - Extra information about the event. - - - - SQLite implentation of DbConnection. - - - The property can contain the following parameter(s), delimited with a semi-colon: - - - Parameter - Values - Required - Default - - - Data Source - - This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7). - Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a - UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db" - would become "\\\\Network\Share\test.db"). - - Y - - - - Uri - - If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading - "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open - the database. - - N - null - - - FullUri - - If specified, this must be a URI in a format recognized by the SQLite core library (starting with - SQLite 3.7.7). It will be passed verbatim to the SQLite core library. - - N - null - - - Version - 3 - N - 3 - - - UseUTF16Encoding - - True - The UTF-16 encoding should be used. -
- False - The UTF-8 encoding should be used. -
- N - False -
- - DefaultDbType - - This is the default to use when one cannot be determined based on the - column metadata and the configured type mappings. - - N - null - - - DefaultTypeName - - This is the default type name to use when one cannot be determined based on the column metadata - and the configured type mappings. - - N - null - - - NoDefaultFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - NoSharedFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - VfsName - - The name of the VFS to use when opening the database connection. - If this is not specified, the default VFS will be used. - - N - null - - - ZipVfsVersion - - If non-null, this is the "version" of ZipVFS to use. This requires - the System.Data.SQLite interop assembly -AND- primary managed assembly - to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. The valid values are "v2" and "v3". Using - anyother value will cause an exception to be thrown. Please see the - ZipVFS documentation for more information on how to use this parameter. - - N - null - - - DateTimeFormat - - Ticks - Use the value of DateTime.Ticks.
- ISO8601 - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC - DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).
- JulianDay - The interval of time in days and fractions of a day since January 1, 4713 BC.
- UnixEpoch - The whole number of seconds since the Unix epoch (January 1, 1970).
- InvariantCulture - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
- CurrentCulture - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.
- N - ISO8601 -
- - DateTimeKind - - Unspecified - Not specified as either UTC or local time. -
- Utc - The time represented is UTC. -
- Local - The time represented is local time. -
- N - Unspecified -
- - DateTimeFormatString - - The exact DateTime format string to use for all formatting and parsing of all DateTime - values for this connection. - - N - null - - - BaseSchemaName - - Some base data classes in the framework (e.g. those that build SQL queries dynamically) - assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting - alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used - as a placeholder and removed prior to preparing any SQL statements that may contain it. - - N - sqlite_default_schema - - - BinaryGUID - - True - Store GUID columns in binary form -
- False - Store GUID columns as text -
- N - True -
- - Cache Size - - If the argument N is positive then the suggested cache size is set to N. - If the argument N is negative, then the number of cache pages is adjusted - to use approximately abs(N*4096) bytes of memory. Backwards compatibility - note: The behavior of cache_size with a negative N was different in SQLite - versions prior to 3.7.10. In version 3.7.9 and earlier, the number of - pages in the cache was set to the absolute value of N. - - N - -2000 - - - Synchronous - - Normal - Normal file flushing behavior -
- Full - Full flushing after all writes -
- Off - Underlying OS flushes I/O's -
- N - Full -
- - Page Size - {size in bytes} - N - 4096 - - - Password - - {password} - Using this parameter requires that the legacy CryptoAPI based - codec (or the SQLite Encryption Extension) be enabled at compile-time for - both the native interop assembly and the core managed assemblies; otherwise, - using this parameter may result in an exception being thrown when attempting - to open the connection. - - N - - - - HexPassword - - {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded - byte values without a leading "0x" prefix. Using this parameter requires - that the legacy CryptoAPI based codec (or the SQLite Encryption Extension) - be enabled at compile-time for both the native interop assembly and the - core managed assemblies; otherwise, using this parameter may result in an - exception being thrown when attempting to open the connection. - - N - - - - Enlist - - Y - Automatically enlist in distributed transactions -
- N - No automatic enlistment -
- N - Y -
- - Pooling - - True - Use connection pooling.
- False - Do not use connection pooling.

- WARNING: When using the default connection pool implementation, - setting this property to True should be avoided by applications that make - use of COM (either directly or indirectly) due to possible deadlocks that - can occur during the finalization of some COM objects. -
- N - False -
- - FailIfMissing - - True - Don't create the database if it does not exist, throw an error instead -
- False - Automatically create the database if it does not exist -
- N - False -
- - Max Page Count - {size in pages} - Limits the maximum number of pages (limits the size) of the database - N - 0 - - - Legacy Format - - True - Use the more compatible legacy 3.x database format -
- False - Use the newer 3.3x database format which compresses numbers more effectively -
- N - False -
- - Default Timeout - {time in seconds}
The default command timeout
- N - 30 -
- - BusyTimeout - {time in milliseconds}
Sets the busy timeout for the core library.
- N - 0 -
- - WaitTimeout - {time in milliseconds}
- EXPERIMENTAL -- The wait timeout to use with - method. This is only used when - waiting for the enlistment to be reset prior to enlisting in a transaction, - and then only when the appropriate connection flag is set.
- N - 30000 -
- - Journal Mode - - Delete - Delete the journal file after a commit. -
- Persist - Zero out and leave the journal file on disk after a - commit. -
- Off - Disable the rollback journal entirely. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Truncate - Truncate the journal file to zero-length instead of - deleting it. -
- Memory - Store the journal in volatile RAM. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Wal - Use a write-ahead log instead of a rollback journal. -
- N - Delete -
- - Read Only - - True - Open the database for read only access -
- False - Open the database for normal read/write access -
- N - False -
- - Max Pool Size - The maximum number of connections for the given connection string that can be in the connection pool - N - 100 - - - Default IsolationLevel - The default transaciton isolation level - N - Serializable - - - Foreign Keys - Enable foreign key constraints - N - False - - - Flags - Extra behavioral flags for the connection. See the enumeration for possible values. - N - Default - - - SetDefaults - - True - Apply the default connection settings to the opened database.
- False - Skip applying the default connection settings to the opened database. -
- N - True -
- - ToFullPath - - True - Attempt to expand the data source file name to a fully qualified path before opening. -
- False - Skip attempting to expand the data source file name to a fully qualified path before opening. -
- N - True -
- - PrepareRetries - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - N - 3 - - - ProgressOps - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as well. - - N - 0 - - - Recursive Triggers - - True - Enable the recursive trigger capability. - False - Disable the recursive trigger capability. - - N - False - -
-
-
- - - The "invalid value" for the enumeration used - by the property. This constant is shared - by this class and the SQLiteConnectionStringBuilder class. - - - - - The default "stub" (i.e. placeholder) base schema name to use when - returning column schema information. Used as the initial value of - the BaseSchemaName property. This should start with "sqlite_*" - because those names are reserved for use by SQLite (i.e. they cannot - be confused with the names of user objects). - - - - - The managed assembly containing this type. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - The extra connection flags to be used for all opened connections. - - - - - The instance (for this thread) that - had the most recent call to . - - - - - State of the current connection - - - - - The connection string - - - - - Nesting level of the transactions open on the connection - - - - - Transaction counter for the connection. Currently, this is only used - to build SAVEPOINT names. - - - - - If this flag is non-zero, the method will have - no effect; however, the method will continue to - behave as normal. - - - - - If set, then the connection is currently being disposed. - - - - - The default isolation level for new transactions - - - - - This object is used with lock statements to synchronize access to the - field, below. - - - - - Whether or not the connection is enlisted in a distrubuted transaction - - - - - The per-connection mappings between type names and - values. These mappings override the corresponding global mappings. - - - - - The per-connection mappings between type names and optional callbacks - for parameter binding and value reading. - - - - - The base SQLite object to interop with - - - - - The database filename minus path and extension - - - - - Temporary password storage, emptied after the database has been opened - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. - - - - - The extra behavioral flags for this connection, if any. See the - enumeration for a list of - possible values. - - - - - The cached values for all settings that have been fetched on behalf - of this connection. This cache may be cleared by calling the - method. - - - - - The default databse type for this connection. This value will only - be used if the - flag is set. - - - - - The default databse type name for this connection. This value will only - be used if the - flag is set. - - - - - The name of the VFS to be used when opening the database connection. - - - - - Default command timeout - - - - - The default busy timeout to use with the SQLite core library. This is - only used when opening a connection. - - - - - The default wait timeout to use with - method. This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the appropriate - connection flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when opening the database. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Constructs a new SQLiteConnection object - - - Default constructor - - - - - Initializes the connection with the specified connection string. - - The connection string to use. - - - - Initializes the connection with a pre-existing native connection handle. - This constructor overload is intended to be used only by the private - method. - - - The native connection handle to use. - - - The file name corresponding to the native connection handle. - - - Non-zero if this instance owns the native connection handle and - should dispose of it when it is no longer needed. - - - - - Initializes the connection with the specified connection string. - - - The connection string to use. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Clones the settings and connection string from an existing connection. If the existing connection is already open, this - function will open its own connection, enumerate any attached databases of the original connection, and automatically - attach to them. - - The connection to copy the settings from. - - - - Attempts to lookup the native handle associated with the connection. An exception will - be thrown if this cannot be accomplished. - - - The connection associated with the desired native handle. - - - The native handle associated with the connection or if it - cannot be determined. - - - - - Raises the event. - - - The connection associated with this event. If this parameter is not - null and the specified connection cannot raise events, then the - registered event handlers will not be invoked. - - - A that contains the event data. - - - - - Creates and returns a new managed database connection handle. This - method is intended to be used by implementations of the - interface only. In theory, it - could be used by other classes; however, that usage is not supported. - - - This must be a native database connection handle returned by the - SQLite core library and it must remain valid and open during the - entire duration of the calling method. - - - The new managed database connection handle or null if it cannot be - created. - - - - - Backs up the database, using the specified database connection as the - destination. - - The destination database connection. - The destination database name. - The source database name. - - The number of pages to copy at a time -OR- a negative value to copy all - pages. When a negative value is used, the - may never be invoked. - - - The method to invoke between each step of the backup process. This - parameter may be null (i.e. no callbacks will be performed). If the - callback returns false -OR- throws an exception, the backup is canceled. - - - The number of milliseconds to sleep after encountering a locking error - during the backup process. A value less than zero means that no sleep - should be performed. - - - - - Clears the per-connection cached settings. - - - The total number of per-connection settings cleared. - - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for this connection, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by . - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - Clears the per-connection type mappings. - - - The total number of per-connection type mappings cleared. - - - - - Returns the per-connection type mappings. - - - The per-connection type mappings -OR- null if they are unavailable. - - - - - Adds a per-connection type mapping, possibly replacing one or more - that already exist. - - - The case-insensitive database type name (e.g. "MYDATE"). The value - of this parameter cannot be null. Using an empty string value (or - a string value consisting entirely of whitespace) for this parameter - is not recommended. - - - The value that should be associated with the - specified type name. - - - Non-zero if this mapping should be considered to be the primary one - for the specified . - - - A negative value if nothing was done. Zero if no per-connection type - mappings were replaced (i.e. it was a pure add operation). More than - zero if some per-connection type mappings were replaced. - - - - - Clears the per-connection type callbacks. - - - The total number of per-connection type callbacks cleared. - - - - - Attempts to get the per-connection type callbacks for the specified - database type name. - - - The database type name. - - - Upon success, this parameter will contain the object holding the - callbacks for the database type name. Upon failure, this parameter - will be null. - - - Non-zero upon success; otherwise, zero. - - - - - Sets, resets, or clears the per-connection type callbacks for the - specified database type name. - - - The database type name. - - - The object holding the callbacks for the database type name. If - this parameter is null, any callbacks for the database type name - will be removed if they are present. - - - Non-zero if callbacks were set or removed; otherwise, zero. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - A object instance that helps implement the - function to be bound. For scalar functions, this corresponds to the - type. For aggregate functions, - this corresponds to the type. For - collation functions, this corresponds to the - type. - - - A object instance that helps implement the - function to be bound. For aggregate functions, this corresponds to the - type. For other callback types, it - is not used and must be null. - - - - - Attempts to unbind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be unbound. - - Non-zero if the function was unbound. - - - - This method unbinds all registered (known) functions -OR- all previously - bound user-defined functions from this connection. - - - Non-zero to unbind all registered (known) functions -OR- zero to unbind - all functions currently bound to the connection. - - - Non-zero if all the specified user-defined functions were unbound. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Attempts to escape the specified connection string property name or - value in a way that is compatible with the connection string parser. - - - The connection string property name or value to escape. - - - Non-zero if the equals sign is permitted in the string. If this is - zero and the string contains an equals sign, an exception will be - thrown. - - - The original string, with all special characters escaped. If the - original string contains equals signs, they will not be escaped. - Instead, they will be preserved verbatim. - - - - - Builds a connection string from a list of key/value pairs. - - - The list of key/value pairs corresponding to the parameters to be - specified within the connection string. - - - The connection string. Depending on how the connection string was - originally parsed, the returned connection string value may not be - usable in a subsequent call to the method. - - - - - Disposes and finalizes the connection, if applicable. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection - will also be opened. - - - - - - Creates a database file. This just creates a zero-byte file which SQLite - will turn into a database when the file is opened properly. - - The file to create - - - - Raises the state change event when the state of the connection changes - - The new connection state. If this is different - from the previous state, the event is - raised. - The event data created for the raised event, if - it was actually raised. - - - - Determines and returns the fallback default isolation level when one cannot be - obtained from an existing connection instance. - - - The fallback default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - Determines and returns the default isolation level for this connection instance. - - - The default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - This parameter is ignored. - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already active on the connection. - - Supported isolation levels are Serializable, ReadCommitted and Unspecified. - - Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the - connection string, Serializable is used. - Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads - may begin a transaction. Other threads may read from the database, but not write. - With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start - a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread - has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached. - - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already - active on the connection. - - Returns the new transaction object. - - - - Forwards to the local function - - Supported isolation levels are Unspecified, Serializable, and ReadCommitted - - - - - This method is not implemented; however, the - event will still be raised. - - - - - - When the database connection is closed, all commands linked to this connection are automatically reset. - - - - - Clears the connection pool associated with the connection. Any other active connections using the same database file - will be discarded instead of returned to the pool when they are closed. - - - - - - Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. - - - - - Create a new and associate it with this connection. - - Returns a new command object already assigned to this connection. - - - - Forwards to the local function. - - - - - - Attempts to create a new object instance - using this connection and the specified database name. - - - The name of the database for the newly created session. - - - The newly created session -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object - instance using this connection. - - - The newly created change group -OR- null if it cannot be created. - - - - - Determines if the legacy connection string parser should be used. - - - The connection that will be using the parsed connection string. - - - Non-zero if the legacy connection string parser should be used. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string using the built-in (i.e. framework provided) - connection string parser class and returns the key/value pairs. An - exception may be thrown if the connection string is invalid or cannot be - parsed. When compiled for the .NET Compact Framework, the custom - connection string parser is always used instead because the framework - provided one is unavailable there. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to throw an exception if any connection string values are not of - the type. This is not applicable when running on - the .NET Compact Framework. - - The list of key/value pairs. - - - - Manual distributed transaction enlistment support - - The distributed transaction to enlist in - - - - EXPERIMENTAL -- - Waits for the enlistment associated with this connection to be reset. - This method always throws when - running on the .NET Compact Framework. - - - The approximate maximum number of milliseconds to wait before timing - out the wait operation. - - - The return value to use if the connection has been disposed; if this - value is null, will be raised - if the connection has been disposed. - - - Non-zero if the enlistment assciated with this connection was reset; - otherwise, zero. It should be noted that this method returning a - non-zero value does not necessarily guarantee that the connection - can enlist in a new transaction (i.e. due to potentical race with - other threads); therefore, callers should generally use try/catch - when calling the method. - - - - - Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value - - The list to look in - The key to find - The default value to return if the key is not found - The value corresponding to the specified key, or the default value if not found. - - - - Attempts to convert the string value to an enumerated value of the specified type. - - The enumerated type to convert the string value to. - The string value to be converted. - Non-zero to make the conversion case-insensitive. - The enumerated value upon success or null upon error. - - - - Attempts to convert an input string into a byte value. - - - The string value to be converted. - - - The number styles to use for the conversion. - - - Upon sucess, this will contain the parsed byte value. - Upon failure, the value of this parameter is undefined. - - - Non-zero upon success; zero on failure. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - - - Enables or disables extension loading. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Creates a disposable module containing the implementation of a virtual - table. - - - The module object to be used when creating the disposable module. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - Creates and returns a string containing the hexadecimal encoded byte - values from the input array. - - - The input array of bytes. - - - The resulting string or null upon failure. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - Upon failure, this will contain an appropriate error message. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - This method figures out what the default connection pool setting should - be based on the connection flags. When present, the "Pooling" connection - string property value always overrides the value returned by this method. - - - Non-zero if the connection pool should be enabled by default; otherwise, - zero. - - - - - Determines the transaction isolation level that should be used by - the caller, primarily based upon the one specified by the caller. - If mapping of transaction isolation levels is enabled, the returned - transaction isolation level may be significantly different than the - originally specified one. - - - The originally specified transaction isolation level. - - - The transaction isolation level that should be used. - - - - - Opens the connection using the parameters found in the . - - - - - Opens the connection using the parameters found in the and then returns it. - - The current connection object. - - - - This method causes any pending database operation to abort and return at - its earliest opportunity. This routine is typically called in response - to a user action such as pressing "Cancel" or Ctrl-C where the user wants - a long query operation to halt immediately. It is safe to call this - routine from any thread. However, it is not safe to call this routine - with a database connection that is closed or might close before this method - returns. - - - - - Checks if this connection to the specified database should be considered - read-only. An exception will be thrown if the database name specified - via cannot be found. - - - The name of a database associated with this connection -OR- null for the - main database. - - - Non-zero if this connection to the specified database should be considered - read-only. - - - - - Returns various global memory statistics for the SQLite core library via - a dictionary of key/value pairs. Currently, only the "MemoryUsed" and - "MemoryHighwater" keys are returned and they have values that correspond - to the values that could be obtained via the - and connection properties. - - - This dictionary will be populated with the global memory statistics. It - will be created if necessary. - - - - - Attempts to free as much heap memory as possible for this database connection. - - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for the last connection that used - the method, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by using the cached - setting names and values for the last connection that used the - method, when available. - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - Passes a shutdown request to the SQLite core library. Does not throw - an exception if the shutdown request fails. - - - A standard SQLite return code (i.e. zero for success and non-zero for - failure). - - - - - Passes a shutdown request to the SQLite core library. Throws an - exception if the shutdown request fails and the no-throw parameter - is non-zero. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. - - - When non-zero, throw an exception if the shutdown request fails. - - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Change the password (or assign a password) to an open database. - - - No readers or writers may be active for this process. The database must already be open - and if it already was password protected, the existing password must already have been supplied. - - The new password to assign to the database - - - - Change the password (or assign a password) to an open database. - - - No readers or writers may be active for this process. The database must already be open - and if it already was password protected, the existing password must already have been supplied. - - The new password to assign to the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - - - - Sets the password for a password-protected database. A password-protected database is - unusable for any operation until the password has been set. - - The password for the database - - - - Queries or modifies the number of retries or the retry interval (in milliseconds) for - certain I/O operations that may fail due to anti-virus software. - - The number of times to retry the I/O operation. A negative value - will cause the current count to be queried and replace that negative value. - The number of milliseconds to wait before retrying the I/O - operation. This number is multiplied by the number of retry attempts so far to come - up with the final number of milliseconds to wait. A negative value will cause the - current interval to be queried and replace that negative value. - Zero for success, non-zero for error. - - - - Sets the chunk size for the primary file associated with this database - connection. - - - The new chunk size for the main database, in bytes. - - - Zero for success, non-zero for error. - - - - - Removes one set of surrounding single -OR- double quotes from the string - value and returns the resulting string value. If the string is null, empty, - or contains quotes that are not balanced, nothing is done and the original - string value will be returned. - - The string value to process. - - The string value, modified to remove one set of surrounding single -OR- - double quotes, if applicable. - - - - - Determines the directory to be used when dealing with the "|DataDirectory|" - macro in a database file name. - - - The directory to use in place of the "|DataDirectory|" macro -OR- null if it - cannot be determined. - - - - - Expand the filename of the data source, resolving the |DataDirectory| - macro as appropriate. - - The database filename to expand - - Non-zero if the returned file name should be converted to a full path - (except when using the .NET Compact Framework). - - The expanded path and filename of the filename - - - - The following commands are used to extract schema information out of the database. Valid schema types are: - - - MetaDataCollections - - - DataSourceInformation - - - Catalogs - - - Columns - - - ForeignKeys - - - Indexes - - - IndexColumns - - - Tables - - - Views - - - ViewColumns - - - - - Returns the MetaDataCollections schema - - A DataTable of the MetaDataCollections schema - - - - Returns schema information of the specified collection - - The schema collection to retrieve - A DataTable of the specified collection - - - - Retrieves schema information using the specified constraint(s) for the specified collection - - The collection to retrieve. - - The restrictions to impose. Typically, this may include: - - - restrictionValues element index - usage - - - 0 - The database (or catalog) name, if applicable. - - - 1 - The schema name. This is not used by this provider. - - - 2 - The table name, if applicable. - - - 3 - - Depends on . - When "IndexColumns", it is the index name; otherwise, it is the column name. - - - - 4 - - Depends on . - When "IndexColumns", it is the column name; otherwise, it is not used. - - - - - A DataTable of the specified collection - - - - Builds a MetaDataCollections schema datatable - - DataTable - - - - Builds a DataSourceInformation datatable - - DataTable - - - - Build a Columns schema - - The catalog (attached database) to query, can be null - The table to retrieve schema information for, can be null - The column to retrieve schema information for, can be null - DataTable - - - - Returns index information for the given database and catalog - - The catalog (attached database) to query, can be null - The name of the index to retrieve information for, can be null - The table to retrieve index information for, can be null - DataTable - - - - Retrieves table schema information for the database and catalog - - The catalog (attached database) to retrieve tables on - The table to retrieve, can be null - The table type, can be null - DataTable - - - - Retrieves view schema information for the database - - The catalog (attached database) to retrieve views on - The view name, can be null - DataTable - - - - Retrieves catalog (attached databases) schema information for the database - - The catalog to retrieve, can be null - DataTable - - - - Returns the base column information for indexes in a database - - The catalog to retrieve indexes for (can be null) - The table to restrict index information by (can be null) - The index to restrict index information by (can be null) - The source column to restrict index information by (can be null) - A DataTable containing the results - - - - Returns detailed column information for a specified view - - The catalog to retrieve columns for (can be null) - The view to restrict column information by (can be null) - The source column to restrict column information by (can be null) - A DataTable containing the results - - - - Retrieves foreign key information from the specified set of filters - - An optional catalog to restrict results on - An optional table to restrict results on - An optional foreign key name to restrict results on - A DataTable with the results of the query - - - - Static variable to store the connection event handlers to call. - - - - - This event is raised whenever the database is opened or closed. - - - - - This event is raised when events related to the lifecycle of a - SQLiteConnection object occur. - - - - - This property is used to obtain or set the custom connection pool - implementation to use, if any. Setting this property to null will - cause the default connection pool implementation to be used. - - - - - Returns the number of pool entries for the file name associated with this connection. - - - - - The connection string containing the parameters for the connection - - - For the complete list of supported connection string properties, - please see . - - - - - Returns the data source file name without extension or path. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - - - Returns the string "main". - - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - This can also be set in the ConnectionString with "Default Timeout" - - - - - Gets/sets the default busy timeout to use with the SQLite core library. This is only used when - opening a connection. - - - - - EXPERIMENTAL -- - The wait timeout to use with method. - This is only used when waiting for the enlistment to be reset prior to - enlisting in a transaction, and then only when the appropriate connection - flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when the underlying native progress - callback needs to be changed. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Gets/sets the extra behavioral flags for this connection. See the - enumeration for a list of - possible values. - - - - - Gets/sets the default database type for this connection. This value - will only be used when not null. - - - - - Gets/sets the default database type name for this connection. This - value will only be used when not null. - - - - - Gets/sets the VFS name for this connection. This value will only be - used when opening the database. - - - - - Returns non-zero if the underlying native connection handle is - owned by this instance. - - - - - Returns the version of the underlying SQLite database engine - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on - this connection. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - - - - - Returns a string containing the define constants (i.e. compile-time - options) used to compile the core managed assembly, delimited with - spaces. - - - - - Returns the version of the underlying SQLite core library. - - - - - This method returns the string whose value is the same as the - SQLITE_SOURCE_ID C preprocessor macro used when compiling the - SQLite core library. - - - - - Returns a string containing the compile-time options used to - compile the SQLite core native library, delimited with spaces. - - - - - This method returns the version of the interop SQLite assembly - used. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the interop - assembly. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - Returns a string containing the compile-time options used to - compile the SQLite interop assembly, delimited with spaces. - - - - - This method returns the version of the managed components used - to interact with the SQLite core library. If the necessary - information cannot be obtained for any reason, a null value may - be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the managed - components currently executing. If the necessary information - cannot be obtained for any reason, a null value may be returned. - - - - - The default connection flags to be used for all opened connections - when they are not present in the connection string. - - - - - The extra connection flags to be used for all opened connections. - - - - - Returns the state of the connection. - - - - - This event is raised periodically during long running queries. Changing - the value of the property will - determine if the operation in progress will continue or be interrupted. - For the entire duration of the event, the associated connection and - statement objects must not be modified, either directly or indirectly, by - the called code. - - - - - This event is raised whenever SQLite encounters an action covered by the - authorizer during query preparation. Changing the value of the - property will determine if - the specific action will be allowed, ignored, or denied. For the entire - duration of the event, the associated connection and statement objects - must not be modified, either directly or indirectly, by the called code. - - - - - This event is raised whenever SQLite makes an update/delete/insert into the database on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is committing a transaction. - Return non-zero to trigger a rollback. - - - - - This event is raised whenever SQLite statement first begins executing on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is rolling back a transaction. - - - - - Returns the instance. - - - - - The I/O file cache flushing behavior for the connection - - - - - Normal file flushing at critical sections of the code - - - - - Full file flushing after every write operation - - - - - Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing - - - - - Raised each time the number of virtual machine instructions is - approximately equal to the value of the - property. - - The connection performing the operation. - A that contains the - event data. - - - - Raised when authorization is required to perform an action contained - within a SQL query. - - The connection performing the action. - A that contains the - event data. - - - - Raised when a transaction is about to be committed. To roll back a transaction, set the - rollbackTrans boolean value to true. - - The connection committing the transaction - Event arguments on the transaction - - - - Raised when data is inserted, updated and deleted on a given connection - - The connection committing the transaction - The event parameters which triggered the event - - - - Raised when a statement first begins executing on a given connection - - The connection executing the statement - Event arguments of the trace - - - - Raised between each backup step. - - - The source database connection. - - - The source database name. - - - The destination database connection. - - - The destination database name. - - - The number of pages copied with each step. - - - The number of pages remaining to be copied. - - - The total number of pages in the source database. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True to continue with the backup process or false to halt the backup - process, rolling back any changes that have been made so far. - - - - - The event data associated with progress reporting events. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The return code for the current call into the progress callback. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The progress return code. - - - - - The data associated with a call into the authorizer. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The action code responsible for the current call into the authorizer. - - - - - The first string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The second string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The database name for the current call into the authorizer, if - applicable. - - - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - - - The return code for the current call into the authorizer. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The authorizer action code. - - - The first authorizer argument. - - - The second authorizer argument. - - - The database name, if applicable. - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - The authorizer return code. - - - - - Whenever an update event is triggered on a connection, this enum will indicate - exactly what type of operation is being performed. - - - - - A row is being deleted from the given database and table - - - - - A row is being inserted into the table. - - - - - A row is being updated in the table. - - - - - Passed during an Update callback, these event arguments detail the type of update operation being performed - on the given connection. - - - - - The name of the database being updated (usually "main" but can be any attached or temporary database) - - - - - The name of the table being updated - - - - - The type of update being performed (insert/update/delete) - - - - - The RowId affected by this update. - - - - - Event arguments raised when a transaction is being committed - - - - - Set to true to abort the transaction and trigger a rollback - - - - - Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text - - - - - SQL statement text as the statement first begins executing - - - - - This interface represents a custom connection pool implementation - usable by System.Data.SQLite. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This default method implementations in this class should not be used by - applications that make use of COM (either directly or indirectly) due - to possible deadlocks that can occur during finalization of some COM - objects. - - - - - This field is used to synchronize access to the private static data - in this class. - - - - - When this field is non-null, it will be used to provide the - implementation of all the connection pool methods; otherwise, - the default method implementations will be used. - - - - - The dictionary of connection pools, based on the normalized file - name of the SQLite database. - - - - - The default version number new pools will get. - - - - - The number of connections successfully opened from any pool. - This value is incremented by the Remove method. - - - - - The number of connections successfully closed from any pool. - This value is incremented by the Add method. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This method is used to obtain a reference to the custom connection - pool implementation currently in use, if any. - - - The custom connection pool implementation or null if the default - connection pool implementation should be used. - - - - - This method is used to set the reference to the custom connection - pool implementation to use, if any. - - - The custom connection pool implementation to use or null if the - default connection pool implementation should be used. - - - - - We do not have to thread-lock anything in this function, because it - is only called by other functions above which already take the lock. - - - The pool queue to resize. - - - If a function intends to add to the pool, this is true, which - forces the resize to take one more than it needs from the pool. - - - - - Keeps track of connections made on a specified file. The PoolVersion - dictates whether old objects get returned to the pool or discarded - when no longer in use. - - - - - The queue of weak references to the actual database connection - handles. - - - - - This pool version associated with the database connection - handles in this pool queue. - - - - - The maximum size of this pool queue. - - - - - Constructs a connection pool queue using the specified version - and maximum size. Normally, all the database connection - handles in this pool are associated with a single database file - name. - - - The initial pool version for this connection pool queue. - - - The initial maximum size for this connection pool queue. - - - - - SQLite implementation of DbConnectionStringBuilder. - - - - - Properties of this class - - - - - Constructs a new instance of the class - - - Default constructor - - - - - Constructs a new instance of the class using the specified connection string. - - The connection string to parse - - - - Private initializer, which assigns the connection string and resets the builder - - The connection string to assign - - - - Helper function for retrieving values from the connectionstring - - The keyword to retrieve settings for - The resulting parameter value - Returns true if the value was found and returned - - - - Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties() - - The hashtable to fill with property descriptors - - - - Gets/Sets the default version of the SQLite engine to instantiate. Currently the only valid value is 3, indicating version 3 of the sqlite library. - - - - - Gets/Sets the synchronization mode (file flushing) of the connection string. Default is "Normal". - - - - - Gets/Sets the encoding for the connection string. The default is "False" which indicates UTF-8 encoding. - - - - - Gets/Sets whether or not to use connection pooling. The default is "False" - - - - - Gets/Sets whethor not to store GUID's in binary format. The default is True - which saves space in the database. - - - - - Gets/Sets the filename to open on the connection string. - - - - - An alternate to the data source property - - - - - An alternate to the data source property that uses the SQLite URI syntax. - - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - - - - - Gets/sets the busy timeout to use with the SQLite core library. - - - - - EXPERIMENTAL -- - The wait timeout to use with - method. - This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the - appropriate connection flag is set. - - - - - Gets/sets the maximum number of retries when preparing SQL to be executed. - This normally only applies to preparation errors resulting from the database - schema being changed. - - - - - Gets/sets the approximate number of virtual machine instructions between - progress events. In order for progress events to actually fire, the event - handler must be added to the event - as well. - - - - - Determines whether or not the connection will automatically participate - in the current distributed transaction (if one exists) - - - - - If set to true, will throw an exception if the database specified in the connection - string does not exist. If false, the database will be created automatically. - - - - - If enabled, uses the legacy 3.xx format for maximum compatibility, but results in larger - database sizes. - - - - - When enabled, the database will be opened for read-only access and writing will be disabled. - - - - - Gets/sets the database encryption password - - - - - Gets/sets the database encryption hexadecimal password - - - - - Gets/Sets the page size for the connection. - - - - - Gets/Sets the maximum number of pages the database may hold - - - - - Gets/Sets the cache size for the connection. - - - - - Gets/Sets the DateTime format for the connection. - - - - - Gets/Sets the DateTime kind for the connection. - - - - - Gets/sets the DateTime format string used for formatting - and parsing purposes. - - - - - Gets/Sets the placeholder base schema name used for - .NET Framework compatibility purposes. - - - - - Determines how SQLite handles the transaction journal file. - - - - - Sets the default isolation level for transactions on the connection. - - - - - Gets/sets the default database type for the connection. - - - - - Gets/sets the default type name for the connection. - - - - - Gets/sets the VFS name for the connection. - - - - - If enabled, use foreign key constraints - - - - - Enable or disable the recursive trigger capability. - - - - - If non-null, this is the version of ZipVFS to use. This requires the - System.Data.SQLite interop assembly -AND- primary managed assembly to - be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. - - - - - Gets/Sets the extra behavioral flags. - - - - - If enabled, apply the default connection settings to opened databases. - - - - - If enabled, attempt to resolve the provided data source file name to a - full path before opening. - - - - - If enabled, skip using the configured default connection flags. - - - - - If enabled, skip using the configured shared connection flags. - - - - - SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite - understands. The DateTime extension to the spec is for internal use only. - - - - - Not used - - - - - All integers in SQLite default to Int64 - - - - - All floating point numbers in SQLite default to double - - - - - The default data type of SQLite is text - - - - - Typically blob types are only seen when returned from a function - - - - - Null types can be returned from functions - - - - - Used internally by this provider - - - - - Used internally by this provider - - - - - These are the event types associated with the - - delegate (and its corresponding event) and the - class. - - - - - Not used. - - - - - Not used. - - - - - The connection is being opened. - - - - - The connection string has been parsed. - - - - - The connection was opened. - - - - - The method was called on the - connection. - - - - - A transaction was created using the connection. - - - - - The connection was enlisted into a transaction. - - - - - A command was created using the connection. - - - - - A data reader was created using the connection. - - - - - An instance of a derived class has - been created to wrap a native resource. - - - - - The connection is being closed. - - - - - The connection was closed. - - - - - A command is being disposed. - - - - - A data reader is being disposed. - - - - - A data reader is being closed. - - - - - A native resource was opened (i.e. obtained) from the pool. - - - - - A native resource was closed (i.e. released) to the pool. - - - - - This implementation of SQLite for ADO.NET can process date/time fields in - databases in one of six formats. - - - ISO8601 format is more compatible, readable, fully-processable, but less - accurate as it does not provide time down to fractions of a second. - JulianDay is the numeric format the SQLite uses internally and is arguably - the most compatible with 3rd party tools. It is not readable as text - without post-processing. Ticks less compatible with 3rd party tools that - query the database, and renders the DateTime field unreadable as text - without post-processing. UnixEpoch is more compatible with Unix systems. - InvariantCulture allows the configured format for the invariant culture - format to be used and is human readable. CurrentCulture allows the - configured format for the current culture to be used and is also human - readable. - - The preferred order of choosing a DateTime format is JulianDay, ISO8601, - and then Ticks. Ticks is mainly present for legacy code support. - - - - - Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ. - - - - - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and - "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values). - - - - - The interval of time in days and fractions of a day since January 1, 4713 BC. - - - - - The whole number of seconds since the Unix epoch (January 1, 1970). - - - - - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime. - - - - - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. - - - - - The default format for this provider. - - - - - This enum determines how SQLite treats its journal file. - - - By default SQLite will create and delete the journal file when needed during a transaction. - However, for some computers running certain filesystem monitoring tools, the rapid - creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite. - - If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file" - when starting a transaction. If this is happening, you may want to change the default journal mode to Persist. - - - - - The default mode, this causes SQLite to use the existing journaling mode for the database. - - - - - SQLite will create and destroy the journal file as-needed. - - - - - When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased, - and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed. - - - - - This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database - corruption in this mode! - - - - - SQLite will truncate the journal file to zero-length instead of deleting it. - - - - - SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. - If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the - database file will very likely go corrupt. - - - - - SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; - after being set it stays in effect across multiple database connections and after closing and reopening the database. A database - in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later. - - - - - Possible values for the "synchronous" database setting. This setting determines - how often the database engine calls the xSync method of the VFS. - - - - - Use the default "synchronous" database setting. Currently, this should be - the same as using the FULL mode. - - - - - The database engine continues without syncing as soon as it has handed - data off to the operating system. If the application running SQLite - crashes, the data will be safe, but the database might become corrupted - if the operating system crashes or the computer loses power before that - data has been written to the disk surface. - - - - - The database engine will still sync at the most critical moments, but - less often than in FULL mode. There is a very small (though non-zero) - chance that a power failure at just the wrong time could corrupt the - database in NORMAL mode. - - - - - The database engine will use the xSync method of the VFS to ensure that - all content is safely written to the disk surface prior to continuing. - This ensures that an operating system crash or power failure will not - corrupt the database. FULL synchronous is very safe, but it is also - slower. - - - - - The requested command execution type. This controls which method of the - object will be called. - - - - - Do nothing. No method will be called. - - - - - The command is not expected to return a result -OR- the result is not - needed. The or - method - will be called. - - - - - The command is expected to return a scalar result -OR- the result should - be limited to a scalar result. The - or method will - be called. - - - - - The command is expected to return result. - The or - method will - be called. - - - - - Use the default command execution type. Using this value is the same - as using the value. - - - - - The action code responsible for the current call into the authorizer. - - - - - No action is being performed. This value should not be used from - external code. - - - - - No longer used. - - - - - An index will be created. The action-specific arguments are the - index name and the table name. - - - - - - A table will be created. The action-specific arguments are the - table name and a null value. - - - - - A temporary index will be created. The action-specific arguments - are the index name and the table name. - - - - - A temporary table will be created. The action-specific arguments - are the table name and a null value. - - - - - A temporary trigger will be created. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be created. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be created. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be created. The action-specific arguments are the view - name and a null value. - - - - - A DELETE statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - An index will be dropped. The action-specific arguments are the - index name and the table name. - - - - - A table will be dropped. The action-specific arguments are the tables - name and a null value. - - - - - A temporary index will be dropped. The action-specific arguments are - the index name and the table name. - - - - - A temporary table will be dropped. The action-specific arguments are - the table name and a null value. - - - - - A temporary trigger will be dropped. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be dropped. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be dropped. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be dropped. The action-specific arguments are the view - name and a null value. - - - - - An INSERT statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - A PRAGMA statement will be executed. The action-specific arguments - are the name of the PRAGMA and the new value or a null value. - - - - - A table column will be read. The action-specific arguments are the - table name and the column name. - - - - - A SELECT statement will be executed. The action-specific arguments - are both null values. - - - - - A transaction will be started, committed, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - COMMIT, or ROLLBACK) and a null value. - - - - - An UPDATE statement will be executed. The action-specific arguments - are the table name and the column name. - - - - - A database will be attached to the connection. The action-specific - arguments are the database file name and a null value. - - - - - A database will be detached from the connection. The action-specific - arguments are the database name and a null value. - - - - - The schema of a table will be altered. The action-specific arguments - are the database name and the table name. - - - - - An index will be deleted and then recreated. The action-specific - arguments are the index name and a null value. - - - - - A table will be analyzed to gathers statistics about it. The - action-specific arguments are the table name and a null value. - - - - - A virtual table will be created. The action-specific arguments are - the table name and the module name. - - - - - A virtual table will be dropped. The action-specific arguments are - the table name and the module name. - - - - - A SQL function will be called. The action-specific arguments are a - null value and the function name. - - - - - A savepoint will be created, released, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - RELEASE, or ROLLBACK) and the savepoint name. - - - - - A recursive query will be executed. The action-specific arguments - are two null values. - - - - - The possible return codes for the progress callback. - - - - - The operation should continue. - - - - - The operation should be interrupted. - - - - - The return code for the current call into the authorizer. - - - - - The action will be allowed. - - - - - The overall action will be disallowed and an error message will be - returned from the query preparation method. - - - - - The specific action will be disallowed; however, the overall action - will continue. The exact effects of this return code vary depending - on the specific action, please refer to the SQLite core library - documentation for futher details. - - - - - Class used internally to determine the datatype of a column in a resultset - - - - - The DbType of the column, or DbType.Object if it cannot be determined - - - - - The affinity of a column, used for expressions or when Type is DbType.Object - - - - - Constructs a default instance of this type. - - - - - Constructs an instance of this type with the specified field values. - - - The type affinity to use for the new instance. - - - The database type to use for the new instance. - - - - - SQLite implementation of DbDataAdapter. - - - - - This class is just a shell around the DbDataAdapter. Nothing from - DbDataAdapter is overridden here, just a few constructors are defined. - - - Default constructor. - - - - - Constructs a data adapter using the specified select command. - - - The select command to associate with the adapter. - - - - - Constructs a data adapter with the supplied select command text and - associated with the specified connection. - - - The select command text to associate with the data adapter. - - - The connection to associate with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Raised by the underlying DbDataAdapter when a row is being updated - - The event's specifics - - - - Raised by DbDataAdapter after a row is updated - - The event's specifics - - - - Row updating event handler - - - - - Row updated event handler - - - - - Gets/sets the select command for this DataAdapter - - - - - Gets/sets the insert command for this DataAdapter - - - - - Gets/sets the update command for this DataAdapter - - - - - Gets/sets the delete command for this DataAdapter - - - - - SQLite implementation of DbDataReader. - - - - - Underlying command this reader is attached to - - - - - The flags pertaining to the associated connection (via the command). - - - - - Index of the current statement in the command being processed - - - - - Current statement being Read() - - - - - State of the current statement being processed. - -1 = First Step() executed, so the first Read() will be ignored - 0 = Actively reading - 1 = Finished reading - 2 = Non-row-returning statement, no records - - - - - Number of records affected by the insert/update statements executed on the command - - - - - Count of fields (columns) in the row-returning statement currently being processed - - - - - The number of calls to Step() that have returned true (i.e. the number of rows that - have been read in the current result set). - - - - - Maps the field (column) names to their corresponding indexes within the results. - - - - - Datatypes of active fields (columns) in the current statement, used for type-restricting data - - - - - The behavior of the datareader - - - - - If set, then dispose of the command object when the reader is finished - - - - - If set, then raise an exception when the object is accessed after being disposed. - - - - - An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified - - - - - Matches the version of the connection. - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. Matches the base schema name used by the - associated connection. - - - - - Internal constructor, initializes the datareader and sets up to begin executing statements - - The SQLiteCommand this data reader is for - The expected behavior of the data reader - - - - Dispose of all resources used by this datareader. - - - - - - Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified. - - - - - Throw an error if the datareader is closed - - - - - Throw an error if a row is not loaded - - - - - Enumerator support - - Returns a DbEnumerator object. - - - - Forces the connection flags cached by this data reader to be refreshed - from the underlying connection. - - - - - This method is used to make sure the result set is open and a row is currently available. - - - - - SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table - and the affinity of returned types are all we have to go on to type-restrict data in the reader. - - This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In - the case of columns that are not backed into a table definition, we attempt to match up the affinity of a column (int, double, string or blob) - to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do. - - - This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity. - - The index of the column to type-check - The type we want to get out of the column - - - - Invokes the data reader value callback configured for the database - type name associated with the specified column. If no data reader - value callback is available for the database type name, do nothing. - - - The index of the column being read. - - - The extra event data to pass into the callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - Attempts to query the integer identifier for the current row. This - will not work for tables that were created WITHOUT ROWID -OR- if the - query does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The index of the BLOB column. - - - The integer identifier for the current row -OR- null if it could not - be determined. - - - - - Retrieves the column as a object. - This will not work for tables that were created WITHOUT ROWID - -OR- if the query does not include the "rowid" column or one - of its aliases -OR- if the was - not created with the - flag. - - The index of the column. - - Non-zero to open the blob object for read-only access. - - A new object. - - - - Retrieves the column as a boolean value - - The index of the column. - bool - - - - Retrieves the column as a single byte value - - The index of the column. - byte - - - - Retrieves a column as an array of bytes (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the bytes into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of bytes written into the array - - To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned. - - - - - Returns the column as a single character - - The index of the column. - char - - - - Retrieves a column as an array of chars (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the characters into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of characters written into the array - - To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned. - - - - - Retrieves the name of the back-end datatype of the column - - The index of the column. - string - - - - Retrieve the column as a date/time value - - The index of the column. - DateTime - - - - Retrieve the column as a decimal value - - The index of the column. - decimal - - - - Returns the column as a double - - The index of the column. - double - - - - Determines and returns the of the - specified column. - - - The index of the column. - - - The associated with the specified - column, if any. - - - - - Returns the .NET type of a given column - - The index of the column. - Type - - - - Returns a column as a float value - - The index of the column. - float - - - - Returns the column as a Guid - - The index of the column. - Guid - - - - Returns the column as a short - - The index of the column. - Int16 - - - - Retrieves the column as an int - - The index of the column. - Int32 - - - - Retrieves the column as a long - - The index of the column. - Int64 - - - - Retrieves the name of the column - - The index of the column. - string - - - - Returns the name of the database associated with the specified column. - - The index of the column. - string - - - - Returns the name of the table associated with the specified column. - - The index of the column. - string - - - - Returns the original name of the specified column. - - The index of the column. - string - - - - Retrieves the i of a column, given its name - - The name of the column to retrieve - The int i of the column - - - - Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done - to gather the necessary information so it can be represented in an ADO.NET manner. - - Returns a DataTable containing the schema information for the active SELECT statement being processed. - - - - Retrieves the column as a string - - The index of the column. - string - - - - Retrieves the column as an object corresponding to the underlying datatype of the column - - The index of the column. - object - - - - Retreives the values of multiple columns, up to the size of the supplied array - - The array to fill with values from the columns in the current resultset - The number of columns retrieved - - - - Returns a collection containing all the column names and values for the - current row of data in the current resultset, if any. If there is no - current row or no current resultset, an exception may be thrown. - - - The collection containing the column name and value information for the - current row of data in the current resultset or null if this information - cannot be obtained. - - - - - Returns True if the specified column is null - - The index of the column. - True or False - - - - Moves to the next resultset in multiple row-returning SQL command. - - True if the command was successful and a new resultset is available, False otherwise. - - - - This method attempts to query the database connection associated with - the data reader in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Retrieves the SQLiteType for a given column and row value. - - - The original SQLiteType structure, based only on the column. - - - The textual value of the column for a given row. - - - The SQLiteType structure. - - - - - Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. - - The flags associated with the parent connection object. - The index of the column. - A SQLiteType structure - - - - Reads the next row from the resultset - - True if a new row was successfully loaded and is ready for processing - - - - Not implemented. Returns 0 - - - - - Returns the number of columns in the current resultset - - - - - Returns the number of rows seen so far in the current result set. - - - - - Returns the number of visible fields in the current resultset - - - - - Returns True if the resultset has rows that can be fetched - - - - - Returns True if the data reader is closed - - - - - Returns the number of rows affected by the statement being executed. - The value returned may not be accurate for DDL statements. Also, it - will be -1 for any statement that does not modify the database (e.g. - SELECT). If an otherwise read-only statement modifies the database - indirectly (e.g. via a virtual table or user-defined function), the - value returned is undefined. - - - - - Indexer to retrieve data from a column given its name - - The name of the column to retrieve data for - The value contained in the column - - - - Indexer to retrieve data from a column given its i - - The index of the column. - The value contained in the column - - - - SQLite exception class. - - - - - This value was copied from the "WinError.h" file included with the - Platform SDK for Windows 10. - - - - - Private constructor for use with serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - Public constructor for generating a SQLite exception given the error - code and message. - - - The SQLite return code to report. - - - Message text to go along with the return code message text. - - - - - Public constructor that uses the base class constructor for the error - message. - - Error message text. - - - - Public constructor that uses the default base class constructor. - - - - - Public constructor that uses the base class constructor for the error - message and inner exception. - - Error message text. - The original (inner) exception. - - - - Adds extra information to the serialized object data specific to this - class type. This is only used for serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - This method performs extra initialization tasks. It may be called by - any of the constructors of this class. It must not throw exceptions. - - - - - Maps a Win32 error code to an HRESULT. - - - The specified Win32 error code. It must be within the range of zero - (0) to 0xFFFF (65535). - - - Non-zero if the HRESULT should indicate success; otherwise, zero. - - - The integer value of the HRESULT. - - - - - Attempts to map the specified onto an - existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The - mappings may not have perfectly matching semantics; however, they do - have the benefit of being unique within the context of this exception - type. - - - The to map. - - - The integer HRESULT value -OR- null if there is no known mapping. - - - - - Returns the error message for the specified SQLite return code. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns the composite error message based on the SQLite return code - and the optional detailed error message. - - The SQLite return code. - Optional detailed error message. - Error message text for the return code. - - - - Gets the associated SQLite result code for this exception as a - . This property returns the same - underlying value as the property. - - - - - Gets the associated SQLite return code for this exception as an - . For desktop versions of the .NET Framework, - this property overrides the property of the same name within the - - class. This property returns the same underlying value as the - property. - - - - - SQLite error codes. Actually, this enumeration represents a return code, - which may also indicate success in one of several ways (e.g. SQLITE_OK, - SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is - something of a misnomer. - - - - - The error code is unknown. This error code - is only used by the managed wrapper itself. - - - - - Successful result - - - - - SQL error or missing database - - - - - Internal logic error in SQLite - - - - - Access permission denied - - - - - Callback routine requested an abort - - - - - The database file is locked - - - - - A table in the database is locked - - - - - A malloc() failed - - - - - Attempt to write a readonly database - - - - - Operation terminated by sqlite3_interrupt() - - - - - Some kind of disk I/O error occurred - - - - - The database disk image is malformed - - - - - Unknown opcode in sqlite3_file_control() - - - - - Insertion failed because database is full - - - - - Unable to open the database file - - - - - Database lock protocol error - - - - - Database is empty - - - - - The database schema changed - - - - - String or BLOB exceeds size limit - - - - - Abort due to constraint violation - - - - - Data type mismatch - - - - - Library used incorrectly - - - - - Uses OS features not supported on host - - - - - Authorization denied - - - - - Auxiliary database format error - - - - - 2nd parameter to sqlite3_bind out of range - - - - - File opened that is not a database file - - - - - Notifications from sqlite3_log() - - - - - Warnings from sqlite3_log() - - - - - sqlite3_step() has another row ready - - - - - sqlite3_step() has finished executing - - - - - Used to mask off extended result codes - - - - - A collation sequence was referenced by a schema and it cannot be - found. - - - - - An internal operation failed and it may succeed if retried. - - - - - The specified snapshot has been overwritten by a checkpoint. - - - - - A file read operation failed. - - - - - A file read operation returned less data than requested. - - - - - A file write operation failed. - - - - - A file synchronization operation failed. - - - - - A directory synchronization operation failed. - - - - - A file truncate operation failed. - - - - - A file metadata operation failed. - - - - - A file unlock operation failed. - - - - - A file lock operation failed. - - - - - A file delete operation failed. - - - - - Not currently used. - - - - - Out-of-memory during a file operation. - - - - - A file existence/status operation failed. - - - - - A check for a reserved lock failed. - - - - - A file lock operation failed. - - - - - A file close operation failed. - - - - - A directory close operation failed. - - - - - A shared memory open operation failed. - - - - - A shared memory size operation failed. - - - - - A shared memory lock operation failed. - - - - - A shared memory map operation failed. - - - - - A file seek operation failed. - - - - - A file delete operation failed because it does not exist. - - - - - A file memory mapping operation failed. - - - - - The temporary directory path could not be obtained. - - - - - A path string conversion operation failed. - - - - - Reserved. - - - - - An attempt to authenticate failed. - - - - - An attempt to begin a file system transaction failed. - - - - - An attempt to commit a file system transaction failed. - - - - - An attempt to rollback a file system transaction failed. - - - - - A database table is locked in shared-cache mode. - - - - - A virtual table in the database is locked. - - - - - A database file is locked due to a recovery operation. - - - - - A database file is locked due to snapshot semantics. - - - - - A database file cannot be opened because no temporary directory is available. - - - - - A database file cannot be opened because its path represents a directory. - - - - - A database file cannot be opened because its full path could not be obtained. - - - - - A database file cannot be opened because a path string conversion operation failed. - - - - - No longer used. - - - - - A database file is a symbolic link and cannot be opened. - - - - - A virtual table is malformed. - - - - - A required sequence table is missing or corrupt. - - - - - A database file is read-only due to a recovery operation. - - - - - A database file is read-only because a lock could not be obtained. - - - - - A database file is read-only because it needs rollback processing. - - - - - A database file is read-only because it was moved while open. - - - - - The shared-memory file is read-only and it should be read-write. - - - - - Unable to create journal file because the directory is read-only. - - - - - An operation is being aborted due to rollback processing. - - - - - A CHECK constraint failed. - - - - - A commit hook produced a unsuccessful return code. - - - - - A FOREIGN KEY constraint failed. - - - - - Not currently used. - - - - - A NOT NULL constraint failed. - - - - - A PRIMARY KEY constraint failed. - - - - - The RAISE function was used by a trigger-program. - - - - - A UNIQUE constraint failed. - - - - - Not currently used. - - - - - A ROWID constraint failed. - - - - - A database cursor is busy and cannot be moved. - - - - - Frames were recovered from the WAL log file. - - - - - Pages were recovered from the journal file. - - - - - An automatic index was created to process a query. - - - - - User authentication failed. - - - - - Success. Prevents the extension from unloading until the process - terminates. - - - - - Success. The specified file name refers to a symbolic link. - - - - - SQLite implementation of . - - - SQLite implementation of . - - - - - Constructs a new instance. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - - - Cleans up resources associated with the current instance. - - - - - Static instance member which returns an instanced class. - - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Will provide a object in .NET 3.5. - - The class or interface type to query for. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. This event is provided for backward compatibility only. - New code should use the class instead. - - - - - This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each - connection to the database. - - - Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access - to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database - calls during processing. - - It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class - services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement - information in member variables of user-defined function classes. - - For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will - be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes. - - - - - The base connection this function is attached to - - - - - Internal array used to keep track of aggregate function context data - - - - - The connection flags associated with this object (this should be the - same value as the flags associated with the parent connection object). - - - - - Holds a reference to the callback function for user functions - - - - - Holds a reference to the callbakc function for stepping in an aggregate function - - - - - Holds a reference to the callback function for finalizing an aggregate function - - - - - Holds a reference to the callback function for collating sequences - - - - - Current context of the current callback. Only valid during a callback - - - - - This static dictionary contains all the registered (known) user-defined - functions declared using the proper attributes. The contained dictionary - values are always null and are not currently used. - - - - - Internal constructor, initializes the function's internal variables. - - - - - Constructs an instance of this class using the specified data-type - conversion parameters. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - Non-zero to create a UTF-16 data-type conversion context; otherwise, - a UTF-8 data-type conversion context will be created. - - - - - Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if - someone closes the connection while a DataReader is open. - - - - - Placeholder for a user-defined disposal routine - - True if the object is being disposed explicitly - - - - Cleans up resources associated with the current instance. - - - - - Scalar functions override this method to do their magic. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The arguments for the command to process - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - Aggregate functions override this method to do their magic. - - - Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible. - - The arguments for the command to process - The 1-based step number. This is incrememted each time the step method is called. - A placeholder for implementers to store contextual data pertaining to the current context. - - - - Aggregate functions override this method to finish their aggregate processing. - - - If you implemented your aggregate function properly, - you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have - all the information you need in there to figure out what to return. - NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will - be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value - if that is the case. - - Your own assigned contextData, provided for you so you can return your final results. - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - - User-defined collating sequences override this method to provide a custom string sorting algorithm. - - The first string to compare. - The second strnig to compare. - 1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2. - - - - Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The number of arguments - A pointer to the array of arguments - An object array of the arguments once they've been converted to .NET values - - - - Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context. - - The context the return value applies to - The parameter to return to SQLite - - - - Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method. - WARNING: Must not throw exceptions. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method. - WARNING: Must not throw exceptions. - - - This function takes care of doing the lookups and getting the important information put together to call the Step() function. - That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so - binary searches can be done to find the data. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method. - WARNING: Must not throw exceptions. - - A raw context pointer - - - - Using reflection, enumerate all assemblies in the current appdomain looking for classes that - have a SQLiteFunctionAttribute attribute, and registering them accordingly. - - - - - Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work - properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported. - - The type of the function to register - - - - Alternative method of registering a function. This method - does not require the specified type to be annotated with - . - - - The name of the function to register. - - - The number of arguments accepted by the function. - - - The type of SQLite function being resitered (e.g. scalar, - aggregate, or collating sequence). - - - The that actually implements the function. - This will only be used if the - and parameters are null. - - - The to be used for all calls into the - , - , - and virtual methods. - - - The to be used for all calls into the - virtual method. This - parameter is only necessary for aggregate functions. - - - - - Replaces a registered function, disposing of the associated (old) - value if necessary. - - - The attribute that describes the function to replace. - - - The new value to use. - - - Non-zero if an existing registered function was replaced; otherwise, - zero. - - - - - Creates a instance based on the specified - . - - - The containing the metadata about - the function to create. - - - The created function -OR- null if the function could not be created. - - - Non-zero if the function was created; otherwise, zero. - - - - - Called by the SQLiteBase derived classes, this method binds all registered (known) user-defined functions to a connection. - It is done this way so that all user-defined functions will access the database using the same encoding scheme - as the connection (UTF-8 or UTF-16). - - - The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to - all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks. - - The base object on which the functions are to bind. - The flags associated with the parent connection object. - Returns a logical list of functions which the connection should retain until it is closed. - - - - Called by the SQLiteBase derived classes, this method unbinds all registered (known) - functions -OR- all previously bound user-defined functions from a connection. - - The base object from which the functions are to be unbound. - The flags associated with the parent connection object. - - Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions - currently bound to the connection. - - Non-zero if all the specified user-defined functions were unbound. - - - - This function binds a user-defined function to a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined functions from a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert - strings and DateTime's into the current connection's encoding schema. - - - - - This type is used with the - method. - - - This is always the string literal "Invoke". - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This type is used with the - method. - - - This is always the string literal "Step". - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This type is used with the - method. - - - This is always the string literal "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This type is used with the - method. - - - This is always the string literal "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - This class implements a SQLite function using a . - All the virtual methods of the class are - implemented using calls to the , - , , - and strongly typed delegate types - or via the method. - The arguments are presented in the same order they appear in - the associated methods with one exception: - the first argument is the name of the virtual method being implemented. - - - - - This error message is used by the overridden virtual methods when - a required property (e.g. - or ) has not been - set. - - - - - This error message is used by the overridden - method when the result does not have a type of . - - - - - Constructs an empty instance of this class. - - - - - Constructs an instance of this class using the specified - as the - implementation. - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Invoke". - - - The original arguments received by the method. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Step". - - - The original arguments received by the method. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Updates the output arguments for the method, - using an of . The first - argument is always the literal string "Step". Currently, only the - parameter is updated. - - - The original arguments received by the method. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - This virtual method is the implementation for scalar functions. - See the method for more - details. - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This virtual method is part of the implementation for collating - sequences. See the method - for more details. - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call. - - - User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays. - - - - - Obtains the collating sequence in effect for the given function. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - The type of user-defined function to declare - - - - - Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc. - - - - - Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data. - Examples include SUM(), COUNT(), AVG(), etc. - - - - - Collating sequences are used to sort textual data in a custom manner, and appear in an ORDER BY clause. Typically text in an ORDER BY is - sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting - in a user-defined manner. - - - - - An internal callback delegate declaration. - - Raw native context pointer for the user function. - Total number of arguments to the user function. - Raw native pointer to the array of raw native argument pointers. - - - - An internal final callback delegate declaration. - - Raw context pointer for the user function - - - - Internal callback delegate for implementing collating sequences - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. - - - - The type of collating sequence - - - - - The built-in BINARY collating sequence - - - - - The built-in NOCASE collating sequence - - - - - The built-in REVERSE collating sequence - - - - - A custom user-defined collating sequence - - - - - The encoding type the collation sequence uses - - - - - The collation sequence is UTF8 - - - - - The collation sequence is UTF16 little-endian - - - - - The collation sequence is UTF16 big-endian - - - - - A struct describing the collating sequence a function is executing in - - - - - The name of the collating sequence - - - - - The type of collating sequence - - - - - The text encoding of the collation sequence - - - - - Context of the function that requested the collating sequence - - - - - Calls the base collating sequence to compare two strings - - The first string to compare - The second string to compare - -1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2 - - - - Calls the base collating sequence to compare two character arrays - - The first array to compare - The second array to compare - -1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2 - - - - A simple custom attribute to enable us to easily find user-defined functions in - the loaded assemblies and initialize them in SQLite as connections are made. - - - - - Default constructor, initializes the internal variables for the function. - - - - - Constructs an instance of this class. This sets the initial - , , and - properties to null. - - - The name of the function, as seen by the SQLite core library. - - - The number of arguments that the function will accept. - - - The type of function being declared. This will either be Scalar, - Aggregate, or Collation. - - - - - The function's name as it will be used in SQLite command text. - - - - - The number of arguments this function expects. -1 if the number of arguments is variable. - - - - - The type of function this implementation will be. - - - - - The object instance that describes the class - containing the implementation for the associated function. The value of - this property will not be used if either the or - property values are set to non-null. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - This class provides key info for a given SQLite statement. - - Providing key information for a given statement is non-trivial :( - - - - - - This function does all the nasty work at determining what keys need to be returned for - a given statement. - - - - - - - - Make sure all the subqueries are open and ready and sync'd with the current rowid - of the table they're supporting - - - - - Release any readers on any subqueries - - - - - Append all the columns we've added to the original query to the schema - - - - - - How many additional columns of keyinfo we're holding - - - - - Used to support CommandBehavior.KeyInfo - - - - - Used to keep track of the per-table RowId column metadata. - - - - - A single sub-query for a given table/database. - - - - - Event data for logging event handlers. - - - - - The error code. The type of this object value should be - or . - - - - - SQL statement text as the statement first begins executing - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - Should be null. - - The error code. The type of this object value should be - or . - - The error message, if any. - The extra data, if any. - - - - Raised when a log event occurs. - - The current connection - Event arguments of the trace - - - - Manages the SQLite custom logging functionality and the associated - callback for the whole process. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - Member variable to store the AppDomain.DomainUnload event handler. - - - - - The default log event handler. - - - - - The log callback passed to native SQLite engine. This must live - as long as the SQLite library has a pointer to it. - - - - - The base SQLite object to interop with. - - - - - The number of times that the - has been called when the logging subystem was actually eligible - to be initialized (i.e. without the "No_SQLiteLog" environment - variable being set). - - - - - This will be non-zero if an attempt was already made to initialize - the (managed) logging subsystem. - - - - - This will be non-zero if logging is currently enabled. - - - - - Initializes the SQLite logging facilities. - - - - - Initializes the SQLite logging facilities. - - - The name of the managed class that called this method. This - parameter may be null. - - - - - Handles the AppDomain being unloaded. - - Should be null. - The data associated with this event. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The SQLite error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The integer error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - - The error code. The type of this object value should be - System.Int32 or SQLiteErrorCode. - - The message to be logged. - - - - Creates and initializes the default log event handler. - - - - - Adds the default log event handler to the list of handlers. - - - - - Removes the default log event handler from the list of handlers. - - - - - Internal proxy function that calls any registered application log - event handlers. - - WARNING: This method is used more-or-less directly by native code, - do not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - Default logger. Currently, uses the Trace class (i.e. sends events - to the current trace listeners, if any). - - Should be null. - The data associated with this event. - - - - Member variable to store the application log handler to call. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. - - - - - If this property is true, logging is enabled; otherwise, logging is - disabled. When logging is disabled, no logging events will fire. - - - - - MetaDataCollections specific to SQLite - - - - - Returns a list of databases attached to the connection - - - - - Returns column information for the specified table - - - - - Returns index information for the optionally-specified table - - - - - Returns base columns for the given index - - - - - Returns the tables in the given catalog - - - - - Returns user-defined views in the given catalog - - - - - Returns underlying column information on the given view - - - - - Returns foreign key information for the given catalog - - - - - Returns the triggers on the database - - - - - SQLite implementation of DbParameter. - - - - - This value represents an "unknown" . - - - - - The command associated with this parameter. - - - - - The data type of the parameter - - - - - The version information for mapping the parameter - - - - - The value of the data in the parameter - - - - - The source column for the parameter - - - - - The column name - - - - - The data size, unused by SQLite - - - - - The database type name associated with this parameter, if any. - - - - - Constructor used when creating for use with a specific command. - - - The command associated with this parameter. - - - - - Default constructor - - - - - Constructs a named parameter given the specified parameter name - - The parameter name - - - - Constructs a named parameter given the specified parameter name and initial value - - The parameter name - The initial value of the parameter - - - - Constructs a named parameter of the specified type - - The parameter name - The datatype of the parameter - - - - Constructs a named parameter of the specified type and source column reference - - The parameter name - The data type - The source column - - - - Constructs a named parameter of the specified type, source column and row version - - The parameter name - The data type - The source column - The row version information - - - - Constructs an unnamed parameter of the specified data type - - The datatype of the parameter - - - - Constructs an unnamed parameter of the specified data type and sets the initial value - - The datatype of the parameter - The initial value of the parameter - - - - Constructs an unnamed parameter of the specified data type and source column - - The datatype of the parameter - The source column - - - - Constructs an unnamed parameter of the specified data type, source column and row version - - The data type - The source column - The row version information - - - - Constructs a named parameter of the specified type and size - - The parameter name - The data type - The size of the parameter - - - - Constructs a named parameter of the specified type, size and source column - - The name of the parameter - The data type - The size of the parameter - The source column - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - The source column - The row version information - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - Ignored - The source column - The row version information - The initial value to assign the parameter - - - - Constructs a named parameter, yet another flavor - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - The source column - The row version information - Whether or not this parameter is for comparing NULL's - The intial value to assign the parameter - - - - Constructs an unnamed parameter of the specified type and size - - The data type - The size of the parameter - - - - Constructs an unnamed parameter of the specified type, size, and source column - - The data type - The size of the parameter - The source column - - - - Constructs an unnamed parameter of the specified type, size, source column and row version - - The data type - The size of the parameter - The source column - The row version information - - - - Resets the DbType of the parameter so it can be inferred from the value - - - - - Clones a parameter - - A new, unassociated SQLiteParameter - - - - The command associated with this parameter. - - - - - Whether or not the parameter can contain a null value - - - - - Returns the datatype of the parameter - - - - - Supports only input parameters - - - - - Returns the parameter name - - - - - Returns the size of the parameter - - - - - Gets/sets the source column - - - - - Used by DbCommandBuilder to determine the mapping for nullable fields - - - - - Gets and sets the row version - - - - - Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. - - - - - The database type name associated with this parameter, if any. - - - - - SQLite implementation of DbParameterCollection. - - - - - The underlying command to which this collection belongs - - - - - The internal array of parameters in this collection - - - - - Determines whether or not all parameters have been bound to their statement(s) - - - - - Initializes the collection - - The command to which the collection belongs - - - - Retrieves an enumerator for the collection - - An enumerator for the underlying array - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - The source column - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a named/unnamed parameter and its value to the parameter collection. - - Name of the parameter, or null to indicate an unnamed parameter - The initial value of the parameter - Returns the SQLiteParameter object created during the call. - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Clears the array and resets the collection - - - - - Determines if the named parameter exists in the collection - - The name of the parameter to check - True if the parameter is in the collection - - - - Determines if the parameter exists in the collection - - The SQLiteParameter to check - True if the parameter is in the collection - - - - Not implemented - - - - - - - Retrieve a parameter by name from the collection - - The name of the parameter to fetch - A DbParameter object - - - - Retrieves a parameter by its index in the collection - - The index of the parameter to retrieve - A DbParameter object - - - - Returns the index of a parameter given its name - - The name of the parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Returns the index of a parameter - - The parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Inserts a parameter into the array at the specified location - - The zero-based index to insert the parameter at - The parameter to insert - - - - Removes a parameter from the collection - - The parameter to remove - - - - Removes a parameter from the collection given its name - - The name of the parameter to remove - - - - Removes a parameter from the collection given its index - - The zero-based parameter index to remove - - - - Re-assign the named parameter to a new parameter object - - The name of the parameter to replace - The new parameter - - - - Re-assign a parameter at the specified index - - The zero-based index of the parameter to replace - The new parameter - - - - Un-binds all parameters from their statements - - - - - This function attempts to map all parameters in the collection to all statements in a Command. - Since named parameters may span multiple statements, this function makes sure all statements are bound - to the same named parameter. Unnamed parameters are bound in sequence. - - - - - Returns false - - - - - Returns false - - - - - Returns false - - - - - Returns null - - - - - Returns a count of parameters in the collection - - - - - Overloaded to specialize the return value of the default indexer - - Name of the parameter to get/set - The specified named SQLite parameter - - - - Overloaded to specialize the return value of the default indexer - - The index of the parameter to get/set - The specified SQLite parameter - - - - Represents a single SQL statement in SQLite. - - - - - The underlying SQLite object this statement is bound to - - - - - The command text of this SQL statement - - - - - The actual statement pointer - - - - - An index from which unnamed parameters begin - - - - - Names of the parameters as SQLite understands them to be - - - - - Parameters for this statement - - - - - Command this statement belongs to (if any) - - - - - The flags associated with the parent connection object. - - - - - Initializes the statement and attempts to get all information about parameters in the statement - - The base SQLite object - The flags associated with the parent connection object - The statement - The command text for this statement - The previous command in a multi-statement command - - - - Disposes and finalizes the statement - - - - - If the underlying database connection is open, fetches the number of changed rows - resulting from the most recent query; otherwise, does nothing. - - - The number of changes when true is returned. - Undefined if false is returned. - - - The read-only flag when true is returned. - Undefined if false is returned. - - Non-zero if the number of changed rows was fetched. - - - - Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to - this statement, and if so, keeps a reference to the parameter so it can be bound later. - - The parameter name to map - The parameter to assign it - - - - Bind all parameters, making sure the caller didn't miss any - - - - - This method attempts to query the database connection associated with - the statement in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Invokes the parameter binding callback configured for the database - type name associated with the specified column. If no parameter - binding callback is available for the database type name, do - nothing. - - - The index of the column being read. - - - The instance being bound to the - command. - - - Non-zero if the default handling for the parameter binding call - should be skipped (i.e. the parameter should not be bound at all). - Great care should be used when setting this to non-zero. - - - - - Perform the bind operation for an individual parameter - - The index of the parameter to bind - The parameter we're binding - - - - SQLite implementation of DbTransaction that does not support nested transactions. - - - - - Base class used by to implement DbTransaction for SQLite. - - - - - The connection to which this transaction is bound. - - - - - Matches the version of the connection. - - - - - The isolation level for this transaction. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Rolls back the active transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Checks the state of this transaction, optionally throwing an exception if a state - inconsistency is found. - - - Non-zero to throw an exception if a state inconsistency is found. - - - Non-zero if this transaction is valid; otherwise, false. - - - - - Gets the isolation level of the transaction. SQLite only supports Serializable transactions. - - - - - Returns the underlying connection to which this transaction applies. - - - - - Forwards to the local Connection property - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - SQLite implementation of DbTransaction that does support nested transactions. - - - - - The original transaction level for the associated connection - when this transaction was created (i.e. begun). - - - - - The SAVEPOINT name for this transaction, if any. This will - only be non-null if this transaction is a nested one. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Constructs the name of a new savepoint for this transaction. It - should only be called from the constructor of this class. - - - The name of the new savepoint -OR- null if it cannot be constructed. - - - - - This static class provides some methods that are shared between the - native library pre-loader and other classes. - - - - - This lock is used to protect the static and - fields. - - - - - This type is only present when running on Mono. - - - - - This type is only present when running on .NET Core. - - - - - Keeps track of whether we are running on Mono. Initially null, it is - set by the method on its first call. Later, it - is returned verbatim by the method. - - - - - Keeps track of whether we are running on .NET Core. Initially null, - it is set by the method on its first - call. Later, it is returned verbatim by the - method. - - - - - Keeps track of whether we successfully invoked the - method. Initially null, it is set by - the method on its first call. - - - - - Determines the ID of the current process. Only used for debugging. - - - The ID of the current process -OR- zero if it cannot be determined. - - - - - Determines whether or not this assembly is running on Mono. - - - Non-zero if this assembly is running on Mono. - - - - - Determines whether or not this assembly is running on .NET Core. - - - Non-zero if this assembly is running on .NET Core. - - - - - Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger" - configuration setting. - - - - - If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is - present (e.g. via the environment), give the interactive user an - opportunity to attach a debugger to the current process; otherwise, - do nothing. - - - - - Determines the ID of the current thread. Only used for debugging. - - - The ID of the current thread -OR- zero if it cannot be determined. - - - - - Determines if the specified flags are present within the flags - associated with the parent connection object. - - - The flags associated with the parent connection object. - - - The flags to check for. - - - Non-zero if the specified flag or flags were present; otherwise, - zero. - - - - - Determines if preparing a query should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the query preparation should be logged; otherwise, zero. - - - - - Determines if pre-parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the pre-parameter binding should be logged; otherwise, - zero. - - - - - Determines if parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the parameter binding should be logged; otherwise, zero. - - - - - Determines if an exception in a native callback should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be logged; otherwise, zero. - - - - - Determines if backup API errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the backup API error should be logged; otherwise, zero. - - - - - Determines if logging for the class is - disabled. - - - The flags associated with the parent connection object. - - - Non-zero if logging for the class is - disabled; otherwise, zero. - - - - - Determines if errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the error should be logged; - otherwise, zero. - - - - - Determines if exceptions should be - logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be - logged; otherwise, zero. - - - - - Determines if the current process is running on one of the Windows - [sub-]platforms. - - - Non-zero when running on Windows; otherwise, zero. - - - - - This is a wrapper around the - method. - On Mono, it has to call the method overload without the - parameter, due to a bug in Mono. - - - This is used for culture-specific formatting. - - - The format string. - - - An array the objects to format. - - - The resulting string. - - - - - This static class provides a thin wrapper around the native library - loading features of the underlying platform. - - - - - Attempts to load the specified native library file using the Win32 - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the Win32 API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file using the POSIX - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the POSIX API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - This delegate is used to wrap the concept of loading a native - library, based on a file name, and returning the loaded module - handle. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This delegate is used to wrap the concept of querying the machine - name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - This class declares P/Invoke methods to call native POSIX APIs. - - - - - For use with dlopen(), bind function calls lazily. - - - - - For use with dlopen(), bind function calls immediately. - - - - - For use with dlopen(), make symbols globally available. - - - - - For use with dlopen(), opposite of RTLD_GLOBAL, and the default. - - - - - For use with dlopen(), the defaults used by this class. - - - - - This is the P/Invoke method that wraps the native Unix uname - function. See the POSIX documentation for full details on what it - does. - - - Structure containing a preallocated byte buffer to fill with the - requested information. - - - Zero for success and less than zero upon failure. - - - - - This is the P/Invoke method that wraps the native Unix dlopen - function. See the POSIX documentation for full details on what it - does. - - - The name of the executable library. - - - This must be a combination of the individual bit flags RTLD_LAZY, - RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Unix dlclose - function. See the POSIX documentation for full details on what it - does. - - - The handle to the loaded native library. - - - Zero upon success -OR- non-zero on failure. - - - - - These are the characters used to separate the string fields within - the raw buffer returned by the P/Invoke method. - - - - - This method is a wrapper around the P/Invoke - method that extracts and returns the human readable strings from - the raw buffer. - - - This structure, which contains strings, will be filled based on the - data placed in the raw buffer returned by the - P/Invoke method. - - - Non-zero upon success; otherwise, zero. - - - - - This structure is used when running on POSIX operating systems - to store information about the current machine, including the - human readable name of the operating system as well as that of - the underlying hardware. - - - - - This structure is passed directly to the P/Invoke method to - obtain the information about the current machine, including - the human readable name of the operating system as well as - that of the underlying hardware. - - - - - This class declares P/Invoke methods to call native Win32 APIs. - - - - - This is the P/Invoke method that wraps the native Win32 LoadLibrary - function. See the MSDN documentation for full details on what it - does. - - - The name of the executable library. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Win32 GetSystemInfo - function. See the MSDN documentation for full details on what it - does. - - - The system information structure to be filled in by the function. - - - - - This enumeration contains the possible values for the processor - architecture field of the system information structure. - - - - - This structure contains information about the current computer. This - includes the processor type, page size, memory addresses, etc. - - - - - This class declares P/Invoke methods to call native SQLite APIs. - - - - - The file extension used for dynamic link libraries. - - - - - The file extension used for the XML configuration file. - - - - - This is the name of the XML configuration file specific to the - System.Data.SQLite assembly. - - - - - This is the XML configuratrion file token that will be replaced with - the qualified path to the directory containing the XML configuration - file. - - - - - This is the environment variable token that will be replaced with - the qualified path to the directory containing this assembly. - - - - - This is the environment variable token that will be replaced with an - abbreviation of the target framework attribute value associated with - this assembly. - - - - - This lock is used to protect the static _SQLiteNativeModuleFileName, - _SQLiteNativeModuleHandle, and processorArchitecturePlatforms fields. - - - - - This dictionary stores the mappings between target framework names - and their associated (NuGet) abbreviations. These mappings are only - used by the method. - - - - - This dictionary stores the mappings between processor architecture - names and platform names. These mappings are now used for two - purposes. First, they are used to determine if the assembly code - base should be used instead of the location, based upon whether one - or more of the named sub-directories exist within the assembly code - base. Second, they are used to assist in loading the appropriate - SQLite interop assembly into the current process. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable assembly directory. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable XML configuration file name. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - For now, this method simply calls the Initialize method. - - - - - Attempts to initialize this class by pre-loading the native SQLite - library for the processor architecture of the current process. - - - - - Combines two path strings. - - - The first path -OR- null. - - - The second path -OR- null. - - - The combined path string -OR- null if both of the original path - strings are null. - - - - - Resets the cached XML configuration file name value, thus forcing the - next call to method to rely - upon the method to fetch the - XML configuration file name. - - - - - Queries and returns the cached XML configuration file name for the - assembly containing the managed System.Data.SQLite components, if - available. If the cached XML configuration file name value is not - available, the method will - be used to obtain the XML configuration file name. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - Queries and returns the XML configuration file name for the assembly - containing the managed System.Data.SQLite components. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - If necessary, replaces all supported XML configuration file tokens - with their associated values. - - - The name of the XML configuration file being read. - - - A setting value read from the XML configuration file. - - - The value of the will all supported XML - configuration file tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the - specified XML configuration file. - - - The name of the XML configuration file to read. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - Non-zero to expand any environment variable references contained in - the setting value to be returned. This has no effect on the .NET - Compact Framework. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. - - - - - Attempts to determine the target framework attribute value that is - associated with the specified managed assembly, if applicable. - - - The managed assembly to read the target framework attribute value - from. - - - The value of the target framework attribute value for the specified - managed assembly -OR- null if it cannot be determined. If this - assembly was compiled with a version of the .NET Framework prior to - version 4.0, the value returned MAY reflect that version of the .NET - Framework instead of the one associated with the specified managed - assembly. - - - - - Accepts a long target framework attribute value and makes it into a - much shorter version, suitable for use with NuGet packages. - - - The long target framework attribute value to convert. - - - The short target framework attribute value -OR- null if it cannot - be determined or converted. - - - - - If necessary, replaces all supported environment variable tokens - with their associated values. - - - A setting value read from an environment variable. - - - The value of the will all supported - environment variable tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the XML - configuration file and/or the environment variables for the current - process and/or the current system, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. By default, all references to existing - environment variables will be expanded to their corresponding values - within the value to be returned unless either the "No_Expand" or - "No_Expand_" environment variable is set [to - anything]. - - - - - Resets the cached assembly directory value, thus forcing the next - call to method to rely - upon the method to fetch the - assembly directory. - - - - - Queries and returns the cached directory for the assembly currently - being executed, if available. If the cached assembly directory value - is not available, the method will - be used to obtain the assembly directory. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - Queries and returns the directory for the assembly currently being - executed. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - The name of the environment variable containing the processor - architecture of the current process. - - - - - The native module file name for the native SQLite library or null. - - - - - The native module handle for the native SQLite library or the value - IntPtr.Zero. - - - - - Determines the base file name (without any directory information) - for the native SQLite library to be pre-loaded by this class. - - - The base file name for the native SQLite library to be pre-loaded by - this class -OR- null if its value cannot be determined. - - - - - Searches for the native SQLite library in the directory containing - the assembly currently being executed as well as the base directory - for the current application domain. - - - Upon success, this parameter will be modified to refer to the base - directory containing the native SQLite library. - - - Upon success, this parameter will be modified to refer to the name - of the immediate directory (i.e. the offset from the base directory) - containing the native SQLite library. - - - Upon success, this parameter will be modified to non-zero only if - the base directory itself should be allowed for loading the native - library. - - - Non-zero (success) if the native SQLite library was found; otherwise, - zero (failure). - - - - - Queries and returns the base directory of the current application - domain. - - - The base directory for the current application domain -OR- null if it - cannot be determined. - - - - - Determines if the dynamic link library file name requires a suffix - and adds it if necessary. - - - The original dynamic link library file name to inspect. - - - The dynamic link library file name, possibly modified to include an - extension. - - - - - Queries and returns the processor architecture of the current - process. - - - The processor architecture of the current process -OR- null if it - cannot be determined. - - - - - Given the processor architecture, returns the name of the platform. - - - The processor architecture to be translated to a platform name. - - - The platform name for the specified processor architecture -OR- null - if it cannot be determined. - - - - - Attempts to load the native SQLite library based on the specified - directory and processor architecture. - - - The base directory to use, null for default (the base directory of - the current application domain). This directory should contain the - processor architecture specific sub-directories. - - - The requested processor architecture, null for default (the - processor architecture of the current process). This caller should - almost always specify null for this parameter. - - - Non-zero indicates that the native SQLite library can be loaded - from the base directory itself. - - - The candidate native module file name to load will be stored here, - if necessary. - - - The native module handle as returned by LoadLibrary will be stored - here, if necessary. This value will be IntPtr.Zero if the call to - LoadLibrary fails. - - - Non-zero if the native module was loaded successfully; otherwise, - zero. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to <?xml version="1.0" standalone="yes"?> - <DocumentElement> - <DataTypes> - <TypeName>smallint</TypeName> - <ProviderDbType>10</ProviderDbType> - <ColumnSize>5</ColumnSize> - <DataType>System.Int16</DataType> - <CreateFormat>smallint</CreateFormat> - <IsAutoIncrementable>false</IsAutoIncrementable> - <IsCaseSensitive>false</IsCaseSensitive> - <IsFixedLength>true</IsFixedLength> - <IsFixedPrecisionScale>true</IsFixedPrecisionScale> - <IsLong>false</IsLong> - <IsNullable>true</ [rest of string was truncated]";. - - - - - Looks up a localized string similar to ALL,ALTER,AND,AS,AUTOINCREMENT,BETWEEN,BY,CASE,CHECK,COLLATE,COMMIT,CONSTRAINT,CREATE,CROSS,DEFAULT,DEFERRABLE,DELETE,DISTINCT,DROP,ELSE,ESCAPE,EXCEPT,FOREIGN,FROM,FULL,GROUP,HAVING,IN,INDEX,INNER,INSERT,INTERSECT,INTO,IS,ISNULL,JOIN,LEFT,LIMIT,NATURAL,NOT,NOTNULL,NULL,ON,OR,ORDER,OUTER,PRIMARY,REFERENCES,RIGHT,ROLLBACK,SELECT,SET,TABLE,THEN,TO,TRANSACTION,UNION,UNIQUE,UPDATE,USING,VALUES,WHEN,WHERE. - - - - - Looks up a localized string similar to <?xml version="1.0" encoding="utf-8" ?> - <DocumentElement> - <MetaDataCollections> - <CollectionName>MetaDataCollections</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataCollections> - <CollectionName>DataSourceInformation</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataC [rest of string was truncated]";. - - - - - This interface represents a virtual table implementation written in - native code. - - - - - - int (*xCreate)(sqlite3 *db, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xCreate method is called to create a new instance of a virtual table - in response to a CREATE VIRTUAL TABLE statement. - If the xCreate method is the same pointer as the xConnect method, then the - virtual table is an eponymous virtual table. - If the xCreate method is omitted (if it is a NULL pointer) then the virtual - table is an eponymous-only virtual table. - - - The db parameter is a pointer to the SQLite database connection that - is executing the CREATE VIRTUAL TABLE statement. - The pAux argument is the copy of the client data pointer that was the - fourth argument to the sqlite3_create_module() or - sqlite3_create_module_v2() call that registered the - virtual table module. - The argv parameter is an array of argc pointers to null terminated strings. - The first string, argv[0], is the name of the module being invoked. The - module name is the name provided as the second argument to - sqlite3_create_module() and as the argument to the USING clause of the - CREATE VIRTUAL TABLE statement that is running. - The second, argv[1], is the name of the database in which the new virtual table is being created. The database name is "main" for the primary database, or - "temp" for TEMP database, or the name given at the end of the ATTACH - statement for attached databases. The third element of the array, argv[2], - is the name of the new virtual table, as specified following the TABLE - keyword in the CREATE VIRTUAL TABLE statement. - If present, the fourth and subsequent strings in the argv[] array report - the arguments to the module name in the CREATE VIRTUAL TABLE statement. - - - The job of this method is to construct the new virtual table object - (an sqlite3_vtab object) and return a pointer to it in *ppVTab. - - - As part of the task of creating a new sqlite3_vtab structure, this - method must invoke sqlite3_declare_vtab() to tell the SQLite - core about the columns and datatypes in the virtual table. - The sqlite3_declare_vtab() API has the following prototype: - - - int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) - - - The first argument to sqlite3_declare_vtab() must be the same - database connection pointer as the first parameter to this method. - The second argument to sqlite3_declare_vtab() must a zero-terminated - UTF-8 string that contains a well-formed CREATE TABLE statement that - defines the columns in the virtual table and their data types. - The name of the table in this CREATE TABLE statement is ignored, - as are all constraints. Only the column names and datatypes matter. - The CREATE TABLE statement string need not to be - held in persistent memory. The string can be - deallocated and/or reused as soon as the sqlite3_declare_vtab() - routine returns. - - - The xCreate method need not initialize the pModule, nRef, and zErrMsg - fields of the sqlite3_vtab object. The SQLite core will take care of - that chore. - - - The xCreate should return SQLITE_OK if it is successful in - creating the new virtual table, or SQLITE_ERROR if it is not successful. - If not successful, the sqlite3_vtab structure must not be allocated. - An error message may optionally be returned in *pzErr if unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - If the xCreate method is omitted (left as a NULL pointer) then the - virtual table is an eponymous-only virtual table. New instances of - the virtual table cannot be created using CREATE VIRTUAL TABLE and the - virtual table can only be used via its module name. - Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand - eponymous-only virtual tables and will segfault if an attempt is made - to CREATE VIRTUAL TABLE on an eponymous-only virtual table because - the xCreate method was not checked for null. - - - If the xCreate method is the exact same pointer as the xConnect method, - that indicates that the virtual table does not need to initialize backing - store. Such a virtual table can be used as an eponymous virtual table - or as a named virtual table using CREATE VIRTUAL TABLE or both. - - - If a column datatype contains the special keyword "HIDDEN" - (in any combination of upper and lower case letters) then that keyword - it is omitted from the column datatype name and the column is marked - as a hidden column internally. - A hidden column differs from a normal column in three respects: - - - ]]> - ]]> Hidden columns are not listed in the dataset returned by - "PRAGMA table_info", - ]]>]]> Hidden columns are not included in the expansion of a "*" - expression in the result set of a SELECT, and - ]]>]]> Hidden columns are not included in the implicit column-list - used by an INSERT statement that lacks an explicit column-list. - ]]>]]> - - - For example, if the following SQL is passed to sqlite3_declare_vtab(): - - - CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden); - - - Then the virtual table would be created with two hidden columns, - and with datatypes of "VARCHAR(12)" and "INTEGER". - - - An example use of hidden columns can be seen in the FTS3 virtual - table implementation, where every FTS virtual table - contains an FTS hidden column that is used to pass information from the - virtual table into FTS auxiliary functions and to the FTS MATCH operator. - - - A virtual table that contains hidden columns can be used like - a table-valued function in the FROM clause of a SELECT statement. - The arguments to the table-valued function become constraints on - the HIDDEN columns of the virtual table. - - - For example, the "generate_series" extension (located in the - ext/misc/series.c - file in the source tree) - implements an eponymous virtual table with the following schema: - - - CREATE TABLE generate_series( - value, - start HIDDEN, - stop HIDDEN, - step HIDDEN - ); - - - The sqlite3_module.xBestIndex method in the implementation of this - table checks for equality constraints against the HIDDEN columns, and uses - those as input parameters to determine the range of integer "value" outputs - to generate. Reasonable defaults are used for any unconstrained columns. - For example, to list all integers between 5 and 50: - - - SELECT value FROM generate_series(5,50); - - - The previous query is equivalent to the following: - - - SELECT value FROM generate_series WHERE start=5 AND stop=50; - - - Arguments on the virtual table name are matched to hidden columns - in order. The number of arguments can be less than the - number of hidden columns, in which case the latter hidden columns are - unconstrained. However, an error results if there are more arguments - than there are hidden columns in the virtual table. - - - Beginning with SQLite version 3.14.0 (2016-08-08), - the CREATE TABLE statement that - is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause. - This is useful for cases where the virtual table rows - cannot easily be mapped into unique integers. A CREATE TABLE - statement that includes WITHOUT ROWID must define one or more columns as - the PRIMARY KEY. Every column of the PRIMARY KEY must individually be - NOT NULL and all columns for each row must be collectively unique. - - - Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID - virtual table. Enforcement is the responsibility of the underlying - virtual table implementation. But SQLite does assume that the PRIMARY KEY - constraint is valid - that the identified columns really are UNIQUE and - NOT NULL - and it uses that assumption to optimize queries against the - virtual table. - - - The rowid column is not accessible on a - WITHOUT ROWID virtual table (of course). - - - The xUpdate method was originally designed around having a - ROWID as a single value. The xUpdate method has been expanded to - accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the - PRIMARY KEY must still be only one column. For this reason, SQLite - will reject any WITHOUT ROWID virtual table that has more than one - PRIMARY KEY column and a non-NULL xUpdate method. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - int (*xConnect)(sqlite3*, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xConnect method is very similar to xCreate. - It has the same parameters and constructs a new sqlite3_vtab structure - just like xCreate. - And it must also call sqlite3_declare_vtab() like xCreate. - - - The difference is that xConnect is called to establish a new - connection to an existing virtual table whereas xCreate is called - to create a new virtual table from scratch. - - - The xCreate and xConnect methods are only different when the - virtual table has some kind of backing store that must be initialized - the first time the virtual table is created. The xCreate method creates - and initializes the backing store. The xConnect method just connects - to an existing backing store. When xCreate and xConnect are the same, - the table is an eponymous virtual table. - - - As an example, consider a virtual table implementation that - provides read-only access to existing comma-separated-value (CSV) - files on disk. There is no backing store that needs to be created - or initialized for such a virtual table (since the CSV files already - exist on disk) so the xCreate and xConnect methods will be identical - for that module. - - - Another example is a virtual table that implements a full-text index. - The xCreate method must create and initialize data structures to hold - the dictionary and posting lists for that index. The xConnect method, - on the other hand, only has to locate and use an existing dictionary - and posting lists that were created by a prior xCreate call. - - - The xConnect method must return SQLITE_OK if it is successful - in creating the new virtual table, or SQLITE_ERROR if it is not - successful. If not successful, the sqlite3_vtab structure must not be - allocated. An error message may optionally be returned in *pzErr if - unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - The xConnect method is required for every virtual table implementation, - though the xCreate and xConnect pointers of the sqlite3_module object - may point to the same function if the virtual table does not need to - initialize backing store. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - SQLite uses the xBestIndex method of a virtual table module to determine - the best way to access the virtual table. - The xBestIndex method has a prototype like this: - - - int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); - - - The SQLite core communicates with the xBestIndex method by filling - in certain fields of the sqlite3_index_info structure and passing a - pointer to that structure into xBestIndex as the second parameter. - The xBestIndex method fills out other fields of this structure which - forms the reply. The sqlite3_index_info structure looks like this: - - - struct sqlite3_index_info { - /* Inputs */ - const int nConstraint; /* Number of entries in aConstraint */ - const struct sqlite3_index_constraint { - int iColumn; /* Column constrained. -1 for ROWID */ - unsigned char op; /* Constraint operator */ - unsigned char usable; /* True if this constraint is usable */ - int iTermOffset; /* Used internally - xBestIndex should ignore */ - } *const aConstraint; /* Table of WHERE clause constraints */ - const int nOrderBy; /* Number of terms in the ORDER BY clause */ - const struct sqlite3_index_orderby { - int iColumn; /* Column number */ - unsigned char desc; /* True for DESC. False for ASC. */ - } *const aOrderBy; /* The ORDER BY clause */ - /* Outputs */ - struct sqlite3_index_constraint_usage { - int argvIndex; /* if >0, constraint is part of argv to xFilter */ - unsigned char omit; /* Do not code a test for this constraint */ - } *const aConstraintUsage; - int idxNum; /* Number used to identify the index */ - char *idxStr; /* String, possibly obtained from sqlite3_malloc */ - int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ - int orderByConsumed; /* True if output is already ordered */ - double estimatedCost; /* Estimated cost of using this index */ - ]]>/* Fields below are only available in SQLite 3.8.2 and later */]]> - sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ - ]]>/* Fields below are only available in SQLite 3.9.0 and later */]]> - int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ - ]]>/* Fields below are only available in SQLite 3.10.0 and later */]]> - sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ - }; - - - Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields. - These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively. - Any extension that reads or writes these fields must first check that the - version of the SQLite library in use is greater than or equal to appropriate - version - perhaps comparing the value returned from sqlite3_libversion_number() - against constants 3008002, 3009000, and/or 3010000. The result of attempting - to access these fields in an sqlite3_index_info structure created by an - older version of SQLite are undefined. - - - In addition, there are some defined constants: - - - #define SQLITE_INDEX_CONSTRAINT_EQ 2 - #define SQLITE_INDEX_CONSTRAINT_GT 4 - #define SQLITE_INDEX_CONSTRAINT_LE 8 - #define SQLITE_INDEX_CONSTRAINT_LT 16 - #define SQLITE_INDEX_CONSTRAINT_GE 32 - #define SQLITE_INDEX_CONSTRAINT_MATCH 64 - #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */ - #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ - - - The SQLite core calls the xBestIndex method when it is compiling a query - that involves a virtual table. In other words, SQLite calls this method - when it is running sqlite3_prepare() or the equivalent. - By calling this method, the - SQLite core is saying to the virtual table that it needs to access - some subset of the rows in the virtual table and it wants to know the - most efficient way to do that access. The xBestIndex method replies - with information that the SQLite core can then use to conduct an - efficient search of the virtual table. - - - While compiling a single SQL query, the SQLite core might call - xBestIndex multiple times with different settings in sqlite3_index_info. - The SQLite core will then select the combination that appears to - give the best performance. - - - Before calling this method, the SQLite core initializes an instance - of the sqlite3_index_info structure with information about the - query that it is currently trying to process. This information - derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses - of the query, but also from any ON or USING clauses if the query is a - join. The information that the SQLite core provides to the xBestIndex - method is held in the part of the structure that is marked as "Inputs". - The "Outputs" section is initialized to zero. - - - The information in the sqlite3_index_info structure is ephemeral - and may be overwritten or deallocated as soon as the xBestIndex method - returns. If the xBestIndex method needs to remember any part of the - sqlite3_index_info structure, it should make a copy. Care must be - take to store the copy in a place where it will be deallocated, such - as in the idxStr field with needToFreeIdxStr set to 1. - - - Note that xBestIndex will always be called before xFilter, since - the idxNum and idxStr outputs from xBestIndex are required inputs to - xFilter. However, there is no guarantee that xFilter will be called - following a successful xBestIndex. - - - The xBestIndex method is required for every virtual table implementation. - - - The main thing that the SQLite core is trying to communicate to - the virtual table is the constraints that are available to limit - the number of rows that need to be searched. The aConstraint[] array - contains one entry for each constraint. There will be exactly - nConstraint entries in that array. - - - Each constraint will usually correspond to a term in the WHERE clause - or in a USING or ON clause that is of the form - - - column OP EXPR - - - Where "column" is a column in the virtual table, OP is an operator - like "=" or "<", and EXPR is an arbitrary expression. So, for example, - if the WHERE clause contained a term like this: - - - a = 5 - - - Then one of the constraints would be on the "a" column with - operator "=" and an expression of "5". Constraints need not have a - literal representation of the WHERE clause. The query optimizer might - make transformations to the - WHERE clause in order to extract as many constraints - as it can. So, for example, if the WHERE clause contained something - like this: - - - x BETWEEN 10 AND 100 AND 999>y - - - The query optimizer might translate this into three separate constraints: - - - x >= 10 - x <= 100 - y < 999 - - - For each such constraint, the aConstraint[].iColumn field indicates which - column appears on the left-hand side of the constraint. - The first column of the virtual table is column 0. - The rowid of the virtual table is column -1. - The aConstraint[].op field indicates which operator is used. - The SQLITE_INDEX_CONSTRAINT_* constants map integer constants - into operator values. - Columns occur in the order they were defined by the call to - sqlite3_declare_vtab() in the xCreate or xConnect method. - Hidden columns are counted when determining the column index. - - - If the xFindFunction() method for the virtual table is defined, and - if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, then the constraints might also be of the form: - - - FUNCTION( column, EXPR) - - - In this case the aConstraint[].op value is the same as the value - returned by xFindFunction() for FUNCTION. - - - The aConstraint[] array contains information about all constraints - that apply to the virtual table. But some of the constraints might - not be usable because of the way tables are ordered in a join. - The xBestIndex method must therefore only consider constraints - that have an aConstraint[].usable flag which is true. - - - In addition to WHERE clause constraints, the SQLite core also - tells the xBestIndex method about the ORDER BY clause. - (In an aggregate query, the SQLite core might put in GROUP BY clause - information in place of the ORDER BY clause information, but this fact - should not make any difference to the xBestIndex method.) - If all terms of the ORDER BY clause are columns in the virtual table, - then nOrderBy will be the number of terms in the ORDER BY clause - and the aOrderBy[] array will identify the column for each term - in the order by clause and whether or not that column is ASC or DESC. - - - In SQLite version 3.10.0 (2016-01-06) and later, - the colUsed field is available - to indicate which fields of the virtual table are actually used by the - statement being prepared. If the lowest bit of colUsed is set, that - means that the first column is used. The second lowest bit corresponds - to the second column. And so forth. If the most significant bit of - colUsed is set, that means that one or more columns other than the - first 63 columns are used. If column usage information is needed by the - xFilter method, then the required bits must be encoded into either - the idxNum or idxStr output fields. - - - Given all of the information above, the job of the xBestIndex - method it to figure out the best way to search the virtual table. - - - The xBestIndex method fills the idxNum and idxStr fields with - information that communicates an indexing strategy to the xFilter - method. The information in idxNum and idxStr is arbitrary as far - as the SQLite core is concerned. The SQLite core just copies the - information through to the xFilter method. Any desired meaning can - be assigned to idxNum and idxStr as long as xBestIndex and xFilter - agree on what that meaning is. - - - The idxStr value may be a string obtained from an SQLite - memory allocation function such as sqlite3_mprintf(). - If this is the case, then the needToFreeIdxStr flag must be set to - true so that the SQLite core will know to call sqlite3_free() on - that string when it has finished with it, and thus avoid a memory leak. - The idxStr value may also be a static constant string, in which case - the needToFreeIdxStr boolean should remain false. - - - If the virtual table will output rows in the order specified by - the ORDER BY clause, then the orderByConsumed flag may be set to - true. If the output is not automatically in the correct order - then orderByConsumed must be left in its default false setting. - This will indicate to the SQLite core that it will need to do a - separate sorting pass over the data after it comes out of the virtual table. - - - The estimatedCost field should be set to the estimated number - of disk access operations required to execute this query against - the virtual table. The SQLite core will often call xBestIndex - multiple times with different constraints, obtain multiple cost - estimates, then choose the query plan that gives the lowest estimate. - The SQLite core initializes estimatedCost to a very large value - prior to invoking xBestIndex, so if xBestIndex determines that the - current combination of parameters is undesirable, it can leave the - estimatedCost field unchanged to discourage its use. - - - If the current version of SQLite is 3.8.2 or greater, the estimatedRows - field may be set to an estimate of the number of rows returned by the - proposed query plan. If this value is not explicitly set, the default - estimate of 25 rows is used. - - - If the current version of SQLite is 3.9.0 or greater, the idxFlags field - may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table - will return only zero or one rows given the input constraints. Additional - bits of the idxFlags field might be understood in later versions of SQLite. - - - The aConstraintUsage[] array contains one element for each of - the nConstraint constraints in the inputs section of the - sqlite3_index_info structure. - The aConstraintUsage[] array is used by xBestIndex to tell the - core how it is using the constraints. - - - The xBestIndex method may set aConstraintUsage[].argvIndex - entries to values greater than zero. - Exactly one entry should be set to 1, another to 2, another to 3, - and so forth up to as many or as few as the xBestIndex method wants. - The EXPR of the corresponding constraints will then be passed - in as the argv[] parameters to xFilter. - - - For example, if the aConstraint[3].argvIndex is set to 1, then - when xFilter is called, the argv[0] passed to xFilter will have - the EXPR value of the aConstraint[3] constraint. - - - By default, the SQLite core double checks all constraints on - each row of the virtual table that it receives. If such a check - is redundant, the xBestFilter method can suppress that double-check by - setting aConstraintUsage[].omit. - - - The xBestIndex method should return SQLITE_OK on success. If any - kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM) - should be returned instead. - - - If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an - error. Rather, SQLITE_CONSTRAINT indicates that the particular combination - of input parameters specified should not be used in the query plan. - The SQLITE_CONSTRAINT return is useful for table-valued functions that - have required parameters. If the aConstraint[].usable field is false - for one of the required parameter, then the xBestIndex method should - return SQLITE_CONSTRAINT. - - - The following example will better illustrate the use of SQLITE_CONSTRAINT - as a return value from xBestIndex: - - - SELECT * FROM realtab, tablevaluedfunc(realtab.x); - - - Assuming that the first hidden column of "tablevaluedfunc" is "param1", - the query above is semantically equivalent to this: - - - SELECT * FROM realtab, tablevaluedfunc - WHERE tablevaluedfunc.param1 = realtab.x; - - - The query planner must decide between many possible implementations - of this query, but two plans in particular are of note: - - ]]> - ]]>Scan all - rows of realtab and for each row, find rows in tablevaluedfunc where - param1 is equal to realtab.x - ]]>]]>Scan all rows of tablevalued func and for each row find rows - in realtab where x is equal to tablevaluedfunc.param1. - ]]>]]> - - The xBestIndex method will be invoked once for each of the potential - plans above. For plan 1, the aConstraint[].usable flag for for the - SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because - the right-hand side value for the "param1 = ?" constraint will be known, - since it is determined by the outer realtab loop. - But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false - because the right-hand side value is determined by an inner loop and is thus - an unknown quantity. Because param1 is a required input to the table-valued - functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented - with plan 2, indicating that a required input is missing. This forces the - query planner to select plan 1. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_index_info structure. - - - A standard SQLite return code. - - - - - - int (*xDisconnect)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table. - Only the sqlite3_vtab object is destroyed. - The virtual table is not destroyed and any backing store - associated with the virtual table persists. - - This method undoes the work of xConnect. - - This method is a destructor for a connection to the virtual table. - Contrast this method with xDestroy. The xDestroy is a destructor - for the entire virtual table. - - - The xDisconnect method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xDestroy)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table, just like - the xDisconnect method, and it also destroys the underlying - table implementation. This method undoes the work of xCreate. - - - The xDisconnect method is called whenever a database connection - that uses a virtual table is closed. The xDestroy method is only - called when a DROP TABLE statement is executed against the virtual table. - - - The xDestroy method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); - - - The xOpen method creates a new cursor used for accessing (read and/or - writing) a virtual table. A successful invocation of this method - will allocate the memory for the sqlite3_vtab_cursor (or a subclass), - initialize the new object, and make *ppCursor point to the new object. - The successful call then returns SQLITE_OK. - - - For every successful call to this method, the SQLite core will - later invoke the xClose method to destroy - the allocated cursor. - - - The xOpen method need not initialize the pVtab field of the - sqlite3_vtab_cursor structure. The SQLite core will take care - of that chore automatically. - - - A virtual table implementation must be able to support an arbitrary - number of simultaneously open cursors. - - - When initially opened, the cursor is in an undefined state. - The SQLite core will invoke the xFilter method - on the cursor prior to any attempt to position or read from the cursor. - - - The xOpen method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xClose)(sqlite3_vtab_cursor*); - - - The xClose method closes a cursor previously opened by - xOpen. - The SQLite core will always call xClose once for each cursor opened - using xOpen. - - - This method must release all resources allocated by the - corresponding xOpen call. The routine will not be called again even if it - returns an error. The SQLite core will not use the - sqlite3_vtab_cursor again after it has been closed. - - - The xClose method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, - int argc, sqlite3_value **argv); - - - This method begins a search of a virtual table. - The first argument is a cursor opened by xOpen. - The next two arguments define a particular search index previously - chosen by xBestIndex. The specific meanings of idxNum and idxStr - are unimportant as long as xFilter and xBestIndex agree on what - that meaning is. - - - The xBestIndex function may have requested the values of - certain expressions using the aConstraintUsage[].argvIndex values - of the sqlite3_index_info structure. - Those values are passed to xFilter using the argc and argv parameters. - - - If the virtual table contains one or more rows that match the - search criteria, then the cursor must be left point at the first row. - Subsequent calls to xEof must return false (zero). - If there are no rows match, then the cursor must be left in a state - that will cause the xEof to return true (non-zero). - The SQLite engine will use - the xColumn and xRowid methods to access that row content. - The xNext method will be used to advance to the next row. - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xFilter method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Number used to help identify the selected index. - - - The native pointer to the UTF-8 encoded string containing the - string used to help identify the selected index. - - - The number of native pointers to sqlite3_value structures specified - in . - - - An array of native pointers to sqlite3_value structures containing - filtering criteria for the selected index. - - - A standard SQLite return code. - - - - - - int (*xNext)(sqlite3_vtab_cursor*); - - - The xNext method advances a virtual table cursor - to the next row of a result set initiated by xFilter. - If the cursor is already pointing at the last row when this - routine is called, then the cursor no longer points to valid - data and a subsequent call to the xEof method must return true (non-zero). - If the cursor is successfully advanced to another row of content, then - subsequent calls to xEof must return false (zero). - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xNext method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xEof)(sqlite3_vtab_cursor*); - - - The xEof method must return false (zero) if the specified cursor - currently points to a valid row of data, or true (non-zero) otherwise. - This method is called by the SQL engine immediately after each - xFilter and xNext invocation. - - - The xEof method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Non-zero if no more rows are available; zero otherwise. - - - - - - int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N); - - - The SQLite core invokes this method in order to find the value for - the N-th column of the current row. N is zero-based so the first column - is numbered 0. - The xColumn method may return its result back to SQLite using one of the - following interface: - - - ]]> - ]]> sqlite3_result_blob() - ]]>]]> sqlite3_result_double() - ]]>]]> sqlite3_result_int() - ]]>]]> sqlite3_result_int64() - ]]>]]> sqlite3_result_null() - ]]>]]> sqlite3_result_text() - ]]>]]> sqlite3_result_text16() - ]]>]]> sqlite3_result_text16le() - ]]>]]> sqlite3_result_text16be() - ]]>]]> sqlite3_result_zeroblob() - ]]>]]> - - - If the xColumn method implementation calls none of the functions above, - then the value of the column defaults to an SQL NULL. - - - To raise an error, the xColumn method should use one of the result_text() - methods to set the error message text, then return an appropriate - error code. The xColumn method must return SQLITE_OK on success. - - - The xColumn method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_context structure to be used - for returning the specified column value to the SQLite core - library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - - int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid); - - - A successful invocation of this method will cause *pRowid to be - filled with the rowid of row that the - virtual table cursor pCur is currently pointing at. - This method returns SQLITE_OK on success. - It returns an appropriate error code on failure. - - - The xRowid method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - - int (*xUpdate)( - sqlite3_vtab *pVTab, - int argc, - sqlite3_value **argv, - sqlite_int64 *pRowid - ); - - - All changes to a virtual table are made using the xUpdate method. - This one method can be used to insert, delete, or update. - - - The argc parameter specifies the number of entries in the argv array. - The value of argc will be 1 for a pure delete operation or N+2 for an insert - or replace or update where N is the number of columns in the table. - In the previous sentence, N includes any hidden columns. - - - Every argv entry will have a non-NULL value in C but may contain the - SQL value NULL. In other words, it is always true that - ]]>argv[i]!=0]]> for ]]>i]]> between 0 and ]]>argc-1]]>. - However, it might be the case that - ]]>sqlite3_value_type(argv[i])==SQLITE_NULL]]>. - - - The argv[0] parameter is the rowid of a row in the virtual table - to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. - - - The argv[1] parameter is the rowid of a new row to be inserted - into the virtual table. If argv[1] is an SQL NULL, then the implementation - must choose a rowid for the newly inserted row. Subsequent argv[] - entries contain values of the columns of the virtual table, in the - order that the columns were declared. The number of columns will - match the table declaration that the xConnect or xCreate method made - using the sqlite3_declare_vtab() call. All hidden columns are included. - - - When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL), - on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table), - the implementation must set *pRowid to the rowid of the newly inserted row; - this will become the value returned by the sqlite3_last_insert_rowid() - function. Setting this value in all the other cases is a harmless no-op; - the SQLite engine ignores the *pRowid return value if argc==1 or - argv[1] is not an SQL NULL. - - - Each call to xUpdate will fall into one of cases shown below. - Not that references to ]]>argv[i]]]> mean the SQL value - held within the argv[i] object, not the argv[i] - object itself. - - - ]]> - ]]>]]>argc = 1 ]]> argv[0] ≠ NULL]]> - ]]>]]> - DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted. - No insert occurs. - ]]>]]>]]>argc > 1 ]]> argv[0] = NULL]]> - ]]>]]> - INSERT: A new row is inserted with column values taken from - argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL, - then a new unique rowid is generated automatically. The argv[1] will be NULL - for a WITHOUT ROWID virtual table, in which case the implementation should - take the PRIMARY KEY value from the appropriate column in argv[2] and following. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] = argv[1]]]> - ]]>]]> - UPDATE: - The row with rowid or PRIMARY KEY argv[0] is updated with new values - in argv[2] and following parameters. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] ≠ argv[1]]]> - ]]>]]> - UPDATE with rowid or PRIMARY KEY change: - The row with rowid or PRIMARY KEY argv[0] is updated with - the rowid or PRIMARY KEY in argv[1] - and new values in argv[2] and following parameters. This will occur - when an SQL statement updates a rowid, as in the statement: - - UPDATE table SET rowid=rowid+1 WHERE ...; - - ]]>]]> - - - The xUpdate method must return SQLITE_OK if and only if it is - successful. If a failure occurs, the xUpdate must return an appropriate - error code. On a failure, the pVTab->zErrMsg element may optionally - be replaced with error message text stored in memory allocated from SQLite - using functions such as sqlite3_mprintf() or sqlite3_malloc(). - - - If the xUpdate method violates some constraint of the virtual table - (including, but not limited to, attempting to store a value of the wrong - datatype, attempting to store a value that is too - large or too small, or attempting to change a read-only value) then the - xUpdate must fail with an appropriate error code. - - - If the xUpdate method is performing an UPDATE, then - sqlite3_value_nochange(X) can be used to discover which columns - of the virtual table were actually modified by the UPDATE - statement. The sqlite3_value_nochange(X) interface returns - true for columns that do not change. - On every UPDATE, SQLite will first invoke - xColumn separately for each unchanging column in the table to - obtain the value for that column. The xColumn method can - check to see if the column is unchanged at the SQL level - by invoking sqlite3_vtab_nochange(). If xColumn sees that - the column is not being modified, it should return without setting - a result using one of the sqlite3_result_xxxxx() - interfaces. Only in that case sqlite3_value_nochange() will be - true within the xUpdate method. If xColumn does - invoke one or more sqlite3_result_xxxxx() - interfaces, then SQLite understands that as a change in the value - of the column and the sqlite3_value_nochange() call for that - column within xUpdate will return false. - - - There might be one or more sqlite3_vtab_cursor objects open and in use - on the virtual table instance and perhaps even on the row of the virtual - table when the xUpdate method is invoked. The implementation of - xUpdate must be prepared for attempts to delete or modify rows of the table - out from other existing cursors. If the virtual table cannot accommodate - such changes, the xUpdate method must return an error code. - - - The xUpdate method is optional. - If the xUpdate pointer in the sqlite3_module for a virtual table - is a NULL pointer, then the virtual table is read-only. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of new or modified column values contained in - . - - - The array of native pointers to sqlite3_value structures containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - - int (*xBegin)(sqlite3_vtab *pVTab); - - - This method begins a transaction on a virtual table. - This is method is optional. The xBegin pointer of sqlite3_module - may be NULL. - - - This method is always followed by one call to either the - xCommit or xRollback method. Virtual table transactions do - not nest, so the xBegin method will not be invoked more than once - on a single virtual table - without an intervening call to either xCommit or xRollback. - Multiple calls to other methods can and likely will occur in between - the xBegin and the corresponding xCommit or xRollback. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xSync)(sqlite3_vtab *pVTab); - - - This method signals the start of a two-phase commit on a virtual - table. - This is method is optional. The xSync pointer of sqlite3_module - may be NULL. - - - This method is only invoked after call to the xBegin method and - prior to an xCommit or xRollback. In order to implement two-phase - commit, the xSync method on all virtual tables is invoked prior to - invoking the xCommit method on any virtual table. If any of the - xSync methods fail, the entire transaction is rolled back. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xCommit)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to commit. - This is method is optional. The xCommit pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin and - xSync. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xRollback)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to rollback. - This is method is optional. The xRollback pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xFindFunction)( - sqlite3_vtab *pVtab, - int nArg, - const char *zName, - void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), - void **ppArg - ); - - - This method is called during sqlite3_prepare() to give the virtual - table implementation an opportunity to overload functions. - This method may be set to NULL in which case no overloading occurs. - - - When a function uses a column from a virtual table as its first - argument, this method is called to see if the virtual table would - like to overload the function. The first three parameters are inputs: - the virtual table, the number of arguments to the function, and the - name of the function. If no overloading is desired, this method - returns 0. To overload the function, this method writes the new - function implementation into *pxFunc and writes user data into *ppArg - and returns either 1 or a number between - SQLITE_INDEX_CONSTRAINT_FUNCTION and 255. - - - Historically, the return value from xFindFunction() was either zero - or one. Zero means that the function is not overloaded and one means that - it is overload. The ability to return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in - version 3.25.0 (2018-09-15). If xFindFunction returns - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function - takes two arguments and the function - can be used as a boolean in the WHERE clause of a query and that - the virtual table is able to exploit that function to speed up the query - result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, the value returned becomes the sqlite3_index_info.aConstraint.op - value for one of the constraints passed into xBestIndex() and the second - argument becomes the value corresponding to that constraint that is passed - to xFilter(). This enables the - xBestIndex()/xFilter implementations to use the function to speed - its search. - - - The technique of having xFindFunction() return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation - of the Geopoly module. The xFindFunction() method of that module returns - SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function - and it returns - SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function. - This permits search optimizations for queries such as: - - - SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon); - - - Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse - the order of their arguments. So "like(A,B)" is equivalent to "B like A". - For the form "B like A" the B term is considered the first argument - to the function. But for "like(A,B)" the A term is considered the - first argument. - - - The function pointer returned by this routine must be valid for - the lifetime of the sqlite3_vtab object given in the first parameter. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - delegate responsible for implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - - int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); - - - This method provides notification that the virtual table implementation - that the virtual table will be given a new name. - If this method returns SQLITE_OK then SQLite renames the table. - If this method returns an error code then the renaming is prevented. - - - The xRename method is optional. If omitted, then the virtual - table may not be renamed using the ALTER TABLE RENAME command. - - - The PRAGMA legacy_alter_table setting is enabled prior to invoking this - method, and the value for legacy_alter_table is restored after this - method finishes. This is necessary for the correct operation of virtual - tables that make use of shadow tables where the shadow tables must be - renamed to match the new virtual table name. If the legacy_alter_format is - off, then the xConnect method will be invoked for the virtual table every - time the xRename method tries to change the name of the shadow table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the UTF-8 encoded string containing the new - name for the virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - This class represents a context from the SQLite core library that can - be passed to the sqlite3_result_*() and associated functions. - - - - - This interface represents a native handle provided by the SQLite core - library. - - - - - The native handle value. - - - - - The native context handle. - - - - - Constructs an instance of this class using the specified native - context handle. - - - The native context handle to use. - - - - - Sets the context result to NULL. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. This value will be - converted to the UTF-8 encoding prior to being used. - - - - - Sets the context result to the specified - value containing an error message. - - - The value containing the error message text. - This value will be converted to the UTF-8 encoding prior to being - used. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to contain the error code SQLITE_TOOBIG. - - - - - Sets the context result to contain the error code SQLITE_NOMEM. - - - - - Sets the context result to the specified array - value. - - - The array value to use. - - - - - Sets the context result to a BLOB of zeros of the specified size. - - - The number of zero bytes to use for the BLOB context result. - - - - - Sets the context result to the specified . - - - The to use. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This class represents a value from the SQLite core library that can be - passed to the sqlite3_value_*() and associated functions. - - - - - The native value handle. - - - - - Constructs an instance of this class using the specified native - value handle. - - - The native value handle to use. - - - - - Invalidates the native value handle, thereby preventing further - access to it from this object instance. - - - - - Converts a native pointer to a native sqlite3_value structure into - a managed object instance. - - - The native pointer to a native sqlite3_value structure to convert. - - - The managed object instance or null upon - failure. - - - - - Converts a logical array of native pointers to native sqlite3_value - structures into a managed array of - object instances. - - - The number of elements in the logical array of native sqlite3_value - structures. - - - The native pointer to the logical array of native sqlite3_value - structures to convert. - - - The managed array of object instances or - null upon failure. - - - - - Gets and returns the type affinity associated with this value. - - - The type affinity associated with this value. - - - - - Gets and returns the number of bytes associated with this value, if - it refers to a UTF-8 encoded string. - - - The number of bytes associated with this value. The returned value - may be zero. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with - this value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. The value is - converted from the UTF-8 encoding prior to being returned. - - - - - Gets and returns the array associated with this - value. - - - The array associated with this value. - - - - - Gets and returns an instance associated with - this value. - - - The associated with this value. If the type - affinity of the object is unknown or cannot be determined, a null - value will be returned. - - - - - Uses the native value handle to obtain and store the managed value - for this object instance, thus saving it for later use. The type - of the managed value is determined by the type affinity of the - native value. If the type affinity is not recognized by this - method, no work is done and false is returned. - - - Non-zero if the native value was persisted successfully. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Returns non-zero if the native SQLite value has been successfully - persisted as a managed value within this object instance (i.e. the - property may then be read successfully). - - - - - If the managed value for this object instance is available (i.e. it - has been previously persisted via the ) method, - that value is returned; otherwise, an exception is thrown. The - returned value may be null. - - - - - These are the allowed values for the operators that are part of a - constraint term in the WHERE clause of a query that uses a virtual - table. - - - - - This value represents the equality operator. - - - - - This value represents the greater than operator. - - - - - This value represents the less than or equal to operator. - - - - - This value represents the less than operator. - - - - - This value represents the greater than or equal to operator. - - - - - This value represents the MATCH operator. - - - - - This value represents the LIKE operator. - - - - - This value represents the GLOB operator. - - - - - This value represents the REGEXP operator. - - - - - This value represents the inequality operator. - - - - - This value represents the IS NOT operator. - - - - - This value represents the IS NOT NULL operator. - - - - - This value represents the IS NULL operator. - - - - - This value represents the IS operator. - - - - - These are the allowed values for the index flags from the - method. - - - - - No special handling. This is the default. - - - - - This value indicates that the scan of the index will visit at - most one row. - - - - - This class represents the native sqlite3_index_constraint structure - from the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint structure. - - - The native sqlite3_index_constraint structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column on left-hand side of constraint. - - - Constraint operator (). - - - True if this constraint is usable. - - - Used internally - - should ignore. - - - - - Column on left-hand side of constraint. - - - - - Constraint operator (). - - - - - True if this constraint is usable. - - - - - Used internally - - should ignore. - - - - - This class represents the native sqlite3_index_orderby structure from - the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_orderby structure. - - - The native sqlite3_index_orderby structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column number. - - - True for DESC. False for ASC. - - - - - Column number. - - - - - True for DESC. False for ASC. - - - - - This class represents the native sqlite3_index_constraint_usage - structure from the SQLite core library. - - - - - Constructs a default instance of this class. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint_usage structure. - - - The native sqlite3_index_constraint_usage structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - If greater than 0, constraint is part of argv to xFilter. - - - Do not code a test for this constraint. - - - - - If greater than 0, constraint is part of argv to xFilter. - - - - - Do not code a test for this constraint. - - - - - This class represents the various inputs provided by the SQLite core - library to the method. - - - - - Constructs an instance of this class. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - This class represents the various outputs provided to the SQLite core - library by the method. - - - - - Constructs an instance of this class. - - - The number of instances - to pre-allocate space for. - - - - - Determines if the native estimatedRows field can be used, based on - the available version of the SQLite core library. - - - Non-zero if the property is supported - by the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - An array of object - instances, each containing information to be supplied to the SQLite - core library. - - - - - Number used to help identify the selected index. This value will - later be provided to the - method. - - - - - String used to help identify the selected index. This value will - later be provided to the - method. - - - - - Non-zero if the index string must be freed by the SQLite core - library. - - - - - True if output is already ordered. - - - - - Estimated cost of using this index. Using a null value here - indicates that a default estimated cost value should be used. - - - - - Estimated number of rows returned. Using a null value here - indicates that a default estimated rows value should be used. - This property has no effect if the SQLite core library is not at - least version 3.8.2. - - - - - The flags that should be used with this index. Using a null value - here indicates that a default flags value should be used. This - property has no effect if the SQLite core library is not at least - version 3.9.0. - - - - - - Indicates which columns of the virtual table may be required by the - current scan. Virtual table columns are numbered from zero in the - order in which they appear within the CREATE TABLE statement passed - to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), - the corresponding bit is set within the bit mask if the column may - be required by SQLite. If the table has at least 64 columns and - any column to the right of the first 63 is required, then bit 63 of - colUsed is also set. In other words, column iCol may be required - if the expression - - - (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) - - - evaluates to non-zero. Using a null value here indicates that a - default flags value should be used. This property has no effect if - the SQLite core library is not at least version 3.10.0. - - - - - - This class represents the various inputs and outputs used with the - method. - - - - - Constructs an instance of this class. - - - The number of (and - ) instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - Attempts to determine the structure sizes needed to create and - populate a native - - structure. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - - - Attempts to allocate and initialize a native - - structure. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - The newly allocated native - structure - -OR- if it could not be fully allocated. - - - - - Frees all the memory associated with a native - - structure. - - - The native pointer to the native sqlite3_index_info structure to - free. - - - - - Converts a native pointer to a native sqlite3_index_info structure - into a new object instance. - - - The native pointer to the native sqlite3_index_info structure to - convert. - - - Non-zero to include fields from the outputs portion of the native - structure; otherwise, the "output" fields will not be read. - - - Upon success, this parameter will be modified to contain the newly - created object instance. - - - - - Populates the outputs of a pre-allocated native sqlite3_index_info - structure using an existing object - instance. - - - The existing object instance containing - the output data to use. - - - The native pointer to the pre-allocated native sqlite3_index_info - structure. - - - Non-zero to include fields from the inputs portion of the native - structure; otherwise, the "input" fields will not be written. - - - - - The object instance containing - the inputs to the - method. - - - - - The object instance containing - the outputs from the - method. - - - - - This class represents a managed virtual table implementation. It is - not sealed and should be used as the base class for any user-defined - virtual table classes implemented in managed code. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the module implementing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the database containing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the virtual table. - - - - - Constructs an instance of this class. - - - The original array of strings provided to the - and - methods. - - - - - This method should normally be used by the - method in order to - perform index selection based on the constraints provided by the - SQLite core library. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - Non-zero upon success. - - - - - Attempts to record the renaming of the virtual table associated - with this object instance. - - - The new name for the virtual table. - - - Non-zero upon success. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - The original array of strings provided to the - and - methods. - - - - - The name of the module implementing this virtual table. - - - - - The name of the database containing this virtual table. - - - - - The name of the virtual table. - - - - - The object instance containing all the - data for the inputs and outputs relating to the most recent index - selection. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This class represents a managed virtual table cursor implementation. - It is not sealed and should be used as the base class for any - user-defined virtual table cursor classes implemented in managed code. - - - - - This value represents an invalid integer row sequence number. - - - - - The field holds the integer row sequence number for the current row - pointed to by this cursor object instance. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - - - Constructs an instance of this class. - - - - - Attempts to persist the specified object - instances in order to make them available after the - method returns. - - - The array of object instances to be - persisted. - - - The number of object instances that were - successfully persisted. - - - - - This method should normally be used by the - method in order to - perform filtering of the result rows and/or to record the filtering - criteria provided by the SQLite core library. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - - - Determines the integer row sequence number for the current row. - - - The integer row sequence number for the current row -OR- zero if - it cannot be determined. - - - - - Adjusts the integer row sequence number so that it refers to the - next row. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - The object instance associated - with this object instance. - - - - - Number used to help identify the selected index. This value will - be set via the method. - - - - - String used to help identify the selected index. This value will - be set via the method. - - - - - The values used to filter the rows returned via this cursor object - instance. This value will be set via the - method. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - This interface represents a virtual table implementation written in - managed code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This class contains static methods that are used to allocate, - manipulate, and free native memory provided by the SQLite core library. - - - - - Determines if the native sqlite3_msize() API can be used, based on - the available version of the SQLite core library. - - - Non-zero if the native sqlite3_msize() API is supported by the - SQLite core library. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Frees a memory block previously obtained from the - or methods. If - the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts - the number of bytes currently allocated by this class. - - - The native pointer to the memory block previously obtained from the - or methods. - - - - - Frees a memory block previously obtained from the SQLite core - library without adjusting the number of allocated bytes currently - tracked by this class. This is useful when dealing with blocks of - memory that were not allocated using this class. - - - The native pointer to the memory block previously obtained from the - SQLite core library. - - - - - This class contains static methods that are used to deal with native - UTF-8 string pointers to be used with the SQLite core library. - - - - - This is the maximum possible length for the native UTF-8 encoded - strings used with the SQLite core library. - - - - - This is the object instance used to handle - conversions from/to UTF-8. - - - - - Converts the specified managed string into the UTF-8 encoding and - returns the array of bytes containing its representation in that - encoding. - - - The managed string to convert. - - - The array of bytes containing the representation of the managed - string in the UTF-8 encoding or null upon failure. - - - - - Converts the specified array of bytes representing a string in the - UTF-8 encoding and returns a managed string. - - - The array of bytes to convert. - - - The managed string or null upon failure. - - - - - Probes a native pointer to a string in the UTF-8 encoding for its - terminating NUL character, within the specified length limit. - - - The native NUL-terminated string pointer. - - - The maximum length of the native string, in bytes. - - - The length of the native string, in bytes -OR- zero if the length - could not be determined. - - - - - Converts the specified native NUL-terminated UTF-8 string pointer - into a managed string. - - - The native NUL-terminated UTF-8 string pointer. - - - The managed string or null upon failure. - - - - - Converts the specified native UTF-8 string pointer of the specified - length into a managed string. - - - The native UTF-8 string pointer. - - - The length of the native string, in bytes. - - - The managed string or null upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts a logical array of native NUL-terminated UTF-8 string - pointers into an array of managed strings. - - - The number of elements in the logical array of native - NUL-terminated UTF-8 string pointers. - - - The native pointer to the logical array of native NUL-terminated - UTF-8 string pointers to convert. - - - The array of managed strings or null upon failure. - - - - - Converts an array of managed strings into an array of native - NUL-terminated UTF-8 string pointers. - - - The array of managed strings to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The array of native NUL-terminated UTF-8 string pointers or null - upon failure. - - - - - This class contains static methods that are used to deal with native - pointers to memory blocks that logically contain arrays of bytes to be - used with the SQLite core library. - - - - - Converts a native pointer to a logical array of bytes of the - specified length into a managed byte array. - - - The native pointer to the logical array of bytes to convert. - - - The length, in bytes, of the logical array of bytes to convert. - - - The managed byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The native pointer to a logical byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The length, in bytes, of the converted logical array of bytes. - - - The native pointer to a logical byte array or null upon failure. - - - - - This class contains static methods that are used to perform several - low-level data marshalling tasks between native and managed code. - - - - - Returns a new object instance based on the - specified object instance and an integer - offset. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location that the new - object instance should point to. - - - The new object instance. - - - - - Rounds up an integer size to the next multiple of the alignment. - - - The size, in bytes, to be rounded up. - - - The required alignment for the return value. - - - The size, in bytes, rounded up to the next multiple of the - alignment. This value may end up being the same as the original - size. - - - - - Determines the offset, in bytes, of the next structure member. - - - The offset, in bytes, of the current structure member. - - - The size, in bytes, of the current structure member. - - - The alignment, in bytes, of the next structure member. - - - The offset, in bytes, of the next structure member. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - to be read is located. - - - The value at the specified memory location. - - - - - Reads an value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Generates a hash code value for the object. - - - The object instance used to calculate the hash code. - - - Non-zero if different object instances with the same value should - generate different hash codes, where applicable. This parameter - has no effect on the .NET Compact Framework. - - - The hash code value -OR- zero if the object is null. - - - - - This class represents a managed virtual table module implementation. - It is not sealed and must be used as the base class for any - user-defined virtual table module classes implemented in managed code. - - - - - The default version of the native sqlite3_module structure in use. - - - - - This field is used to store the native sqlite3_module structure - associated with this object instance. - - - - - This field is used to store the destructor delegate to be passed to - the SQLite core library via the sqlite3_create_disposable_module() - function. - - - - - This field is used to store a pointer to the native sqlite3_module - structure returned by the sqlite3_create_disposable_module - function. - - - - - This field is used to store the virtual table instances associated - with this module. The native pointer to the sqlite3_vtab derived - structure is used to key into this collection. - - - - - This field is used to store the virtual table cursor instances - associated with this module. The native pointer to the - sqlite3_vtab_cursor derived structure is used to key into this - collection. - - - - - This field is used to store the virtual table function instances - associated with this module. The case-insensitive function name - and the number of arguments (with -1 meaning "any") are used to - construct the string that is used to key into this collection. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Calls the native SQLite core library in order to create a new - disposable module containing the implementation of a virtual table. - - - The native database connection pointer to use. - - - Non-zero upon success. - - - - - This method is called by the SQLite core library when the native - module associated with this object instance is being destroyed due - to its parent connection being closed. It may also be called by - the "vtshim" module if/when the sqlite3_dispose_module() function - is called. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - - - Creates and returns the native sqlite_module structure using the - configured (or default) - interface implementation. - - - The native sqlite_module structure using the configured (or - default) interface - implementation. - - - - - Creates and returns the native sqlite_module structure using the - specified interface - implementation. - - - The interface implementation to - use. - - - The native sqlite_module structure using the specified - interface implementation. - - - - - Creates a copy of the specified - object instance, - using default implementations for the contained delegates when - necessary. - - - The object - instance to copy. - - - The new object - instance. - - - - - Calls one of the virtual table initialization methods. - - - Non-zero to call the - method; otherwise, the - method will be called. - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - Calls one of the virtual table finalization methods. - - - Non-zero to call the - method; otherwise, the - method will be - called. - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - used to get the native pointer to the sqlite3_vtab derived - structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Gets and returns the interface - implementation to be used when creating the native sqlite3_module - structure. Derived classes may override this method to supply an - alternate implementation for the - interface. - - - The interface implementation to - be used when populating the native sqlite3_module structure. If - the returned value is null, the private methods provided by the - class and relating to the - interface will be used to - create the necessary delegates. - - - - - Creates and returns the - interface implementation corresponding to the current - object instance. - - - The interface implementation - corresponding to the current object - instance. - - - - - Allocates a native sqlite3_vtab derived structure and returns a - native pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Zeros out the fields of a native sqlite3_vtab derived structure. - - - The native pointer to the native sqlite3_vtab derived structure to - zero. - - - - - Frees a native sqlite3_vtab structure using the provided native - pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Allocates a native sqlite3_vtab_cursor derived structure and - returns a native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Frees a native sqlite3_vtab_cursor structure using the provided - native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Looks up and returns the object - instance based on the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The object instance or null if - the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab derived - structure and creates an association between it and the specified - object instance. - - - The object instance to be used - when creating the association. - - - The native pointer to a sqlite3_vtab derived structure or - if the method fails for any reason. - - - - - Looks up and returns the - object instance based on the native pointer to the - sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The object instance or null - if the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab_cursor - derived structure and creates an association between it and the - specified object instance. - - - The object instance to be - used when creating the association. - - - The native pointer to a sqlite3_vtab_cursor derived structure or - if the method fails for any reason. - - - - - Deterimines the key that should be used to identify and store the - object instance for the virtual table - (i.e. to be returned via the - method). - - - The number of arguments to the virtual table function. - - - The name of the virtual table function. - - - The object instance associated with - this virtual table function. - - - The string that should be used to identify and store the virtual - table function instance. This method cannot return null. If null - is returned from this method, the behavior is undefined. - - - - - Attempts to declare the schema for the virtual table using the - specified database connection. - - - The object instance to use when - declaring the schema of the virtual table. This parameter may not - be null. - - - The string containing the CREATE TABLE statement that completely - describes the schema for the virtual table. This parameter may not - be null. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual - table function in response to a call into the - - or virtual table - methods. - - - The object instance to use when - declaring the schema of the virtual table. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon - failure, it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated cost. - - - The object instance to modify. - - - The estimated cost value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated cost. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated rows. - - - The object instance to modify. - - - The estimated rows value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated rows. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified flags. - - - The object instance to modify. - - - The index flags value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default index flags. - - - The object instance to modify. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - the method, - the method, - the method, - and the method should be logged using the - class. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - method, and the - method should be logged using the - class. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This class implements the - interface by forwarding those method calls to the - object instance it contains. If the - contained object instance is null, all - the methods simply generate an - error. - - - - - This is the value that is always used for the "logErrors" - parameter to the various static error handling methods provided - by the class. - - - - - This is the value that is always used for the "logExceptions" - parameter to the various static error handling methods provided - by the class. - - - - - This is the error message text used when the contained - object instance is not available - for any reason. - - - - - The object instance used to provide - an implementation of the - interface. - - - - - Constructs an instance of this class. - - - The object instance used to provide - an implementation of the - interface. - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab derived structure. - - - The value of . - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab_cursor derived - structure. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - This class contains some virtual methods that may be useful for other - virtual table classes. It specifically does NOT implement any of the - interface methods. - - - - - This class implements a virtual table module that does nothing by - providing "empty" implementations for all of the - interface methods. The result - codes returned by these "empty" method implementations may be - controlled on a per-method basis by using and/or overriding the - , - , - , - , and - methods from within derived classes. - - - - - This field is used to store the - values to return, on a per-method basis, for all methods that are - part of the interface. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Determines the default value to be - returned by methods of the - interface that lack an overridden implementation in all classes - derived from the class. - - - The value that should be returned - by all interface methods unless - a more specific result code has been set for that interface method. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Determines the value that should be - returned by the specified - interface method if it lack an overridden implementation. If no - specific value is available (or set) - for the specified method, the value - returned by the method will be - returned instead. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - - - Sets the value that should be - returned by the specified - interface method if it lack an overridden implementation. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - The CREATE TABLE statement used to declare the schema for the - virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Determines the SQL statement used to declare the virtual table. - This method should be overridden in derived classes if they require - a custom virtual table schema. - - - The SQL statement used to declare the virtual table -OR- null if it - cannot be determined. - - - - - Sets the table error message to one that indicates the virtual - table cursor is of the wrong type. - - - The object instance. - - - The that the virtual table cursor should be. - - - The value of . - - - - - Determines the string to return as the column value for the object - instance value. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a string representation for. - - - The string representation of the specified object instance or null - upon failure. - - - - - Constructs an unique row identifier from two - values. The first value - must contain the row sequence number for the current row and the - second value must contain the hash code of the key column value - for the current row. - - - The integer row sequence number for the current row. - - - The hash code of the key column value for the current row. - - - The unique row identifier or zero upon failure. - - - - - Determines the unique row identifier for the current row. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a unique row identifier for. - - - The unique row identifier or zero upon failure. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this cursor - was created. - - - - - This value will be non-zero if false has been returned from the - method. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Advances to the next row of the virtual table cursor using the - method of the - object instance. - - - Non-zero if the current row is valid; zero otherwise. If zero is - returned, no further rows are available. - - - - - Resets the virtual table cursor position, also invalidating the - current row, using the method of - the object instance. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if the virtual - table cursor has been closed. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - Returns non-zero if the end of the virtual table cursor has been - seen (i.e. no more rows are available, including the current one). - - - - - Returns non-zero if the virtual table cursor is open. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. The following short - example shows it being used to treat an array of strings as a table - data source: - - public static class Sample - { - public static void Main() - { - using (SQLiteConnection connection = new SQLiteConnection( - "Data Source=:memory:;")) - { - connection.Open(); - - connection.CreateModule(new SQLiteModuleEnumerable( - "sampleModule", new string[] { "one", "two", "three" })); - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = - "CREATE VIRTUAL TABLE t1 USING sampleModule;"; - - command.ExecuteNonQuery(); - } - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = "SELECT * FROM t1;"; - - using (SQLiteDataReader dataReader = command.ExecuteReader()) - { - while (dataReader.Read()) - Console.WriteLine(dataReader[0].ToString()); - } - } - - connection.Close(); - } - } - } - - - - - - The instance containing the backing data - for the virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Sets the table error message to one that indicates the virtual - table cursor has no current row. - - - The object instance. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this - cursor was created. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. - - - - - The instance containing the backing - data for the virtual table. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This enumerated type represents a type of conflict seen when apply - changes from a change set or patch set. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is present in the - database, but one or more other (non primary-key) fields modified - by the update do not contain the expected "before" values. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is not present in the - database. There is no conflicting row in this case. - - The results of invoking the - - method are undefined. - - - - - This value is seen when processing an INSERT change if the - operation would result in duplicate primary key values. - The conflicting row in this case is the database row with the - matching primary key. - - - - - If a non-foreign key constraint violation occurs while applying a - change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict - callback will see this value. - - There is no conflicting row in this case. The results of invoking - the - method are undefined. - - - - - If foreign key handling is enabled, and applying a changes leaves - the database in a state containing foreign key violations, this - value will be seen exactly once before the changes are committed. - If the conflict handler - , the changes, - including those that caused the foreign key constraint violation, - are committed. Or, if it returns - , the changes are - rolled back. - - No current or conflicting row information is provided. The only - method it is possible to call on the supplied - object is - . - - - - - This enumerated type represents the result of a user-defined conflict - resolution callback. - - - - - If a conflict callback returns this value no special action is - taken. The change that caused the conflict is not applied. The - application of changes continues with the next change. - - - - - This value may only be returned from a conflict callback if the - type of conflict was - or . If this is - not the case, any changes applied so far are rolled back and the - call to - - will raise a with an error code of - . - - If this value is returned for a - conflict, then the - conflicting row is either updated or deleted, depending on the type - of change. - - If this value is returned for a - conflict, then - the conflicting row is removed from the database and a second - attempt to apply the change is made. If this second attempt fails, - the original row is restored to the database before continuing. - - - - - If this value is returned, any changes applied so far are rolled - back and the call to - - will raise a with an error code of - . - - - - - This enumerated type represents possible flags that may be passed - to the appropriate overloads of various change set creation methods. - - - - - No special handling. - - - - - Invert the change set while iterating through it. - This is equivalent to inverting a change set using - before - applying it. It is an error to specify this flag - with a patch set. - - - - - This callback is invoked when a determination must be made about - whether changes to a specific table should be tracked -OR- applied. - It will not be called for tables that are already attached to a - . - - - The optional application-defined context data that was originally - passed to the or - - methods. This value may be null. - - - The name of the table. - - - Non-zero if changes to the table should be considered; otherwise, - zero. Throwing an exception from this callback will result in - undefined behavior. - - - - - This callback is invoked when there is a conflict while apply changes - to a database. - - - The optional application-defined context data that was originally - passed to the - - method. This value may be null. - - - The type of this conflict. - - - The object associated with - this conflict. This value may not be null; however, only properties - that are applicable to the conflict type will be available. Further - information on this is available within the descriptions of the - available values. - - - A value that indicates the - action to be taken in order to resolve the conflict. Throwing an - exception from this callback will result in undefined behavior. - - - - - This interface contains methods used to manipulate a set of changes for - a database. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - This interface contains methods used to manipulate multiple sets of - changes for a database. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - This interface contains properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - The name of the table the change was made to. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - - - - This interface contains methods to query and manipulate the state of a - change tracking session for a database. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - This class contains some static helper methods for use within this - subsystem. - - - - - This method checks the byte array specified by the caller to make - sure it will be usable. - - - A byte array provided by the caller into one of the public methods - for the classes that belong to this subsystem. This value cannot - be null or represent an empty array; otherwise, an appropriate - exception will be thrown. - - - - - This class is used to hold the native connection handle associated with - a open until this subsystem is totally - done with it. This class is for internal use by this subsystem only. - - - - - The SQL statement used when creating the native statement handle. - There are no special requirements for this other than counting as - an "open statement handle". - - - - - The format of the error message used when reporting, during object - disposal, that the statement handle is still open (i.e. because - this situation is considered a fairly serious programming error). - - - - - The wrapped native connection handle associated with this lock. - - - - - The flags associated with the connection represented by the - value. - - - - - The native statement handle for this lock. The garbage collector - cannot cause this statement to be finalized; therefore, it will - serve to hold the associated native connection open until it is - freed manually using the method. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - lock. - - - The flags associated with the connection represented by the - value. - - - Non-zero if the method should be called prior - to returning from this constructor. - - - - - Queries and returns the wrapped native connection handle for this - instance. - - - The wrapped native connection handle for this instance -OR- null - if it is unavailable. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Queries and returns the native connection handle for this instance. - - - The native connection handle for this instance. If this value is - unavailable or invalid an exception will be thrown. - - - - - This method attempts to "lock" the associated native connection - handle by preparing a SQL statement that will not be finalized - until the method is called (i.e. and which - cannot be done by the garbage collector). If the statement is - already prepared, nothing is done. If the statement cannot be - prepared for any reason, an exception will be thrown. - - - - - This method attempts to "unlock" the associated native connection - handle by finalizing the previously prepared statement. If the - statement is already finalized, nothing is done. If the statement - cannot be finalized for any reason, an exception will be thrown. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator. It is used as the - base class for the and - classes. It knows how to - advance the native iterator handle as well as finalize it. - - - - - The native change set (a.k.a. iterator) handle. - - - - - Non-zero if this instance owns the native iterator handle in the - field. In that case, this instance will - finalize the native iterator handle upon being disposed or - finalized. - - - - - Constructs a new instance of this class using the specified native - iterator handle. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Throws an exception if the native iterator handle is invalid. - - - - - Used to query the native iterator handle. This method is only used - by the class. - - - The native iterator handle -OR- if it - is not available. - - - - - Attempts to advance the native iterator handle to its next item. - - - Non-zero if the native iterator handle was advanced and contains - more data; otherwise, zero. If the underlying native API returns - an unexpected value then an exception will be thrown. - - - - - Attempts to create an instance of this class that is associated - with the specified native iterator handle. Ownership of the - native iterator handle is NOT transferred to the new instance of - this class. - - - The native iterator handle to use. - - - The new instance of this class. No return value is reserved to - indicate an error; however, if the native iterator handle is not - valid, any subsequent attempt to make use of it via the returned - instance of this class may throw exceptions. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator for a set of changes - contained entirely in memory. - - - - - The native memory buffer allocated to contain the set of changes - associated with this instance. This will always be freed when this - instance is disposed or finalized. - - - - - Constructs an instance of this class using the specified native - memory buffer and native iterator handle. - - - The native memory buffer to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class manages the native change set iterator for a set of changes - backed by a instance. - - - - - The instance that is managing - the underlying used as the backing store for - the set of changes associated with this native change set iterator. - - - - - Constructs an instance of this class using the specified native - iterator handle and . - - - The instance to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class is used to act as a bridge between a - instance and the delegates used with the native streaming API. - - - - - The managed stream instance used to in order to service the native - delegates for both input and output. - - - - - The flags associated with the connection. - - - - - The delegate used to provide input to the native streaming API. - It will be null -OR- point to the method. - - - - - The delegate used to provide output to the native streaming API. - It will be null -OR- point to the method. - - - - - Constructs a new instance of this class using the specified managed - stream and connection flags. - - - The managed stream instance to be used in order to service the - native delegates for both input and output. - - - The flags associated with the parent connection. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - This method attempts to read bytes from - the managed stream, writing them to the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer to receive the requested input bytes. - It must be at least bytes in size. - - - Upon entry, the number of bytes to read. Upon exit, the number of - bytes actually read. This value may be zero upon exit. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - This method attempts to write bytes to - the managed stream, reading them from the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer containing the requested output - bytes. It must be at least bytes in - size. - - - The number of bytes to write. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages a collection of - instances. When used, it takes responsibility for creating, returning, - and disposing of its instances. - - - - - The managed collection of - instances, keyed by their associated - instance. - - - - - The flags associated with the connection. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Makes sure the collection of - is created. - - - - - Makes sure the collection of - is disposed. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents a group of change sets (or patch sets). - - - - - The instance associated - with this change group. - - - - - The flags associated with the connection. - - - - - The native handle for this change group. This will be deleted when - this instance is disposed or finalized. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Throws an exception if the native change group handle is invalid. - - - - - Makes sure the native change group handle is valid, creating it if - necessary. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents the change tracking session associated with a - database. - - - - - The instance associated - with this session. - - - - - The name of the database (e.g. "main") for this session. - - - - - The native handle for this session. This will be deleted when - this instance is disposed or finalized. - - - - - The delegate used to provide table filtering to the native API. - It will be null -OR- point to the method. - - - - - The managed callback used to filter tables for this session. Set - via the method. - - - - - The optional application-defined context data that was passed to - the method. This value may be null. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - session. - - - The flags associated with the connection represented by the - value. - - - The name of the database (e.g. "main") for this session. - - - - - Throws an exception if the native session handle is invalid. - - - - - Makes sure the native session handle is valid, creating it if - necessary. - - - - - This method sets up the internal table filtering associated state - of this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - The native - delegate -OR- null to clear any existing table filter. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - This method is called when determining if a table needs to be - included in the tracked changes for the associated database. - - - Optional extra context information. Currently, this will always - have a value of . - - - The native pointer to the name of the table. - - - Non-zero if changes to the specified table should be considered; - otherwise, zero. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents the abstract concept of a set of changes. It - acts as the base class for the - and classes. It derives from - the class, which is used to hold - the underlying native connection handle open until the instances of - this class are disposed or finalized. It also provides the ability - to construct wrapped native delegates of the - and - types. - - - - - Constructs an instance of this class using the specified wrapped - native connection handle. - - - The wrapped native connection handle to be associated with this - change set. - - - The flags associated with the connection represented by the - value. - - - - - Creates and returns a concrete implementation of the - interface. - - - The native iterator handle to use. - - - An instance of the - interface, which can be used to fetch metadata associated with - the current item in this set of changes. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes that are backed by a - instance. - - - - - The instance that is managing - the underlying input used as the backing - store for the set of changes associated with this instance. - - - - - The instance that is managing - the underlying output used as the backing - store for the set of changes generated by the - or methods. - - - - - The instance used as the backing store for - the set of changes associated with this instance. - - - - - The instance used as the backing store for - the set of changes generated by the or - methods. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - Throws an exception if the input stream or its associated stream - adapter are invalid. - - - - - Throws an exception if the output stream or its associated stream - adapter are invalid. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes. It serves as the base class for the - and - classes. It manages and - owns an instance of the class. - - - - - This managed change set iterator is managed and owned by this - class. It will be disposed when this class is disposed. - - - - - Constructs an instance of this class using the specified managed - change set iterator. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Sets the managed iterator instance to a new value. - - - The new managed iterator instance to use. - - - - - Disposes of the managed iterator instance and sets its value to - null. - - - - - Disposes of the existing managed iterator instance and then sets it - to a new value. - - - The new managed iterator instance to use. - - - - - Attempts to advance to the next item in the set of changes. - - - Non-zero if more items are available; otherwise, zero. - - - - - Throws because not all the - derived classes are able to support reset functionality. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - This class represents an that is capable of - enumerating over a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - The flags used to create the change set iterator. - - - - - Resets the enumerator to its initial position. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes backed by a - instance. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This interface implements properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - The instance to use. This - will NOT be owned by this class and will not be disposed upon this - class being disposed or finalized. - - - - - Constructs an instance of this class using the specified iterator - instance. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Populates the underlying data for the , - , , and - properties, using the appropriate native - API. - - - - - Populates the underlying data for the - property using the appropriate - native API. - - - - - Populates the underlying data for the - property using the - appropriate native API. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - Backing field for the property. - This value will be null if this field has not yet been populated - via the underlying native API. - - - - - Backing field for the - property. This value will be null if this field has not yet been - populated via the underlying native API. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - The name of the table the change was made to. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - -
-
diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll b/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll deleted file mode 100644 index bad24db..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll.config b/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll.config deleted file mode 100644 index b14f7b5..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.dll.config +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.xml b/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.xml deleted file mode 100644 index 4219194..0000000 --- a/packages/System.Data.SQLite.Core.1.0.112.1/lib/netstandard2.0/System.Data.SQLite.xml +++ /dev/null @@ -1,21319 +0,0 @@ - - - - System.Data.SQLite - - - - - Defines a source code identifier custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code identifier value. - - - The source code identifier value to use. - - - - - Gets the source code identifier value. - - - - - Defines a source code time-stamp custom attribute for an assembly - manifest. - - - - - Constructs an instance of this attribute class using the specified - source code time-stamp value. - - - The source code time-stamp value to use. - - - - - Gets the source code time-stamp value. - - - - - This is the method signature for the SQLite core library logging callback - function for use with sqlite3_log() and the SQLITE_CONFIG_LOG. - - WARNING: This delegate is used more-or-less directly by native code, do - not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - This class implements SQLiteBase completely, and is the guts of the code that interop's SQLite with .NET - - - - - This field is used to refer to memory allocated for the - SQLITE_DBCONFIG_MAINDBNAME value used with the native - "sqlite3_db_config" API. If allocated, the associated - memeory will be freed when the underlying connection is - closed. - - - - - The opaque pointer returned to us by the sqlite provider - - - - - The user-defined functions registered on this connection - - - - - This is the name of the native library file that contains the - "vtshim" extension [wrapper]. - - - - - This is the flag indicate whether the native library file that - contains the "vtshim" extension must be dynamically loaded by - this class prior to use. - - - - - This is the name of the native entry point for the "vtshim" - extension [wrapper]. - - - - - The modules created using this connection. - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - This method attempts to dispose of all the derived - object instances currently associated with the native database connection. - - - - - Returns the number of times the method has been - called. - - - - - This method determines whether or not a - with a return code of should - be thrown after making a call into the SQLite core library. - - - Non-zero if a to be thrown. This method - will only return non-zero if the method was called - one or more times during a call into the SQLite core library (e.g. when - the sqlite3_prepare*() or sqlite3_step() APIs are used). - - - - - Resets the value of the field. - - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound and removed. - - - - Returns non-zero if the underlying native connection handle is owned - by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - Returns a standard SQLite result code. - - - - Shutdown the SQLite engine so that it can be restarted with different - configuration options. We depend on auto initialization to recover. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. This parameter has no - effect on non-Windows operating systems. - - Returns a standard SQLite result code. - - - - Determines if the associated native connection handle is open. - - - Non-zero if the associated native connection handle is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - This method attempts to determine if a database connection opened - with the specified should be - allowed into the connection pool. - - - The that were specified when the - connection was opened. - - - Non-zero if the connection should (eventually) be allowed into the - connection pool; otherwise, zero. - - - - - Has the sqlite3_errstr() core library API been checked for yet? - If so, is it present? - - - - - Returns the error message for the specified SQLite return code using - the sqlite3_errstr() function, falling back to the internal lookup - table if necessary. - - WARNING: Do not remove this method, it is used via reflection. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Has the sqlite3_stmt_readonly() core library API been checked for yet? - If so, is it present? - - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - This field is used to keep track of whether or not the - "SQLite_ForceLogPrepare" environment variable has been queried. If so, - it will only be non-zero if the environment variable was present. - - - - - Determines if all calls to prepare a SQL query will be logged, - regardless of the flags for the associated connection. - - - Non-zero to log all calls to prepare a SQL query. - - - - - Determines the file name of the native library containing the native - "vtshim" extension -AND- whether it should be dynamically loaded by - this class. - - - This output parameter will be set to non-zero if the returned native - library file name should be dynamically loaded prior to attempting - the creation of native disposable extension modules. - - - The file name of the native library containing the native "vtshim" - extension -OR- null if it cannot be determined. - - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Builds an error message string fragment containing the - defined values of the - enumeration. - - - The built string fragment. - - - - - Returns the current and/or highwater values for the specified - database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - Enables or disables extended result codes returned by SQLite - - - Gets the last SQLite error code - - - Gets the last SQLite extended error code - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Allows the setting of a logging callback invoked by SQLite when a - log event occurs. Only one callback may be set. If NULL is passed, - the logging callback is unregistered. - - The callback function to invoke. - Returns a result code - - - - Appends an error message and an appropriate line-ending to a - instance. This is useful because the .NET Compact Framework has a slightly different set - of supported methods for the class. - - - The instance to append to. - - - The message to append. It will be followed by an appropriate line-ending. - - - - - This method attempts to cause the SQLite native library to invalidate - its function pointers that refer to this instance. This is necessary - to prevent calls from native code into delegates that may have been - garbage collected. Normally, these types of issues can only arise for - connections that are added to the pool; howver, it is good practice to - unconditionally invalidate function pointers that may refer to objects - being disposed. - - - Non-zero to also invalidate global function pointers (i.e. those that - are not directly associated with this connection on the native side). - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - This method attempts to free the cached database name used with the - method. - - - Non-zero if this method is being executed within a context where it can - throw an exception in the event of failure; otherwise, zero. - - - Non-zero if this method was successful; otherwise, zero. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy, negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Determines if the SQLite core library has been initialized for the - current process. - - - A boolean indicating whether or not the SQLite core library has been - initialized for the current process. - - - - - Helper function to retrieve a column of data from an active statement. - - The statement being step()'d through - The flags associated with the connection. - The column index to retrieve - The type of data contained in the column. If Uninitialized, this function will retrieve the datatype information. - Returns the data in the column - - - - Alternate SQLite3 object, overriding many text behaviors to support UTF-16 (Unicode) - - - - - Constructs the object used to interact with the SQLite core library - using the UTF-8 text encoding. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - The native handle to be associated with the database connection. - - - The fully qualified file name associated with . - - - Non-zero if the newly created object instance will need to dispose - of when it is no longer needed. - - - - - Overrides SQLiteConvert.ToString() to marshal UTF-16 strings instead of UTF-8 - - A pointer to a UTF-16 string - The length (IN BYTES) of the string - A .NET string - - - - Represents a single SQL backup in SQLite. - - - - - The underlying SQLite object this backup is bound to. - - - - - The actual backup handle. - - - - - The destination database for the backup. - - - - - The destination database name for the backup. - - - - - The source database for the backup. - - - - - The source database name for the backup. - - - - - The last result from the StepBackup method of the SQLite3 class. - This is used to determine if the call to the FinishBackup method of - the SQLite3 class should throw an exception when it receives a non-Ok - return code from the core SQLite library. - - - - - Initializes the backup. - - The base SQLite object. - The backup handle. - The destination database for the backup. - The destination database name for the backup. - The source database for the backup. - The source database name for the backup. - - - - Disposes and finalizes the backup. - - - - - This internal class provides the foundation of SQLite support. It defines all the abstract members needed to implement - a SQLite data provider, and inherits from SQLiteConvert which allows for simple translations of string to and from SQLite. - - - - - The error code used for logging exceptions caught in user-provided - code. - - - - - Returns a string representing the active version of SQLite - - - - - Returns an integer representing the active version of SQLite - - - - - Returns non-zero if this connection to the database is read-only. - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - Returns the number of changes the last executing insert/update caused. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. This is not really a per-connection - value, it is global to the process. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - This is not really a per-connection value, it is global to the process. - - - - - Returns non-zero if the underlying native connection handle is owned by this instance. - - - - - Returns the logical list of functions associated with this connection. - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Attempts to free as much heap memory as possible for the database connection. - - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Shutdown the SQLite engine so that it can be restarted with different config options. - We depend on auto initialization to recover. - - - - - Determines if the associated native connection handle is open. - - - Non-zero if a database connection is open. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - The name of the attached database to query. - - - The fully qualified path and file name for the currently open database, - if any. - - - - - Opens a database. - - - Implementers should call SQLiteFunction.BindFunctions() and save the array after opening a connection - to bind all attributed user-defined functions and collating sequences to the new connection. - - The filename of the database to open. SQLite automatically creates it if it doesn't exist. - The name of the VFS to use -OR- null to use the default VFS. - The flags associated with the parent connection object - The open flags to use when creating the connection - The maximum size of the pool for the given filename - If true, the connection can be pulled from the connection pool - - - - Closes the currently-open database. - - - After the database has been closed implemeters should call SQLiteFunction.UnbindFunctions() to deallocate all interop allocated - memory associated with the user-defined functions and collating sequences tied to the closed connection. - - Non-zero if connection is being disposed, zero otherwise. - - - - Sets the busy timeout on the connection. SQLiteCommand will call this before executing any command. - - The number of milliseconds to wait before returning SQLITE_BUSY - - - - Returns the text of the last error issued by SQLite - - - - - - Returns the text of the last error issued by SQLite -OR- the specified default error text if - none is available from the SQLite core library. - - - The error text to return in the event that one is not available from the SQLite core library. - - - The error text. - - - - - When pooling is enabled, force this connection to be disposed rather than returned to the pool - - - - - When pooling is enabled, returns the number of pool entries matching the current file name. - - The number of pool entries matching the current file name. - - - - Prepares a SQL statement for execution. - - The source connection preparing the command. Can be null for any caller except LINQ - The SQL command text to prepare - The previous statement in a multi-statement command, or null if no previous statement exists - The timeout to wait before aborting the prepare - The remainder of the statement that was not processed. Each call to prepare parses the - SQL up to to either the end of the text or to the first semi-colon delimiter. The remaining text is returned - here for a subsequent call to Prepare() until all the text has been processed. - Returns an initialized SQLiteStatement. - - - - Steps through a prepared statement. - - The SQLiteStatement to step through - True if a row was returned, False if not. - - - - Returns non-zero if the specified statement is read-only in nature. - - The statement to check. - True if the outer query is read-only. - - - - Resets a prepared statement so it can be executed again. If the error returned is SQLITE_SCHEMA, - transparently attempt to rebuild the SQL statement and throw an error if that was not possible. - - The statement to reset - Returns -1 if the schema changed while resetting, 0 if the reset was sucessful or 6 (SQLITE_LOCKED) if the reset failed due to a lock - - - - Attempts to interrupt the query currently executing on the associated - native database connection. - - - - - This function binds a user-defined function to the connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined function from the connection. - - - The object instance containing - the metadata for the function to be unbound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - Calls the native SQLite core library in order to create a disposable - module containing the implementation of a virtual table. - - - The module object to be used when creating the native disposable module. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to cleanup the resources - associated with a module containing the implementation of a virtual table. - - - The module object previously passed to the - method. - - - The flags for the associated object instance. - - - - - Calls the native SQLite core library in order to declare a virtual table - in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - being declared. - - - The string containing the SQL statement describing the virtual table to - be declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual table - function in response to a call into the - or virtual table methods. - - - The virtual table module that is to be responsible for the virtual table - function being declared. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon failure, - it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Returns the current and/or highwater values for the specified database status parameter. - - - The database status parameter to query. - - - Non-zero to reset the highwater value to the current value. - - - If applicable, receives the current value. - - - If applicable, receives the highwater value. - - - A standard SQLite return code. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - A standard SQLite return code. - - - - - Enables or disables extension loading by SQLite. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Enables or disables extened result codes returned by SQLite - - true to enable extended result codes, false to disable. - - - - - Returns the numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Result code - - - - Returns the extended numeric result code for the most recent failed SQLite API call - associated with the database connection. - - Extended result code - - - - Add a log message via the SQLite sqlite3_log interface. - - Error code to be logged with the message. - String to be logged. Unlike the SQLite sqlite3_log() - interface, this should be pre-formatted. Consider using the - String.Format() function. - - - - - Checks if the SQLite core library has been initialized in the current process. - - - Non-zero if the SQLite core library has been initialized in the current process, - zero otherwise. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - Creates a new SQLite backup object based on the provided destination - database connection. The source database connection is the one - associated with this object. The source and destination database - connections cannot be the same. - - The destination database connection. - The destination database name. - The source database name. - The newly created backup object. - - - - Copies up to N pages from the source database to the destination - database associated with the specified backup object. - - The backup object to use. - - The number of pages to copy or negative to copy all remaining pages. - - - Set to true if the operation needs to be retried due to database - locking issues. - - - True if there are more pages to be copied, false otherwise. - - - - - Returns the number of pages remaining to be copied from the source - database to the destination database associated with the specified - backup object. - - The backup object to check. - The number of pages remaining to be copied. - - - - Returns the total number of pages in the source database associated - with the specified backup object. - - The backup object to check. - The total number of pages in the source database. - - - - Destroys the backup object, rolling back any backup that may be in - progess. - - The backup object to destroy. - - - - Returns the error message for the specified SQLite return code using - the internal static lookup table. - - The SQLite return code. - The error message or null if it cannot be found. - - - - - - - - - Creates temporary tables on the connection so schema information can be queried. - - - The connection upon which to build the schema tables. - - - - - The extra behavioral flags that can be applied to a connection. - - - - - No extra flags. - - - - - Enable logging of all SQL statements to be prepared. - - - - - Enable logging of all bound parameter types and raw values. - - - - - Enable logging of all bound parameter strongly typed values. - - - - - Enable logging of all exceptions caught from user-provided - managed code called from native code via delegates. - - - - - Enable logging of backup API errors. - - - - - Skip adding the extension functions provided by the native - interop assembly. - - - - - When binding parameter values with the - type, use the interop method that accepts an - value. - - - - - When binding parameter values, always bind them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - When returning column values, always return them as though they were - plain text (i.e. no numeric, date/time, or other conversions should - be attempted). - - - - - Prevent this object instance from - loading extensions. - - - - - Prevent this object instance from - creating virtual table modules. - - - - - Skip binding any functions provided by other managed assemblies when - opening the connection. - - - - - Skip setting the logging related properties of the - object instance that was passed to - the method. - - - - - Enable logging of all virtual table module errors seen by the - method. - - - - - Enable logging of certain virtual table module exceptions that cannot - be easily discovered via other means. - - - - - Enable tracing of potentially important [non-fatal] error conditions - that cannot be easily reported through other means. - - - - - When binding parameter values, always use the invariant culture when - converting their values from strings. - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings. - - - - - Disable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using the connection pool by default. If the "Pooling" - connection string property is specified, its value will override - this flag. The precise outcome of combining this flag with the - flag is unspecified; however, - one of the flags will be in effect. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. These - per-connection mappings, when present, override the corresponding - global mappings. - - - - - Disable using global mappings between type names and - values. This may be useful in some very narrow - cases; however, if there are no per-connection type mappings, the - fallback defaults will be used for both type names and their - associated values. Therefore, use of this flag - is not recommended. - - - - - When the property is used, it - should return non-zero if there were ever any rows in the associated - result sets. - - - - - Enable "strict" transaction enlistment semantics. Setting this flag - will cause an exception to be thrown if an attempt is made to enlist - in a transaction with an unavailable or unsupported isolation level. - In the future, more extensive checks may be enabled by this flag as - well. - - - - - Enable mapping of unsupported transaction isolation levels to the - closest supported transaction isolation level. - - - - - When returning column values, attempt to detect the affinity of - textual values by checking if they fully conform to those of the - , - , - , - or types. - - - - - When returning column values, attempt to detect the type of - string values by checking if they fully conform to those of - the , - , - , - or types. - - - - - Skip querying runtime configuration settings for use by the - class, including the default - value and default database type name. - NOTE: If the - and/or - properties are not set explicitly nor set via their connection - string properties and repeated calls to determine these runtime - configuration settings are seen to be a problem, this flag - should be set. - - - - - When binding parameter values with the - type, take their into account as - well as that of the associated . - - - - - If an exception is caught when raising the - event, the transaction - should be rolled back. If this is not specified, the transaction - will continue the commit process instead. - - - - - If an exception is caught when raising the - event, the action should - should be denied. If this is not specified, the action will be - allowed instead. - - - - - If an exception is caught when raising the - event, the operation - should be interrupted. If this is not specified, the operation - will simply continue. - - - - - Attempt to unbind all functions provided by other managed assemblies - when closing the connection. - - - - - When returning column values as a , skip - verifying their affinity. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - Enable using per-connection mappings between type names and - values. Also see the - , - , and - methods. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the parameter name. - - - - - If the database type name has not been explicitly set for the - parameter specified, fallback to using the database type name - associated with the value. - - - - - When returning column values, skip verifying their affinity. - - - - - Allow transactions to be nested. The outermost transaction still - controls whether or not any changes are ultimately committed or - rolled back. All non-outermost transactions are implemented using - the SAVEPOINT construct. - - - - - When binding parameter values, always bind - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When returning column values, always return - values as though they were plain text (i.e. not , - which is the legacy behavior). - - - - - When binding parameter values, always use - the invariant culture when converting their values to strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable waiting for the enlistment to be reset prior to attempting - to create a new enlistment. This may be necessary due to the - semantics used by distributed transactions, which complete - asynchronously. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - When returning column values, always use - the invariant culture when converting their values from strings. - - - - - EXPERIMENTAL -- - Enable strict conformance to the ADO.NET standard, e.g. use of - thrown exceptions to indicate common error conditions. - - - - - EXPERIMENTAL -- - When opening a connection, attempt to hide the password from the - connection string, etc. Given the memory architecture of the CLR, - (and P/Invoke) this is not 100% reliable and should not be relied - upon for security critical uses or applications. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted). - - - - - When binding parameter values, always use the invariant culture when - converting their values to strings or from strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings. - - - - - When binding parameter values or returning column values, always - treat them as though they were plain text (i.e. no numeric, - date/time, or other conversions should be attempted) and always - use the invariant culture when converting their values to strings - or from strings. - - - - - Enables use of all per-connection value handling callbacks. - - - - - Enables use of all applicable - properties as fallbacks for the database type name. - - - - - Enable all logging. - - - - - The default logging related flags for new connections. - - - - - The default extra flags for new connections. - - - - - The default extra flags for new connections with all logging enabled. - - - - - These are the supported status parameters for use with the native - SQLite library. - - - - - This parameter returns the number of lookaside memory slots - currently checked out. - - - - - This parameter returns the approximate number of bytes of - heap memory used by all pager caches associated with the - database connection. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED is always 0. - - - - - This parameter returns the approximate number of bytes of - heap memory used to store the schema for all databases - associated with the connection - main, temp, and any ATTACH-ed - databases. The full amount of memory used by the schemas is - reported, even if the schema memory is shared with other - database connections due to shared cache mode being enabled. - The highwater mark associated with SQLITE_DBSTATUS_SCHEMA_USED - is always 0. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - all lookaside memory already being in use. Only the high-water - value is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that were - satisfied using lookaside memory. Only the high-water value - is meaningful; the current value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number malloc attempts that might - have been satisfied using lookaside memory but failed due to - the amount of memory requested being larger than the lookaside - slot size. Only the high-water value is meaningful; the current - value is always zero. - - - - - This parameter returns the number of pager cache hits that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_HIT is always 0. - - - - - This parameter returns the number of pager cache misses that - have occurred. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_MISS is always 0. - - - - - This parameter returns the number of dirty cache entries that - have been written to disk. Specifically, the number of pages - written to the wal file in wal mode databases, or the number - of pages written to the database file in rollback mode - databases. Any pages written as part of transaction rollback - or database recovery operations are not included. If an IO or - other error occurs while writing a page to disk, the effect - on subsequent SQLITE_DBSTATUS_CACHE_WRITE requests is - undefined. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_WRITE is always 0. - - - - - This parameter returns zero for the current value if and only - if all foreign key constraints (deferred or immediate) have - been resolved. The highwater mark is always 0. - - - - - This parameter is similar to DBSTATUS_CACHE_USED, except that - if a pager cache is shared between two or more connections the - bytes of heap memory used by that pager cache is divided evenly - between the attached connections. In other words, if none of - the pager caches associated with the database connection are - shared, this request returns the same value as DBSTATUS_CACHE_USED. - Or, if one or more or the pager caches are shared, the value - returned by this call will be smaller than that returned by - DBSTATUS_CACHE_USED. The highwater mark associated with - SQLITE_DBSTATUS_CACHE_USED_SHARED is always 0. - - - - - This parameter returns the number of dirty cache entries that have - been written to disk in the middle of a transaction due to the page - cache overflowing. Transactions are more efficient if they are - written to disk all at once. When pages spill mid-transaction, that - introduces additional overhead. This parameter can be used help - identify inefficiencies that can be resolved by increasing the cache - size. - - - - - These are the supported configuration verbs for use with the native - SQLite library. They are used with the - method. - - - - - This value represents an unknown (or invalid) option, do not use it. - - - - - This option is used to change the name of the "main" database - schema. The sole argument is a pointer to a constant UTF8 string - which will become the new schema name in place of "main". - - - - - This option is used to configure the lookaside memory allocator. - The value must be an array with three elements. The second element - must be an containing the size of each buffer - slot. The third element must be an containing - the number of slots. The first element must be an - that points to a native memory buffer of bytes equal to or greater - than the product of the second and third element values. - - - - - This option is used to enable or disable the enforcement of - foreign key constraints. - - - - - This option is used to enable or disable triggers. - - - - - This option is used to enable or disable the two-argument version - of the fts3_tokenizer() function which is part of the FTS3 full-text - search engine extension. - - - - - This option is used to enable or disable the loading of extensions. - - - - - This option is used to enable or disable the automatic checkpointing - when a WAL database is closed. - - - - - This option is used to enable or disable the query planner stability - guarantee (QPSG). - - - - - This option is used to enable or disable the extra EXPLAIN QUERY PLAN - output for trigger programs. - - - - - This option is used as part of the process to reset a database back - to an empty state. Because resetting a database is destructive and - irreversible, the process requires the use of this obscure flag and - multiple steps to help ensure that it does not happen by accident. - - - - - This option activates or deactivates the "defensive" flag for a - database connection. When the defensive flag is enabled, language - features that allow ordinary SQL to deliberately corrupt the database - file are disabled. The disabled features include but are not limited - to the following: - ]]> - ]]> - The PRAGMA writable_schema=ON statement. - ]]> - ]]> - The PRAGMA journal_mode=OFF statement. - ]]> - ]]> - Writes to the sqlite_dbpage virtual table. - ]]> - ]]> - Direct writes to shadow tables. - ]]> - ]]> - - - - - This option activates or deactivates the "writable_schema" flag. - - - - - This option activates or deactivates the legacy behavior of the ALTER - TABLE RENAME command such it behaves as it did prior to version 3.24.0 - (2018-06-04). - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DML statement only, that is DELETE, INSERT, - SELECT, and UPDATE statements. - - - - - This option activates or deactivates the legacy double-quoted string - literal misfeature for DDL statements, such as CREATE TABLE and CREATE - INDEX. - - - - - This option is used to enable or disable CREATE VIEW. - - - - - This option activates or deactivates the legacy file format flag. - - - - - This option tells SQLite to assume that database schemas (i.e. the - contents of the sqlite_master tables) are untainted by malicious - content. When the trusted schema option is disabled, SQLite takes - additional defensive steps to protect the application from harm - including: - ]]> - ]]> - Prohibit the use of SQL functions inside triggers, views, CHECK - constraints, DEFAULT clauses, expression indexes, partial indexes, - or generated columns unless those functions are tagged with - SQLITE_INNOCUOUS. - ]]> - ]]> - Prohibit the use of virtual tables inside of triggers or views - unless those virtual tables are tagged with SQLITE_VTAB_INNOCUOUS. - ]]> - This setting defaults to "on" for legacy compatibility, however - all applications are advised to turn it off if possible. This - setting can also be controlled using the PRAGMA trusted_schema - statement. - - - - - These constants are used with the sqlite3_trace_v2() API and the - callbacks registered by it. - - - - - These constants are used with the sqlite3_limit() API. - - - - - This value represents an unknown (or invalid) limit, do not use it. - - - - - The maximum size of any string or BLOB or table row, in bytes. - - - - - The maximum length of an SQL statement, in bytes. - - - - - The maximum number of columns in a table definition or in the - result set of a SELECT or the maximum number of columns in an - index or in an ORDER BY or GROUP BY clause. - - - - - The maximum depth of the parse tree on any expression. - - - - - The maximum number of terms in a compound SELECT statement. - - - - - The maximum number of instructions in a virtual machine program - used to implement an SQL statement. If sqlite3_prepare_v2() or - the equivalent tries to allocate space for more than this many - opcodes in a single prepared statement, an SQLITE_NOMEM error - is returned. - - - - - The maximum number of arguments on a function. - - - - - The maximum number of attached databases. - - - - - The maximum length of the pattern argument to the LIKE or GLOB - operators. - - - - - The maximum index number of any parameter in an SQL statement. - - - - - The maximum depth of recursion for triggers. - - - - - The maximum number of auxiliary worker threads that a single - prepared statement may start. - - - - - Represents a single SQL blob in SQLite. - - - - - The underlying SQLite object this blob is bound to. - - - - - The actual blob handle. - - - - - Initializes the blob. - - The base SQLite object. - The blob handle. - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID -OR- if the query - does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The instance with a result set - containing the desired blob column. - - - The index of the blob column. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Creates a object. This will not work - for tables that were created WITHOUT ROWID. - - - The connection to use when opening the blob object. - - - The name of the database containing the blob object. - - - The name of the table containing the blob object. - - - The name of the column containing the blob object. - - - The integer identifier for the row associated with the desired - blob object. - - - Non-zero to open the blob object for read-only access. - - - The newly created instance -OR- null - if an error occurs. - - - - - Throws an exception if the blob object does not appear to be open. - - - - - Throws an exception if an invalid read/write parameter is detected. - - - When reading, this array will be populated with the bytes read from - the underlying database blob. When writing, this array contains new - values for the specified portion of the underlying database blob. - - - The number of bytes to read or write. - - - The byte offset, relative to the start of the underlying database - blob, where the read or write operation will begin. - - - - - Retargets this object to an underlying database blob for a - different row; the database, table, and column remain exactly - the same. If this operation fails for any reason, this blob - object is automatically disposed. - - - The integer identifier for the new row. - - - - - Queries the total number of bytes for the underlying database blob. - - - The total number of bytes for the underlying database blob. - - - - - Reads data from the underlying database blob. - - - This array will be populated with the bytes read from the - underlying database blob. - - - The number of bytes to read. - - - The byte offset, relative to the start of the underlying - database blob, where the read operation will begin. - - - - - Writes data into the underlying database blob. - - - This array contains the new values for the specified portion of - the underlying database blob. - - - The number of bytes to write. - - - The byte offset, relative to the start of the underlying - database blob, where the write operation will begin. - - - - - Closes the blob, freeing the associated resources. - - - - - Disposes and finalizes the blob. - - - - - The destructor. - - - - - SQLite implementation of DbCommand. - - - - - The default connection string to be used when creating a temporary - connection to execute a command via the static - or - - methods. - - - - - The command text this command is based on - - - - - The connection the command is associated with - - - - - The version of the connection the command is associated with - - - - - Indicates whether or not a DataReader is active on the command. - - - - - The timeout for the command, kludged because SQLite doesn't support per-command timeout values - - - - - Designer support - - - - - Used by DbDataAdapter to determine updating behavior - - - - - The collection of parameters for the command - - - - - The SQL command text, broken into individual SQL statements as they are executed - - - - - Unprocessed SQL text that has not been executed - - - - - Transaction associated with this command - - - - - Constructs a new SQLiteCommand - - - Default constructor - - - - - Initializes the command with the given command text - - The SQL command text - - - - Initializes the command with the given SQL command text and attach the command to the specified - connection. - - The SQL command text - The connection to associate with the command - - - - Initializes the command and associates it with the specified connection. - - The connection to associate with the command - - - - Initializes a command with the given SQL, connection and transaction - - The SQL command text - The connection to associate with the command - The transaction the command should be associated with - - - - Disposes of the command and clears all member variables - - Whether or not the class is being explicitly or implicitly disposed - - - - This method attempts to query the flags associated with the database - connection in use. If the database connection is disposed, the default - flags will be returned. - - - The command containing the databse connection to query the flags from. - - - The connection flags value. - - - - - Clears and destroys all statements currently prepared - - - - - Builds an array of prepared statements for each complete SQL statement in the command text - - - - - Not implemented - - - - - The SQL command text associated with the command - - - - - The amount of time to wait for the connection to become available before erroring out - - - - - The type of the command. SQLite only supports CommandType.Text - - - - - Forwards to the local CreateParameter() function - - - - - - Create a new parameter - - - - - - The connection associated with this command - - - - - Forwards to the local Connection property - - - - - Returns the SQLiteParameterCollection for the given command - - - - - Forwards to the local Parameters property - - - - - The transaction associated with this command. SQLite only supports one transaction per connection, so this property forwards to the - command's underlying connection. - - - - - Forwards to the local Transaction property - - - - - Verifies that all SQL queries associated with the current command text - can be successfully compiled. A will be - raised if any errors occur. - - - - - This function ensures there are no active readers, that we have a valid connection, - that the connection is open, that all statements are prepared and all parameters are assigned - in preparation for allocating a data reader. - - - - - Creates a new SQLiteDataReader to execute/iterate the array of SQLite prepared statements - - The behavior the data reader should adopt - Returns a SQLiteDataReader object - - - - This method creates a new connection, executes the query using the given - execution type, closes the connection, and returns the results. If the - connection string is null, a temporary in-memory database connection will - be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method creates a new connection, executes the query using the given - execution type and command behavior, closes the connection unless a data - reader is created, and returns the results. If the connection string is - null, a temporary in-memory database connection will be used. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection string to the database to be opened, used, and closed. If - this parameter is null, a temporary in-memory databse will be used. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - This method executes a query using the given execution type and command - behavior and returns the results. - - - The text of the command to be executed. - - - The execution type for the command. This is used to determine which method - of the command object to call, which then determines the type of results - returned, if any. - - - The command behavior flags for the command. - - - The connection used to create and execute the command. - - - The SQL parameter values to be used when building the command object to be - executed, if any. - - - The results of the query -OR- null if no results were produced from the - given execution type. - - - - - Overrides the default behavior to return a SQLiteDataReader specialization class - - The flags to be associated with the reader. - A SQLiteDataReader - - - - Overrides the default behavior of DbDataReader to return a specialized SQLiteDataReader class - - A SQLiteDataReader - - - - Called by the SQLiteDataReader when the data reader is closed. - - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The number of rows inserted/updated affected by it. - - - - Execute the command and return the number of rows inserted/updated affected by it. - - The flags to be associated with the reader. - The number of rows inserted/updated affected by it. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The first column of the first row of the first resultset from the query. - - - - Execute the command and return the first column of the first row of the resultset - (if present), or null if no resultset was returned. - - The flags to be associated with the reader. - The first column of the first row of the first resultset from the query. - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - - - This method resets all the prepared statements held by this instance - back to their initial states, ready to be re-executed. - - - Non-zero if the parameter bindings should be cleared as well. - - - If this is zero, a may be thrown for - any unsuccessful return codes from the native library; otherwise, a - will only be thrown if the connection - or its state is invalid. - - - - - Does nothing. Commands are prepared as they are executed the first time, and kept in prepared state afterwards. - - - - - Sets the method the SQLiteCommandBuilder uses to determine how to update inserted or updated rows in a DataTable. - - - - - Determines if the command is visible at design time. Defaults to True. - - - - - Clones a command, including all its parameters - - A new SQLiteCommand with the same commandtext, connection and parameters - - - - SQLite implementation of DbCommandBuilder. - - - - - Default constructor - - - - - Initializes the command builder and associates it with the specified data adapter. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Minimal amount of parameter processing. Primarily sets the DbType for the parameter equal to the provider type in the schema - - The parameter to use in applying custom behaviors to a row - The row to apply the parameter to - The type of statement - Whether the application of the parameter is part of a WHERE clause - - - - Returns a valid named parameter - - The name of the parameter - Error - - - - Returns a named parameter for the given ordinal - - The i of the parameter - Error - - - - Returns a placeholder character for the specified parameter i. - - The index of the parameter to provide a placeholder for - Returns a named parameter - - - - Sets the handler for receiving row updating events. Used by the DbCommandBuilder to autogenerate SQL - statements that may not have previously been generated. - - A data adapter to receive events on. - - - - Gets/sets the DataAdapter for this CommandBuilder - - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - Returns the automatically-generated SQLite command to delete rows from the database - - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - Returns the automatically-generated SQLite command to update rows in the database - - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - Returns the automatically-generated SQLite command to insert rows into the database - - - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Overridden to hide its property from the designer - - - - - Places brackets around an identifier - - The identifier to quote - The bracketed identifier - - - - Removes brackets around an identifier - - The quoted (bracketed) identifier - The undecorated identifier - - - - Overridden to hide its property from the designer - - - - - Override helper, which can help the base command builder choose the right keys for the given query - - - - - - - This class represents a single value to be returned - from the class via - its , - , - , - , - , - , - , - , - , - , - , - , - , - , - , or - method. If the value of the - associated public field of this class is null upon returning from the - callback, the null value will only be used if the return type for the - method called is not a value type. - If the value to be returned from the - method is unsuitable (e.g. null with a value type), an exception will - be thrown. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method -OR- null to - indicate an error. - - - - - The value to be returned from the - method. - - - - - The value to be returned from the - method. - - - - - This class represents the parameters that are provided - to the methods, with - the exception of the column index (provided separately). - - - - - This class represents the parameters that are provided to - the method, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - The value that was originally specified for the "readOnly" - parameter to the method. - - - - - This class represents the parameters that are provided - to the and - methods, with - the exception of the column index (provided separately). - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - Constructs an instance of this class to pass into a user-defined - callback associated with the - method. - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - The value that was originally specified for the "dataOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "buffer" - parameter to the - method. - - - - - The value that was originally specified for the "bufferOffset" - parameter to the or - methods. - - - - - The value that was originally specified for the "length" - parameter to the or - methods. - - - - - This class represents the parameters and return values for the - , - , - , - , - , - , - , - , - , - , - , - , - , - , - , and - methods. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs a new instance of this class. Depending on the method - being called, the and/or - parameters may be null. - - - The name of the method that was - responsible for invoking this callback. - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - This may be used by the callback to set the return value for the - called method. - - - - - The name of the method that was - responsible for invoking this callback. - - - - - If the or - method is being called, - this object will contain the array related parameters for that - method. If the method is - being called, this object will contain the blob related parameters - for that method. - - - - - This may be used by the callback to set the return value for the - called method. - - - - - This represents a method that will be called in response to a request to - bind a parameter to a command. If an exception is thrown, it will cause - the parameter binding operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The instance being bound to the command. - - - The database type name associated with this callback. - - - The ordinal of the parameter being bound to the command. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the parameter binding call should - be skipped (i.e. the parameter should not be bound at all). Great care - should be used when setting this to non-zero. - - - - - This represents a method that will be called in response to a request - to read a value from a data reader. If an exception is thrown, it will - cause the data reader operation to fail -AND- it will continue to unwind - the call stack. - - - The instance in use. - - - The instance in use. - - - The flags associated with the instance - in use. - - - The parameter and return type data for the column being read from the - data reader. - - - The database type name associated with this callback. - - - The zero based index of the column being read from the data reader. - - - The data originally used when registering this callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - This class represents the custom data type handling callbacks - for a single type name. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Provides the underlying storage for the - property. - - - - - Constructs an instance of this class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - Creates an instance of the class. - - - The custom paramater binding callback. This parameter may be null. - - - The custom data reader value callback. This parameter may be null. - - - The extra data to pass into the parameter binding callback. This - parameter may be null. - - - The extra data to pass into the data reader value callback. This - parameter may be null. - - - - - The database type name that the callbacks contained in this class - will apply to. This value may not be null. - - - - - The custom paramater binding callback. This value may be null. - - - - - The custom data reader value callback. This value may be null. - - - - - The extra data to pass into the parameter binding callback. This - value may be null. - - - - - The extra data to pass into the data reader value callback. This - value may be null. - - - - - This class represents the mappings between database type names - and their associated custom data type handling callbacks. - - - - - Constructs an (empty) instance of this class. - - - - - Event data for connection event handlers. - - - - - The type of event being raised. - - - - - The associated with this event, if any. - - - - - The transaction associated with this event, if any. - - - - - The command associated with this event, if any. - - - - - The data reader associated with this event, if any. - - - - - The critical handle associated with this event, if any. - - - - - Command or message text associated with this event, if any. - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - The type of event being raised. - The base associated - with this event, if any. - The transaction associated with this event, if any. - The command associated with this event, if any. - The data reader associated with this event, if any. - The critical handle associated with this event, if any. - The command or message text, if any. - The extra data, if any. - - - - Raised when an event pertaining to a connection occurs. - - The connection involved. - Extra information about the event. - - - - SQLite implentation of DbConnection. - - - The property can contain the following parameter(s), delimited with a semi-colon: - - - Parameter - Values - Required - Default - - - Data Source - - This may be a file name, the string ":memory:", or any supported URI (starting with SQLite 3.7.7). - Starting with release 1.0.86.0, in order to use more than one consecutive backslash (e.g. for a - UNC path), each of the adjoining backslash characters must be doubled (e.g. "\\Network\Share\test.db" - would become "\\\\Network\Share\test.db"). - - Y - - - - Uri - - If specified, this must be a file name that starts with "file://", "file:", or "/". Any leading - "file://" or "file:" prefix will be stripped off and the resulting file name will be used to open - the database. - - N - null - - - FullUri - - If specified, this must be a URI in a format recognized by the SQLite core library (starting with - SQLite 3.7.7). It will be passed verbatim to the SQLite core library. - - N - null - - - Version - 3 - N - 3 - - - UseUTF16Encoding - - True - The UTF-16 encoding should be used. -
- False - The UTF-8 encoding should be used. -
- N - False -
- - DefaultDbType - - This is the default to use when one cannot be determined based on the - column metadata and the configured type mappings. - - N - null - - - DefaultTypeName - - This is the default type name to use when one cannot be determined based on the column metadata - and the configured type mappings. - - N - null - - - NoDefaultFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - NoSharedFlags - - True - Do not combine the specified (or existing) connection flags with the value of the - property. -
- False - Combine the specified (or existing) connection flags with the value of the - property. -
- N - False -
- - VfsName - - The name of the VFS to use when opening the database connection. - If this is not specified, the default VFS will be used. - - N - null - - - ZipVfsVersion - - If non-null, this is the "version" of ZipVFS to use. This requires - the System.Data.SQLite interop assembly -AND- primary managed assembly - to be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. The valid values are "v2" and "v3". Using - anyother value will cause an exception to be thrown. Please see the - ZipVFS documentation for more information on how to use this parameter. - - N - null - - - DateTimeFormat - - Ticks - Use the value of DateTime.Ticks.
- ISO8601 - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC - DateTime values and "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values).
- JulianDay - The interval of time in days and fractions of a day since January 1, 4713 BC.
- UnixEpoch - The whole number of seconds since the Unix epoch (January 1, 1970).
- InvariantCulture - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime.
- CurrentCulture - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture.
- N - ISO8601 -
- - DateTimeKind - - Unspecified - Not specified as either UTC or local time. -
- Utc - The time represented is UTC. -
- Local - The time represented is local time. -
- N - Unspecified -
- - DateTimeFormatString - - The exact DateTime format string to use for all formatting and parsing of all DateTime - values for this connection. - - N - null - - - BaseSchemaName - - Some base data classes in the framework (e.g. those that build SQL queries dynamically) - assume that an ADO.NET provider cannot support an alternate catalog (i.e. database) without supporting - alternate schemas as well; however, SQLite does not fit into this model. Therefore, this value is used - as a placeholder and removed prior to preparing any SQL statements that may contain it. - - N - sqlite_default_schema - - - BinaryGUID - - True - Store GUID columns in binary form -
- False - Store GUID columns as text -
- N - True -
- - Cache Size - - If the argument N is positive then the suggested cache size is set to N. - If the argument N is negative, then the number of cache pages is adjusted - to use approximately abs(N*4096) bytes of memory. Backwards compatibility - note: The behavior of cache_size with a negative N was different in SQLite - versions prior to 3.7.10. In version 3.7.9 and earlier, the number of - pages in the cache was set to the absolute value of N. - - N - -2000 - - - Synchronous - - Normal - Normal file flushing behavior -
- Full - Full flushing after all writes -
- Off - Underlying OS flushes I/O's -
- N - Full -
- - Page Size - {size in bytes} - N - 4096 - - - Password - - {password} - Using this parameter requires that the legacy CryptoAPI based - codec (or the SQLite Encryption Extension) be enabled at compile-time for - both the native interop assembly and the core managed assemblies; otherwise, - using this parameter may result in an exception being thrown when attempting - to open the connection. - - N - - - - HexPassword - - {hexPassword} - Must contain a sequence of zero or more hexadecimal encoded - byte values without a leading "0x" prefix. Using this parameter requires - that the legacy CryptoAPI based codec (or the SQLite Encryption Extension) - be enabled at compile-time for both the native interop assembly and the - core managed assemblies; otherwise, using this parameter may result in an - exception being thrown when attempting to open the connection. - - N - - - - Enlist - - Y - Automatically enlist in distributed transactions -
- N - No automatic enlistment -
- N - Y -
- - Pooling - - True - Use connection pooling.
- False - Do not use connection pooling.

- WARNING: When using the default connection pool implementation, - setting this property to True should be avoided by applications that make - use of COM (either directly or indirectly) due to possible deadlocks that - can occur during the finalization of some COM objects. -
- N - False -
- - FailIfMissing - - True - Don't create the database if it does not exist, throw an error instead -
- False - Automatically create the database if it does not exist -
- N - False -
- - Max Page Count - {size in pages} - Limits the maximum number of pages (limits the size) of the database - N - 0 - - - Legacy Format - - True - Use the more compatible legacy 3.x database format -
- False - Use the newer 3.3x database format which compresses numbers more effectively -
- N - False -
- - Default Timeout - {time in seconds}
The default command timeout
- N - 30 -
- - BusyTimeout - {time in milliseconds}
Sets the busy timeout for the core library.
- N - 0 -
- - WaitTimeout - {time in milliseconds}
- EXPERIMENTAL -- The wait timeout to use with - method. This is only used when - waiting for the enlistment to be reset prior to enlisting in a transaction, - and then only when the appropriate connection flag is set.
- N - 30000 -
- - Journal Mode - - Delete - Delete the journal file after a commit. -
- Persist - Zero out and leave the journal file on disk after a - commit. -
- Off - Disable the rollback journal entirely. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Truncate - Truncate the journal file to zero-length instead of - deleting it. -
- Memory - Store the journal in volatile RAM. This saves disk I/O - but at the expense of database safety and integrity. If the application - using SQLite crashes in the middle of a transaction when this journaling - mode is set, then the database file will very likely go corrupt. -
- Wal - Use a write-ahead log instead of a rollback journal. -
- N - Delete -
- - Read Only - - True - Open the database for read only access -
- False - Open the database for normal read/write access -
- N - False -
- - Max Pool Size - The maximum number of connections for the given connection string that can be in the connection pool - N - 100 - - - Default IsolationLevel - The default transaciton isolation level - N - Serializable - - - Foreign Keys - Enable foreign key constraints - N - False - - - Flags - Extra behavioral flags for the connection. See the enumeration for possible values. - N - Default - - - SetDefaults - - True - Apply the default connection settings to the opened database.
- False - Skip applying the default connection settings to the opened database. -
- N - True -
- - ToFullPath - - True - Attempt to expand the data source file name to a fully qualified path before opening. -
- False - Skip attempting to expand the data source file name to a fully qualified path before opening. -
- N - True -
- - PrepareRetries - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - N - 3 - - - ProgressOps - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as well. - - N - 0 - - - Recursive Triggers - - True - Enable the recursive trigger capability. - False - Disable the recursive trigger capability. - - N - False - -
-
-
- - - The "invalid value" for the enumeration used - by the property. This constant is shared - by this class and the SQLiteConnectionStringBuilder class. - - - - - The default "stub" (i.e. placeholder) base schema name to use when - returning column schema information. Used as the initial value of - the BaseSchemaName property. This should start with "sqlite_*" - because those names are reserved for use by SQLite (i.e. they cannot - be confused with the names of user objects). - - - - - The managed assembly containing this type. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - Static variable to store the connection event handlers to call. - - - - - The extra connection flags to be used for all opened connections. - - - - - The instance (for this thread) that - had the most recent call to . - - - - - State of the current connection - - - - - The connection string - - - - - Nesting level of the transactions open on the connection - - - - - Transaction counter for the connection. Currently, this is only used - to build SAVEPOINT names. - - - - - If this flag is non-zero, the method will have - no effect; however, the method will continue to - behave as normal. - - - - - If set, then the connection is currently being disposed. - - - - - The default isolation level for new transactions - - - - - This object is used with lock statements to synchronize access to the - field, below. - - - - - Whether or not the connection is enlisted in a distrubuted transaction - - - - - The per-connection mappings between type names and - values. These mappings override the corresponding global mappings. - - - - - The per-connection mappings between type names and optional callbacks - for parameter binding and value reading. - - - - - The base SQLite object to interop with - - - - - The database filename minus path and extension - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. - - - - - The extra behavioral flags for this connection, if any. See the - enumeration for a list of - possible values. - - - - - The cached values for all settings that have been fetched on behalf - of this connection. This cache may be cleared by calling the - method. - - - - - The default databse type for this connection. This value will only - be used if the - flag is set. - - - - - The default databse type name for this connection. This value will only - be used if the - flag is set. - - - - - The name of the VFS to be used when opening the database connection. - - - - - Default command timeout - - - - - The default busy timeout to use with the SQLite core library. This is - only used when opening a connection. - - - - - The default wait timeout to use with - method. This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the appropriate - connection flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when opening the database. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - This event is raised whenever the database is opened or closed. - - - - - Constructs a new SQLiteConnection object - - - Default constructor - - - - - Initializes the connection with the specified connection string. - - The connection string to use. - - - - Initializes the connection with a pre-existing native connection handle. - This constructor overload is intended to be used only by the private - method. - - - The native connection handle to use. - - - The file name corresponding to the native connection handle. - - - Non-zero if this instance owns the native connection handle and - should dispose of it when it is no longer needed. - - - - - Initializes the connection with the specified connection string. - - - The connection string to use. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Clones the settings and connection string from an existing connection. If the existing connection is already open, this - function will open its own connection, enumerate any attached databases of the original connection, and automatically - attach to them. - - The connection to copy the settings from. - - - - Attempts to lookup the native handle associated with the connection. An exception will - be thrown if this cannot be accomplished. - - - The connection associated with the desired native handle. - - - The native handle associated with the connection or if it - cannot be determined. - - - - - Raises the event. - - - The connection associated with this event. If this parameter is not - null and the specified connection cannot raise events, then the - registered event handlers will not be invoked. - - - A that contains the event data. - - - - - This event is raised when events related to the lifecycle of a - SQLiteConnection object occur. - - - - - This property is used to obtain or set the custom connection pool - implementation to use, if any. Setting this property to null will - cause the default connection pool implementation to be used. - - - - - Creates and returns a new managed database connection handle. This - method is intended to be used by implementations of the - interface only. In theory, it - could be used by other classes; however, that usage is not supported. - - - This must be a native database connection handle returned by the - SQLite core library and it must remain valid and open during the - entire duration of the calling method. - - - The new managed database connection handle or null if it cannot be - created. - - - - - Backs up the database, using the specified database connection as the - destination. - - The destination database connection. - The destination database name. - The source database name. - - The number of pages to copy at a time -OR- a negative value to copy all - pages. When a negative value is used, the - may never be invoked. - - - The method to invoke between each step of the backup process. This - parameter may be null (i.e. no callbacks will be performed). If the - callback returns false -OR- throws an exception, the backup is canceled. - - - The number of milliseconds to sleep after encountering a locking error - during the backup process. A value less than zero means that no sleep - should be performed. - - - - - Clears the per-connection cached settings. - - - The total number of per-connection settings cleared. - - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for this connection, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by . - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - Clears the per-connection type mappings. - - - The total number of per-connection type mappings cleared. - - - - - Returns the per-connection type mappings. - - - The per-connection type mappings -OR- null if they are unavailable. - - - - - Adds a per-connection type mapping, possibly replacing one or more - that already exist. - - - The case-insensitive database type name (e.g. "MYDATE"). The value - of this parameter cannot be null. Using an empty string value (or - a string value consisting entirely of whitespace) for this parameter - is not recommended. - - - The value that should be associated with the - specified type name. - - - Non-zero if this mapping should be considered to be the primary one - for the specified . - - - A negative value if nothing was done. Zero if no per-connection type - mappings were replaced (i.e. it was a pure add operation). More than - zero if some per-connection type mappings were replaced. - - - - - Clears the per-connection type callbacks. - - - The total number of per-connection type callbacks cleared. - - - - - Attempts to get the per-connection type callbacks for the specified - database type name. - - - The database type name. - - - Upon success, this parameter will contain the object holding the - callbacks for the database type name. Upon failure, this parameter - will be null. - - - Non-zero upon success; otherwise, zero. - - - - - Sets, resets, or clears the per-connection type callbacks for the - specified database type name. - - - The database type name. - - - The object holding the callbacks for the database type name. If - this parameter is null, any callbacks for the database type name - will be removed if they are present. - - - Non-zero if callbacks were set or removed; otherwise, zero. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - - - Attempts to bind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be bound. - - - A object instance that helps implement the - function to be bound. For scalar functions, this corresponds to the - type. For aggregate functions, - this corresponds to the type. For - collation functions, this corresponds to the - type. - - - A object instance that helps implement the - function to be bound. For aggregate functions, this corresponds to the - type. For other callback types, it - is not used and must be null. - - - - - Attempts to unbind the specified object - instance to this connection. - - - The object instance containing - the metadata for the function to be unbound. - - Non-zero if the function was unbound. - - - - This method unbinds all registered (known) functions -OR- all previously - bound user-defined functions from this connection. - - - Non-zero to unbind all registered (known) functions -OR- zero to unbind - all functions currently bound to the connection. - - - Non-zero if all the specified user-defined functions were unbound. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to parse the connection string using the algorithm provided - by the framework itself. This is not applicable when running on the - .NET Compact Framework. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Disposes and finalizes the connection, if applicable. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Creates a clone of the connection. All attached databases and user-defined functions are cloned. If the existing connection is open, the cloned connection - will also be opened. - - - - - - Creates a database file. This just creates a zero-byte file which SQLite - will turn into a database when the file is opened properly. - - The file to create - - - - Raises the state change event when the state of the connection changes - - The new connection state. If this is different - from the previous state, the event is - raised. - The event data created for the raised event, if - it was actually raised. - - - - Determines and returns the fallback default isolation level when one cannot be - obtained from an existing connection instance. - - - The fallback default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - Determines and returns the default isolation level for this connection instance. - - - The default isolation level for this connection instance -OR- - if it cannot be determined. - - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - This parameter is ignored. - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is TRUE, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - OBSOLETE. Creates a new SQLiteTransaction if one isn't already active on the connection. - - When TRUE, SQLite defers obtaining a write lock until a write operation is requested. - When FALSE, a writelock is obtained immediately. The default is false, but in a multi-threaded multi-writer - environment, one may instead choose to lock the database immediately to avoid any possible writer deadlock. - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already active on the connection. - - Supported isolation levels are Serializable, ReadCommitted and Unspecified. - - Unspecified will use the default isolation level specified in the connection string. If no isolation level is specified in the - connection string, Serializable is used. - Serializable transactions are the default. In this mode, the engine gets an immediate lock on the database, and no other threads - may begin a transaction. Other threads may read from the database, but not write. - With a ReadCommitted isolation level, locks are deferred and elevated as needed. It is possible for multiple threads to start - a transaction in ReadCommitted mode, but if a thread attempts to commit a transaction while another thread - has a ReadCommitted lock, it may timeout or cause a deadlock on both threads until both threads' CommandTimeout's are reached. - - Returns a SQLiteTransaction object. - - - - Creates a new if one isn't already - active on the connection. - - Returns the new transaction object. - - - - Forwards to the local function - - Supported isolation levels are Unspecified, Serializable, and ReadCommitted - - - - - This method is not implemented; however, the - event will still be raised. - - - - - - When the database connection is closed, all commands linked to this connection are automatically reset. - - - - - Returns the number of pool entries for the file name associated with this connection. - - - - - Clears the connection pool associated with the connection. Any other active connections using the same database file - will be discarded instead of returned to the pool when they are closed. - - - - - - Clears all connection pools. Any active connections will be discarded instead of sent to the pool when they are closed. - - - - - The connection string containing the parameters for the connection - - - For the complete list of supported connection string properties, - please see . - - - - - Create a new and associate it with this connection. - - Returns a new command object already assigned to this connection. - - - - Forwards to the local function. - - - - - - Attempts to create a new object instance - using this connection and the specified database name. - - - The name of the database for the newly created session. - - - The newly created session -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified raw data. - - - The raw data that contains a change set (or patch set). - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object instance - using this connection and the specified stream. - - - The stream where the raw data that contains a change set (or patch set) - may be read. - - - The stream where the raw data that contains a change set (or patch set) - may be written. - - - The flags used to create the change set iterator. - - - The newly created change set -OR- null if it cannot be created. - - - - - Attempts to create a new object - instance using this connection. - - - The newly created change group -OR- null if it cannot be created. - - - - - Returns the data source file name without extension or path. - - - - - Returns the fully qualified path and file name for the currently open - database, if any. - - - - - Returns the string "main". - - - - - Determines if the legacy connection string parser should be used. - - - The connection that will be using the parsed connection string. - - - Non-zero if the legacy connection string parser should be used. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string into component parts using the custom - connection string parser. An exception may be thrown if the syntax - of the connection string is incorrect. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero if names are allowed without values. - - - The list of key/value pairs corresponding to the parameters specified - within the connection string. - - - - - Parses a connection string using the built-in (i.e. framework provided) - connection string parser class and returns the key/value pairs. An - exception may be thrown if the connection string is invalid or cannot be - parsed. When compiled for the .NET Compact Framework, the custom - connection string parser is always used instead because the framework - provided one is unavailable there. - - - The connection that will be using the parsed connection string. - - - The connection string to parse. - - - Non-zero to throw an exception if any connection string values are not of - the type. This is not applicable when running on - the .NET Compact Framework. - - The list of key/value pairs. - - - - Manual distributed transaction enlistment support - - The distributed transaction to enlist in - - - - EXPERIMENTAL -- - Waits for the enlistment associated with this connection to be reset. - This method always throws when - running on the .NET Compact Framework. - - - The approximate maximum number of milliseconds to wait before timing - out the wait operation. - - - The return value to use if the connection has been disposed; if this - value is null, will be raised - if the connection has been disposed. - - - Non-zero if the enlistment assciated with this connection was reset; - otherwise, zero. It should be noted that this method returning a - non-zero value does not necessarily guarantee that the connection - can enlist in a new transaction (i.e. due to potentical race with - other threads); therefore, callers should generally use try/catch - when calling the method. - - - - - Looks for a key in the array of key/values of the parameter string. If not found, return the specified default value - - The list to look in - The key to find - The default value to return if the key is not found - The value corresponding to the specified key, or the default value if not found. - - - - Attempts to convert the string value to an enumerated value of the specified type. - - The enumerated type to convert the string value to. - The string value to be converted. - Non-zero to make the conversion case-insensitive. - The enumerated value upon success or null upon error. - - - - Attempts to convert an input string into a byte value. - - - The string value to be converted. - - - The number styles to use for the conversion. - - - Upon sucess, this will contain the parsed byte value. - Upon failure, the value of this parameter is undefined. - - - Non-zero upon success; zero on failure. - - - - - Change a limit value for the database. - - - The database limit to change. - - - The new value for the specified limit. - - - The old value for the specified limit -OR- negative one if an error - occurs. - - - - - Change a configuration option value for the database. - - - The database configuration option to change. - - - The new value for the specified configuration option. - - - - - Enables or disables extension loading. - - - True to enable loading of extensions, false to disable. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - - - Loads a SQLite extension library from the named dynamic link library file. - - - The name of the dynamic link library file containing the extension. - - - The name of the exported function used to initialize the extension. - If null, the default "sqlite3_extension_init" will be used. - - - - - Creates a disposable module containing the implementation of a virtual - table. - - - The module object to be used when creating the disposable module. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - Creates and returns a string containing the hexadecimal encoded byte - values from the input array. - - - The input array of bytes. - - - The resulting string or null upon failure. - - - - - Parses a string containing a sequence of zero or more hexadecimal - encoded byte values and returns the resulting byte array. The - "0x" prefix is not allowed on the input string. - - - The input string containing zero or more hexadecimal encoded byte - values. - - - Upon failure, this will contain an appropriate error message. - - - A byte array containing the parsed byte values or null if an error - was encountered. - - - - - This method figures out what the default connection pool setting should - be based on the connection flags. When present, the "Pooling" connection - string property value always overrides the value returned by this method. - - - Non-zero if the connection pool should be enabled by default; otherwise, - zero. - - - - - Determines the transaction isolation level that should be used by - the caller, primarily based upon the one specified by the caller. - If mapping of transaction isolation levels is enabled, the returned - transaction isolation level may be significantly different than the - originally specified one. - - - The originally specified transaction isolation level. - - - The transaction isolation level that should be used. - - - - - Opens the connection using the parameters found in the . - - - - - Opens the connection using the parameters found in the and then returns it. - - The current connection object. - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - This can also be set in the ConnectionString with "Default Timeout" - - - - - Gets/sets the default busy timeout to use with the SQLite core library. This is only used when - opening a connection. - - - - - EXPERIMENTAL -- - The wait timeout to use with method. - This is only used when waiting for the enlistment to be reset prior to - enlisting in a transaction, and then only when the appropriate connection - flag is set. - - - - - The maximum number of retries when preparing SQL to be executed. This - normally only applies to preparation errors resulting from the database - schema being changed. - - - - - The approximate number of virtual machine instructions between progress - events. In order for progress events to actually fire, the event handler - must be added to the event as - well. This value will only be used when the underlying native progress - callback needs to be changed. - - - - - Non-zero if the built-in (i.e. framework provided) connection string - parser should be used when opening the connection. - - - - - Gets/sets the extra behavioral flags for this connection. See the - enumeration for a list of - possible values. - - - - - Gets/sets the default database type for this connection. This value - will only be used when not null. - - - - - Gets/sets the default database type name for this connection. This - value will only be used when not null. - - - - - Gets/sets the VFS name for this connection. This value will only be - used when opening the database. - - - - - Returns non-zero if the underlying native connection handle is - owned by this instance. - - - - - Returns the version of the underlying SQLite database engine - - - - - Returns the rowid of the most recent successful INSERT into the database from this connection. - - - - - This method causes any pending database operation to abort and return at - its earliest opportunity. This routine is typically called in response - to a user action such as pressing "Cancel" or Ctrl-C where the user wants - a long query operation to halt immediately. It is safe to call this - routine from any thread. However, it is not safe to call this routine - with a database connection that is closed or might close before this method - returns. - - - - - Returns the number of rows changed by the last INSERT, UPDATE, or DELETE statement executed on - this connection. - - - - - Checks if this connection to the specified database should be considered - read-only. An exception will be thrown if the database name specified - via cannot be found. - - - The name of a database associated with this connection -OR- null for the - main database. - - - Non-zero if this connection to the specified database should be considered - read-only. - - - - - Returns non-zero if the given database connection is in autocommit mode. - Autocommit mode is on by default. Autocommit mode is disabled by a BEGIN - statement. Autocommit mode is re-enabled by a COMMIT or ROLLBACK. - - - - - Returns the amount of memory (in bytes) currently in use by the SQLite core library. - - - - - Returns the maximum amount of memory (in bytes) used by the SQLite core library since the high-water mark was last reset. - - - - - Returns various global memory statistics for the SQLite core library via - a dictionary of key/value pairs. Currently, only the "MemoryUsed" and - "MemoryHighwater" keys are returned and they have values that correspond - to the values that could be obtained via the - and connection properties. - - - This dictionary will be populated with the global memory statistics. It - will be created if necessary. - - - - - Attempts to free as much heap memory as possible for this database connection. - - - - - Attempts to free N bytes of heap memory by deallocating non-essential memory - allocations held by the database library. Memory used to cache database pages - to improve performance is an example of non-essential memory. This is a no-op - returning zero if the SQLite core library was not compiled with the compile-time - option SQLITE_ENABLE_MEMORY_MANAGEMENT. Optionally, attempts to reset and/or - compact the Win32 native heap, if applicable. - - - The requested number of bytes to free. - - - Non-zero to attempt a heap reset. - - - Non-zero to attempt heap compaction. - - - The number of bytes actually freed. This value may be zero. - - - This value will be non-zero if the heap reset was successful. - - - The size of the largest committed free block in the heap, in bytes. - This value will be zero unless heap compaction is enabled. - - - A standard SQLite return code (i.e. zero for success and non-zero - for failure). - - - - - Sets the status of the memory usage tracking subsystem in the SQLite core library. By default, this is enabled. - If this is disabled, memory usage tracking will not be performed. This is not really a per-connection value, it is - global to the process. - - Non-zero to enable memory usage tracking, zero otherwise. - A standard SQLite return code (i.e. zero for success and non-zero for failure). - - - - Returns a string containing the define constants (i.e. compile-time - options) used to compile the core managed assembly, delimited with - spaces. - - - - - Returns the version of the underlying SQLite core library. - - - - - This method returns the string whose value is the same as the - SQLITE_SOURCE_ID C preprocessor macro used when compiling the - SQLite core library. - - - - - Returns a string containing the compile-time options used to - compile the SQLite core native library, delimited with spaces. - - - - - This method returns the version of the interop SQLite assembly - used. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the interop - assembly. If the SQLite interop assembly is not in use or the - necessary information cannot be obtained for any reason, a null - value may be returned. - - - - - Returns a string containing the compile-time options used to - compile the SQLite interop assembly, delimited with spaces. - - - - - This method returns the version of the managed components used - to interact with the SQLite core library. If the necessary - information cannot be obtained for any reason, a null value may - be returned. - - - - - This method returns the string whose value contains the unique - identifier for the source checkout used to build the managed - components currently executing. If the necessary information - cannot be obtained for any reason, a null value may be returned. - - - - - Queries and returns the value of the specified setting, using the - cached setting names and values for the last connection that used - the method, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the cached setting is stored here if found; otherwise, - the value of is stored here. - - - Non-zero if the cached setting was found; otherwise, zero. - - - - - Adds or sets the cached setting specified by - to the value specified by using the cached - setting names and values for the last connection that used the - method, when available. - - - The name of the cached setting to add or replace. - - - The new value of the cached setting. - - - - - The default connection flags to be used for all opened connections - when they are not present in the connection string. - - - - - The extra connection flags to be used for all opened connections. - - - - - Returns the state of the connection. - - - - - Passes a shutdown request to the SQLite core library. Does not throw - an exception if the shutdown request fails. - - - A standard SQLite return code (i.e. zero for success and non-zero for - failure). - - - - - Passes a shutdown request to the SQLite core library. Throws an - exception if the shutdown request fails and the no-throw parameter - is non-zero. - - - Non-zero to reset the database and temporary directories to their - default values, which should be null for both. - - - When non-zero, throw an exception if the shutdown request fails. - - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Enables or disables extended result codes returned by SQLite - - - Add a log message via the SQLite sqlite3_log interface. - - - Add a log message via the SQLite sqlite3_log interface. - - - - Queries or modifies the number of retries or the retry interval (in milliseconds) for - certain I/O operations that may fail due to anti-virus software. - - The number of times to retry the I/O operation. A negative value - will cause the current count to be queried and replace that negative value. - The number of milliseconds to wait before retrying the I/O - operation. This number is multiplied by the number of retry attempts so far to come - up with the final number of milliseconds to wait. A negative value will cause the - current interval to be queried and replace that negative value. - Zero for success, non-zero for error. - - - - Sets the chunk size for the primary file associated with this database - connection. - - - The new chunk size for the main database, in bytes. - - - Zero for success, non-zero for error. - - - - - Removes one set of surrounding single -OR- double quotes from the string - value and returns the resulting string value. If the string is null, empty, - or contains quotes that are not balanced, nothing is done and the original - string value will be returned. - - The string value to process. - - The string value, modified to remove one set of surrounding single -OR- - double quotes, if applicable. - - - - - Determines the directory to be used when dealing with the "|DataDirectory|" - macro in a database file name. - - - The directory to use in place of the "|DataDirectory|" macro -OR- null if it - cannot be determined. - - - - - Expand the filename of the data source, resolving the |DataDirectory| - macro as appropriate. - - The database filename to expand - - Non-zero if the returned file name should be converted to a full path - (except when using the .NET Compact Framework). - - The expanded path and filename of the filename - - - - The following commands are used to extract schema information out of the database. Valid schema types are: - - - MetaDataCollections - - - DataSourceInformation - - - Catalogs - - - Columns - - - ForeignKeys - - - Indexes - - - IndexColumns - - - Tables - - - Views - - - ViewColumns - - - - - Returns the MetaDataCollections schema - - A DataTable of the MetaDataCollections schema - - - - Returns schema information of the specified collection - - The schema collection to retrieve - A DataTable of the specified collection - - - - Retrieves schema information using the specified constraint(s) for the specified collection - - The collection to retrieve. - - The restrictions to impose. Typically, this may include: - - - restrictionValues element index - usage - - - 0 - The database (or catalog) name, if applicable. - - - 1 - The schema name. This is not used by this provider. - - - 2 - The table name, if applicable. - - - 3 - - Depends on . - When "IndexColumns", it is the index name; otherwise, it is the column name. - - - - 4 - - Depends on . - When "IndexColumns", it is the column name; otherwise, it is not used. - - - - - A DataTable of the specified collection - - - - Builds a MetaDataCollections schema datatable - - DataTable - - - - Builds a DataSourceInformation datatable - - DataTable - - - - Build a Columns schema - - The catalog (attached database) to query, can be null - The table to retrieve schema information for, can be null - The column to retrieve schema information for, can be null - DataTable - - - - Returns index information for the given database and catalog - - The catalog (attached database) to query, can be null - The name of the index to retrieve information for, can be null - The table to retrieve index information for, can be null - DataTable - - - - Retrieves table schema information for the database and catalog - - The catalog (attached database) to retrieve tables on - The table to retrieve, can be null - The table type, can be null - DataTable - - - - Retrieves view schema information for the database - - The catalog (attached database) to retrieve views on - The view name, can be null - DataTable - - - - Retrieves catalog (attached databases) schema information for the database - - The catalog to retrieve, can be null - DataTable - - - - Returns the base column information for indexes in a database - - The catalog to retrieve indexes for (can be null) - The table to restrict index information by (can be null) - The index to restrict index information by (can be null) - The source column to restrict index information by (can be null) - A DataTable containing the results - - - - Returns detailed column information for a specified view - - The catalog to retrieve columns for (can be null) - The view to restrict column information by (can be null) - The source column to restrict column information by (can be null) - A DataTable containing the results - - - - Retrieves foreign key information from the specified set of filters - - An optional catalog to restrict results on - An optional table to restrict results on - An optional foreign key name to restrict results on - A DataTable with the results of the query - - - - This event is raised periodically during long running queries. Changing - the value of the property will - determine if the operation in progress will continue or be interrupted. - For the entire duration of the event, the associated connection and - statement objects must not be modified, either directly or indirectly, by - the called code. - - - - - This event is raised whenever SQLite encounters an action covered by the - authorizer during query preparation. Changing the value of the - property will determine if - the specific action will be allowed, ignored, or denied. For the entire - duration of the event, the associated connection and statement objects - must not be modified, either directly or indirectly, by the called code. - - - - - This event is raised whenever SQLite makes an update/delete/insert into the database on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is committing a transaction. - Return non-zero to trigger a rollback. - - - - - This event is raised whenever SQLite statement first begins executing on - this connection. It only applies to the given connection. - - - - - This event is raised whenever SQLite is rolling back a transaction. - - - - - The I/O file cache flushing behavior for the connection - - - - - Normal file flushing at critical sections of the code - - - - - Full file flushing after every write operation - - - - - Use the default operating system's file flushing, SQLite does not explicitly flush the file buffers after writing - - - - - Raised each time the number of virtual machine instructions is - approximately equal to the value of the - property. - - The connection performing the operation. - A that contains the - event data. - - - - Raised when authorization is required to perform an action contained - within a SQL query. - - The connection performing the action. - A that contains the - event data. - - - - Raised when a transaction is about to be committed. To roll back a transaction, set the - rollbackTrans boolean value to true. - - The connection committing the transaction - Event arguments on the transaction - - - - Raised when data is inserted, updated and deleted on a given connection - - The connection committing the transaction - The event parameters which triggered the event - - - - Raised when a statement first begins executing on a given connection - - The connection executing the statement - Event arguments of the trace - - - - Raised between each backup step. - - - The source database connection. - - - The source database name. - - - The destination database connection. - - - The destination database name. - - - The number of pages copied with each step. - - - The number of pages remaining to be copied. - - - The total number of pages in the source database. - - - Set to true if the operation needs to be retried due to database - locking issues; otherwise, set to false. - - - True to continue with the backup process or false to halt the backup - process, rolling back any changes that have been made so far. - - - - - The event data associated with progress reporting events. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The return code for the current call into the progress callback. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The progress return code. - - - - - The data associated with a call into the authorizer. - - - - - The user-defined native data associated with this event. Currently, - this will always contain the value of . - - - - - The action code responsible for the current call into the authorizer. - - - - - The first string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The second string argument for the current call into the authorizer. - The exact value will vary based on the action code, see the - enumeration for possible - values. - - - - - The database name for the current call into the authorizer, if - applicable. - - - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - - - The return code for the current call into the authorizer. - - - - - Constructs an instance of this class with default property values. - - - - - Constructs an instance of this class with specific property values. - - - The user-defined native data associated with this event. - - - The authorizer action code. - - - The first authorizer argument. - - - The second authorizer argument. - - - The database name, if applicable. - - - The name of the inner-most trigger or view that is responsible for - the access attempt or a null value if this access attempt is directly - from top-level SQL code. - - - The authorizer return code. - - - - - Whenever an update event is triggered on a connection, this enum will indicate - exactly what type of operation is being performed. - - - - - A row is being deleted from the given database and table - - - - - A row is being inserted into the table. - - - - - A row is being updated in the table. - - - - - Passed during an Update callback, these event arguments detail the type of update operation being performed - on the given connection. - - - - - The name of the database being updated (usually "main" but can be any attached or temporary database) - - - - - The name of the table being updated - - - - - The type of update being performed (insert/update/delete) - - - - - The RowId affected by this update. - - - - - Event arguments raised when a transaction is being committed - - - - - Set to true to abort the transaction and trigger a rollback - - - - - Passed during an Trace callback, these event arguments contain the UTF-8 rendering of the SQL statement text - - - - - SQL statement text as the statement first begins executing - - - - - This interface represents a custom connection pool implementation - usable by System.Data.SQLite. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This default method implementations in this class should not be used by - applications that make use of COM (either directly or indirectly) due - to possible deadlocks that can occur during finalization of some COM - objects. - - - - - Keeps track of connections made on a specified file. The PoolVersion - dictates whether old objects get returned to the pool or discarded - when no longer in use. - - - - - The queue of weak references to the actual database connection - handles. - - - - - This pool version associated with the database connection - handles in this pool queue. - - - - - The maximum size of this pool queue. - - - - - Constructs a connection pool queue using the specified version - and maximum size. Normally, all the database connection - handles in this pool are associated with a single database file - name. - - - The initial pool version for this connection pool queue. - - - The initial maximum size for this connection pool queue. - - - - - This field is used to synchronize access to the private static data - in this class. - - - - - When this field is non-null, it will be used to provide the - implementation of all the connection pool methods; otherwise, - the default method implementations will be used. - - - - - The dictionary of connection pools, based on the normalized file - name of the SQLite database. - - - - - The default version number new pools will get. - - - - - The number of connections successfully opened from any pool. - This value is incremented by the Remove method. - - - - - The number of connections successfully closed from any pool. - This value is incremented by the Add method. - - - - - Counts the number of pool entries matching the specified file name. - - - The file name to match or null to match all files. - - - The pool entry counts for each matching file. - - - The total number of connections successfully opened from any pool. - - - The total number of connections successfully closed from any pool. - - - The total number of pool entries for all matching files. - - - - - Disposes of all pooled connections associated with the specified - database file name. - - - The database file name. - - - - - Disposes of all pooled connections. - - - - - Adds a connection to the pool of those associated with the - specified database file name. - - - The database file name. - - - The database connection handle. - - - The connection pool version at the point the database connection - handle was received from the connection pool. This is also the - connection pool version that the database connection handle was - created under. - - - - - Removes a connection from the pool of those associated with the - specified database file name with the intent of using it to - interact with the database. - - - The database file name. - - - The new maximum size of the connection pool for the specified - database file name. - - - The connection pool version associated with the returned database - connection handle, if any. - - - The database connection handle associated with the specified - database file name or null if it cannot be obtained. - - - - - This method is used to obtain a reference to the custom connection - pool implementation currently in use, if any. - - - The custom connection pool implementation or null if the default - connection pool implementation should be used. - - - - - This method is used to set the reference to the custom connection - pool implementation to use, if any. - - - The custom connection pool implementation to use or null if the - default connection pool implementation should be used. - - - - - We do not have to thread-lock anything in this function, because it - is only called by other functions above which already take the lock. - - - The pool queue to resize. - - - If a function intends to add to the pool, this is true, which - forces the resize to take one more than it needs from the pool. - - - - - SQLite implementation of DbConnectionStringBuilder. - - - - - Properties of this class - - - - - Constructs a new instance of the class - - - Default constructor - - - - - Constructs a new instance of the class using the specified connection string. - - The connection string to parse - - - - Private initializer, which assigns the connection string and resets the builder - - The connection string to assign - - - - Gets/Sets the default version of the SQLite engine to instantiate. Currently the only valid value is 3, indicating version 3 of the sqlite library. - - - - - Gets/Sets the synchronization mode (file flushing) of the connection string. Default is "Normal". - - - - - Gets/Sets the encoding for the connection string. The default is "False" which indicates UTF-8 encoding. - - - - - Gets/Sets whether or not to use connection pooling. The default is "False" - - - - - Gets/Sets whethor not to store GUID's in binary format. The default is True - which saves space in the database. - - - - - Gets/Sets the filename to open on the connection string. - - - - - An alternate to the data source property - - - - - An alternate to the data source property that uses the SQLite URI syntax. - - - - - Gets/sets the default command timeout for newly-created commands. This is especially useful for - commands used internally such as inside a SQLiteTransaction, where setting the timeout is not possible. - - - - - Gets/sets the busy timeout to use with the SQLite core library. - - - - - EXPERIMENTAL -- - The wait timeout to use with - method. - This is only used when waiting for the enlistment to be reset - prior to enlisting in a transaction, and then only when the - appropriate connection flag is set. - - - - - Gets/sets the maximum number of retries when preparing SQL to be executed. - This normally only applies to preparation errors resulting from the database - schema being changed. - - - - - Gets/sets the approximate number of virtual machine instructions between - progress events. In order for progress events to actually fire, the event - handler must be added to the event - as well. - - - - - Determines whether or not the connection will automatically participate - in the current distributed transaction (if one exists) - - - - - If set to true, will throw an exception if the database specified in the connection - string does not exist. If false, the database will be created automatically. - - - - - If enabled, uses the legacy 3.xx format for maximum compatibility, but results in larger - database sizes. - - - - - When enabled, the database will be opened for read-only access and writing will be disabled. - - - - - Gets/sets the database encryption password - - - - - Gets/sets the database encryption hexadecimal password - - - - - Gets/Sets the page size for the connection. - - - - - Gets/Sets the maximum number of pages the database may hold - - - - - Gets/Sets the cache size for the connection. - - - - - Gets/Sets the DateTime format for the connection. - - - - - Gets/Sets the DateTime kind for the connection. - - - - - Gets/sets the DateTime format string used for formatting - and parsing purposes. - - - - - Gets/Sets the placeholder base schema name used for - .NET Framework compatibility purposes. - - - - - Determines how SQLite handles the transaction journal file. - - - - - Sets the default isolation level for transactions on the connection. - - - - - Gets/sets the default database type for the connection. - - - - - Gets/sets the default type name for the connection. - - - - - Gets/sets the VFS name for the connection. - - - - - If enabled, use foreign key constraints - - - - - Enable or disable the recursive trigger capability. - - - - - If non-null, this is the version of ZipVFS to use. This requires the - System.Data.SQLite interop assembly -AND- primary managed assembly to - be compiled with the INTEROP_INCLUDE_ZIPVFS option; otherwise, this - property does nothing. - - - - - Gets/Sets the extra behavioral flags. - - - - - If enabled, apply the default connection settings to opened databases. - - - - - If enabled, attempt to resolve the provided data source file name to a - full path before opening. - - - - - If enabled, skip using the configured default connection flags. - - - - - If enabled, skip using the configured shared connection flags. - - - - - Helper function for retrieving values from the connectionstring - - The keyword to retrieve settings for - The resulting parameter value - Returns true if the value was found and returned - - - - Fallback method for MONO, which doesn't implement DbConnectionStringBuilder.GetProperties() - - The hashtable to fill with property descriptors - - - - This base class provides datatype conversion services for the SQLite provider. - - - - - This character is used to escape other characters, including itself, in - connection string property names and values. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - This character can be used to wrap connection string property names and - values. Normally, it is optional; however, when used, it must be the - first -AND- last character of that connection string property name -OR- - value. - - - - - The character is used to separate the name and value for a connection - string property. This character cannot be present in any connection - string property name. This character can be present in a connection - string property value; however, this should be avoided unless deemed - absolutely necessary. - - - - - This character is used to separate connection string properties. When - the "No_SQLiteConnectionNewParser" setting is enabled, this character - may not appear in connection string property names -OR- values. - - - - - These are the characters that are special to the connection string - parser. - - - - - The fallback default database type when one cannot be obtained from an - existing connection instance. - - - - - The fallback default database type name when one cannot be obtained from - an existing connection instance. - - - - - The value for the Unix epoch (e.g. January 1, 1970 at midnight, in UTC). - - - - - The value of the OLE Automation epoch represented as a Julian day. This - field cannot be removed as the test suite relies upon it. - - - - - The format string for DateTime values when using the InvariantCulture or CurrentCulture formats. - - - - - This is the minimum Julian Day value supported by this library - (148731163200000). - - - - - This is the maximum Julian Day value supported by this library - (464269060799000). - - - - - An array of ISO-8601 DateTime formats that we support parsing. - - - - - The internal default format for UTC DateTime values when converting - to a string. - - - - - The internal default format for local DateTime values when converting - to a string. - - - - - An UTF-8 Encoding instance, so we can convert strings to and from UTF-8 - - - - - The default DateTime format for this instance. - - - - - The default DateTimeKind for this instance. - - - - - The default DateTime format string for this instance. - - - - - Initializes the conversion class - - The default date/time format to use for this instance - The DateTimeKind to use. - The DateTime format string to use. - - - - Converts a string to a UTF-8 encoded byte array sized to include a null-terminating character. - - The string to convert to UTF-8 - A byte array containing the converted string plus an extra 0 terminating byte at the end of the array. - - - - Convert a DateTime to a UTF-8 encoded, zero-terminated byte array. - - - This function is a convenience function, which first calls ToString() on the DateTime, and then calls ToUTF8() with the - string result. - - The DateTime to convert. - The UTF-8 encoded string, including a 0 terminating byte at the end of the array. - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Converts a UTF-8 encoded IntPtr of the specified length into a .NET string - - The pointer to the memory where the UTF-8 string is encoded - The number of bytes to decode - A string containing the translated character(s) - - - - Checks if the specified is within the - supported range for a Julian Day value. - - - The Julian Day value to check. - - - Non-zero if the specified Julian Day value is in the supported - range; otherwise, zero. - - - - - Converts a Julian Day value from a to an - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value from an to a - . - - - The Julian Day value to convert. - - - The resulting Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeYMD" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day is out of the supported range. If this value is null, - an exception will be thrown instead. - - - A value that contains the year, month, and - day values that are closest to the specified Julian Day value. - - - - - Converts a Julian Day value to a . - This method was translated from the "computeHMS" function in the - "date.c" file belonging to the SQLite core library. - - - The Julian Day value to convert. - - - The value to return in the event that the - Julian Day value is out of the supported range. If this value is - null, an exception will be thrown instead. - - - A value that contains the hour, minute, and - second, and millisecond values that are closest to the specified - Julian Day value. - - - - - Converts a to a Julian Day value. - This method was translated from the "computeJD" function in - the "date.c" file belonging to the SQLite core library. - Since the range of Julian Day values supported by this method - includes all possible (valid) values of a - value, it should be extremely difficult for this method to - raise an exception or return an undefined result. - - - The value to convert. This value - will be within the range of - (00:00:00.0000000, January 1, 0001) to - (23:59:59.9999999, December - 31, 9999). - - - The nearest Julian Day value corresponding to the specified - value. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - A DateTime value - - - - Converts a string into a DateTime, using the specified DateTimeFormat, - DateTimeKind and DateTimeFormatString. - - - Acceptable ISO8601 DateTime formats are: - - THHmmssK - THHmmK - HH:mm:ss.FFFFFFFK - HH:mm:ssK - HH:mmK - yyyy-MM-dd HH:mm:ss.FFFFFFFK - yyyy-MM-dd HH:mm:ssK - yyyy-MM-dd HH:mmK - yyyy-MM-ddTHH:mm:ss.FFFFFFFK - yyyy-MM-ddTHH:mmK - yyyy-MM-ddTHH:mm:ssK - yyyyMMddHHmmssK - yyyyMMddHHmmK - yyyyMMddTHHmmssFFFFFFFK - THHmmss - THHmm - HH:mm:ss.FFFFFFF - HH:mm:ss - HH:mm - yyyy-MM-dd HH:mm:ss.FFFFFFF - yyyy-MM-dd HH:mm:ss - yyyy-MM-dd HH:mm - yyyy-MM-ddTHH:mm:ss.FFFFFFF - yyyy-MM-ddTHH:mm - yyyy-MM-ddTHH:mm:ss - yyyyMMddHHmmss - yyyyMMddHHmm - yyyyMMddTHHmmssFFFFFFF - yyyy-MM-dd - yyyyMMdd - yy-MM-dd - - If the string cannot be matched to one of the above formats -OR- - the DateTimeFormatString if one was provided, an exception will - be thrown. - - The string containing either a long integer number of 100-nanosecond units since - System.DateTime.MinValue, a Julian day double, an integer number of seconds since the Unix epoch, a - culture-independent formatted date and time string, a formatted date and time string in the current - culture, or an ISO8601-format string. - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - A DateTime value - - - - Converts a julianday value into a DateTime - - The value to convert - A .NET DateTime - - - - Converts a julianday value into a DateTime - - The value to convert - The DateTimeKind to use. - A .NET DateTime - - - - Converts the specified number of seconds from the Unix epoch into a - value. - - - The number of whole seconds since the Unix epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts the specified number of ticks since the epoch into a - value. - - - The number of whole ticks since the epoch. - - - Either Utc or Local time. - - - The new value. - - - - - Converts a DateTime struct to a JulianDay double - - The DateTime to convert - The JulianDay value the Datetime represents - - - - Converts a DateTime struct to the whole number of seconds since the - Unix epoch. - - The DateTime to convert - The whole number of seconds since the Unix epoch - - - - Returns the DateTime format string to use for the specified DateTimeKind. - If is not null, it will be returned verbatim. - - The DateTimeKind to use. - The DateTime format string to use. - - The DateTime format string to use for the specified DateTimeKind. - - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Converts a string into a DateTime, using the DateTimeFormat, DateTimeKind, - and DateTimeFormatString specified for the connection when it was opened. - - The DateTime value to convert - The SQLiteDateFormats to use. - The DateTimeKind to use. - The DateTime format string to use. - Either a string containing the long integer number of 100-nanosecond units since System.DateTime.MinValue, a - Julian day double, an integer number of seconds since the Unix epoch, a culture-independent formatted date and time - string, a formatted date and time string in the current culture, or an ISO8601-format date/time string. - - - - Internal function to convert a UTF-8 encoded IntPtr of the specified length to a DateTime. - - - This is a convenience function, which first calls ToString() on the IntPtr to convert it to a string, then calls - ToDateTime() on the string to return a DateTime. - - A pointer to the UTF-8 encoded string - The length in bytes of the string - The parsed DateTime value - - - - Smart method of splitting a string. Skips quoted elements, removes the quotes. - - - This split function works somewhat like the String.Split() function in that it breaks apart a string into - pieces and returns the pieces as an array. The primary differences are: - - Only one character can be provided as a separator character - Quoted text inside the string is skipped over when searching for the separator, and the quotes are removed. - - Thus, if splitting the following string looking for a comma:
- One,Two, "Three, Four", Five
-
- The resulting array would contain
- [0] One
- [1] Two
- [2] Three, Four
- [3] Five
-
- Note that the leading and trailing spaces were removed from each item during the split. -
- Source string to split apart - Separator character - A string array of the split up elements -
- - - Splits the specified string into multiple strings based on a separator - and returns the result as an array of strings. - - - The string to split into pieces based on the separator character. If - this string is null, null will always be returned. If this string is - empty, an array of zero strings will always be returned. - - - The character used to divide the original string into sub-strings. - This character cannot be a backslash or a double-quote; otherwise, no - work will be performed and null will be returned. - - - If this parameter is non-zero, all double-quote characters will be - retained in the returned list of strings; otherwise, they will be - dropped. - - - Upon failure, this parameter will be modified to contain an appropriate - error message. - - - The new array of strings or null if the input string is null -OR- the - separator character is a backslash or a double-quote -OR- the string - contains an unbalanced backslash or double-quote character. - - - - - Queries and returns the string representation for an object, using the - specified (or current) format provider. - - - The object instance to return the string representation for. - - - The format provider to use -OR- null if the current format provider for - the thread should be used instead. - - - The string representation for the object instance -OR- null if the - object instance is also null. - - - - - Attempts to convert an arbitrary object to the Boolean data type. - Null object values are converted to false. Throws an exception - upon failure. - - - The object value to convert. - - - The format provider to use. - - - If non-zero, a string value will be converted using the - - method; otherwise, the - method will be used. - - - The converted boolean value. - - - - - Convert a value to true or false. - - A string or number representing true or false - - - - - Converts an integer to a string that can be round-tripped using the - invariant culture. - - - The integer value to return the string representation for. - - - The string representation of the specified integer value, using the - invariant culture. - - - - - Attempts to convert a into a . - - - The to convert, cannot be null. - - - The converted value. - - - The supported strings are "yes", "no", "y", "n", "on", "off", "0", "1", - as well as any prefix of the strings - and . All strings are treated in a - case-insensitive manner. - - - - - Converts a SQLiteType to a .NET Type object - - The SQLiteType to convert - Returns a .NET Type object - - - - For a given intrinsic type, return a DbType - - The native type to convert - The corresponding (closest match) DbType - - - - Returns the ColumnSize for the given DbType - - The DbType to get the size of - - - - - Determines the default database type name to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default database type name to use. - - - - - If applicable, issues a trace log message warning about falling back to - the default database type name. - - - The database value type. - - - The flags associated with the parent connection object. - - - The textual name of the database type. - - - - - If applicable, issues a trace log message warning about falling back to - the default database value type. - - - The textual name of the database type. - - - The flags associated with the parent connection object. - - - The database value type. - - - - - For a given database value type, return the "closest-match" textual database type name. - - The connection context for custom type mappings, if any. - The database value type. - The flags associated with the parent connection object. - The type name or an empty string if it cannot be determined. - - - - Convert a DbType to a Type - - The DbType to convert from - The closest-match .NET type - - - - For a given type, return the closest-match SQLite TypeAffinity, which only understands a very limited subset of types. - - The type to evaluate - The flags associated with the connection. - The SQLite type affinity for that type. - - - - Builds and returns a map containing the database column types - recognized by this provider. - - - A map containing the database column types recognized by this - provider. - - - - - Determines if a database type is considered to be a string. - - - The database type to check. - - - Non-zero if the database type is considered to be a string, zero - otherwise. - - - - - Determines and returns the runtime configuration setting string that - should be used in place of the specified object value. - - - The object value to convert to a string. - - - Either the string to use in place of the object value -OR- null if it - cannot be determined. - - - - - Determines the default value to be used when a - per-connection value is not available. - - - The connection context for type mappings, if any. - - - The default value to use. - - - - - Converts the object value, which is assumed to have originated - from a , to a string value. - - - The value to be converted to a string. - - - A null value will be returned if the original value is null -OR- - the original value is . Otherwise, - the original value will be converted to a string, using its - (possibly overridden) method and - then returned. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be an - value. - - - The textual value to inspect. - - - Non-zero if the text looks like an value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The textual value to inspect. - - - Non-zero if the text looks like a value, - zero otherwise. - - - - - Determines if the specified textual value appears to be a - value. - - - The object instance configured with - the chosen format. - - - The textual value to inspect. - - - Non-zero if the text looks like a in the - configured format, zero otherwise. - - - - - For a given textual database type name, return the "closest-match" database type. - This method is called during query result processing; therefore, its performance - is critical. - - The connection context for custom type mappings, if any. - The textual name of the database type to match. - The flags associated with the parent connection object. - The .NET DBType the text evaluates to. - - - - SQLite has very limited types, and is inherently text-based. The first 5 types below represent the sum of all types SQLite - understands. The DateTime extension to the spec is for internal use only. - - - - - Not used - - - - - All integers in SQLite default to Int64 - - - - - All floating point numbers in SQLite default to double - - - - - The default data type of SQLite is text - - - - - Typically blob types are only seen when returned from a function - - - - - Null types can be returned from functions - - - - - Used internally by this provider - - - - - Used internally by this provider - - - - - These are the event types associated with the - - delegate (and its corresponding event) and the - class. - - - - - Not used. - - - - - Not used. - - - - - The connection is being opened. - - - - - The connection string has been parsed. - - - - - The connection was opened. - - - - - The method was called on the - connection. - - - - - A transaction was created using the connection. - - - - - The connection was enlisted into a transaction. - - - - - A command was created using the connection. - - - - - A data reader was created using the connection. - - - - - An instance of a derived class has - been created to wrap a native resource. - - - - - The connection is being closed. - - - - - The connection was closed. - - - - - A command is being disposed. - - - - - A data reader is being disposed. - - - - - A data reader is being closed. - - - - - A native resource was opened (i.e. obtained) from the pool. - - - - - A native resource was closed (i.e. released) to the pool. - - - - - This implementation of SQLite for ADO.NET can process date/time fields in - databases in one of six formats. - - - ISO8601 format is more compatible, readable, fully-processable, but less - accurate as it does not provide time down to fractions of a second. - JulianDay is the numeric format the SQLite uses internally and is arguably - the most compatible with 3rd party tools. It is not readable as text - without post-processing. Ticks less compatible with 3rd party tools that - query the database, and renders the DateTime field unreadable as text - without post-processing. UnixEpoch is more compatible with Unix systems. - InvariantCulture allows the configured format for the invariant culture - format to be used and is human readable. CurrentCulture allows the - configured format for the current culture to be used and is also human - readable. - - The preferred order of choosing a DateTime format is JulianDay, ISO8601, - and then Ticks. Ticks is mainly present for legacy code support. - - - - - Use the value of DateTime.Ticks. This value is not recommended and is not well supported with LINQ. - - - - - Use the ISO-8601 format. Uses the "yyyy-MM-dd HH:mm:ss.FFFFFFFK" format for UTC DateTime values and - "yyyy-MM-dd HH:mm:ss.FFFFFFF" format for local DateTime values). - - - - - The interval of time in days and fractions of a day since January 1, 4713 BC. - - - - - The whole number of seconds since the Unix epoch (January 1, 1970). - - - - - Any culture-independent string value that the .NET Framework can interpret as a valid DateTime. - - - - - Any string value that the .NET Framework can interpret as a valid DateTime using the current culture. - - - - - The default format for this provider. - - - - - This enum determines how SQLite treats its journal file. - - - By default SQLite will create and delete the journal file when needed during a transaction. - However, for some computers running certain filesystem monitoring tools, the rapid - creation and deletion of the journal file can cause those programs to fail, or to interfere with SQLite. - - If a program or virus scanner is interfering with SQLite's journal file, you may receive errors like "unable to open database file" - when starting a transaction. If this is happening, you may want to change the default journal mode to Persist. - - - - - The default mode, this causes SQLite to use the existing journaling mode for the database. - - - - - SQLite will create and destroy the journal file as-needed. - - - - - When this is set, SQLite will keep the journal file even after a transaction has completed. It's contents will be erased, - and the journal re-used as often as needed. If it is deleted, it will be recreated the next time it is needed. - - - - - This option disables the rollback journal entirely. Interrupted transactions or a program crash can cause database - corruption in this mode! - - - - - SQLite will truncate the journal file to zero-length instead of deleting it. - - - - - SQLite will store the journal in volatile RAM. This saves disk I/O but at the expense of database safety and integrity. - If the application using SQLite crashes in the middle of a transaction when the MEMORY journaling mode is set, then the - database file will very likely go corrupt. - - - - - SQLite uses a write-ahead log instead of a rollback journal to implement transactions. The WAL journaling mode is persistent; - after being set it stays in effect across multiple database connections and after closing and reopening the database. A database - in WAL journaling mode can only be accessed by SQLite version 3.7.0 or later. - - - - - Possible values for the "synchronous" database setting. This setting determines - how often the database engine calls the xSync method of the VFS. - - - - - Use the default "synchronous" database setting. Currently, this should be - the same as using the FULL mode. - - - - - The database engine continues without syncing as soon as it has handed - data off to the operating system. If the application running SQLite - crashes, the data will be safe, but the database might become corrupted - if the operating system crashes or the computer loses power before that - data has been written to the disk surface. - - - - - The database engine will still sync at the most critical moments, but - less often than in FULL mode. There is a very small (though non-zero) - chance that a power failure at just the wrong time could corrupt the - database in NORMAL mode. - - - - - The database engine will use the xSync method of the VFS to ensure that - all content is safely written to the disk surface prior to continuing. - This ensures that an operating system crash or power failure will not - corrupt the database. FULL synchronous is very safe, but it is also - slower. - - - - - The requested command execution type. This controls which method of the - object will be called. - - - - - Do nothing. No method will be called. - - - - - The command is not expected to return a result -OR- the result is not - needed. The or - method - will be called. - - - - - The command is expected to return a scalar result -OR- the result should - be limited to a scalar result. The - or method will - be called. - - - - - The command is expected to return result. - The or - method will - be called. - - - - - Use the default command execution type. Using this value is the same - as using the value. - - - - - The action code responsible for the current call into the authorizer. - - - - - No action is being performed. This value should not be used from - external code. - - - - - No longer used. - - - - - An index will be created. The action-specific arguments are the - index name and the table name. - - - - - - A table will be created. The action-specific arguments are the - table name and a null value. - - - - - A temporary index will be created. The action-specific arguments - are the index name and the table name. - - - - - A temporary table will be created. The action-specific arguments - are the table name and a null value. - - - - - A temporary trigger will be created. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be created. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be created. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be created. The action-specific arguments are the view - name and a null value. - - - - - A DELETE statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - An index will be dropped. The action-specific arguments are the - index name and the table name. - - - - - A table will be dropped. The action-specific arguments are the tables - name and a null value. - - - - - A temporary index will be dropped. The action-specific arguments are - the index name and the table name. - - - - - A temporary table will be dropped. The action-specific arguments are - the table name and a null value. - - - - - A temporary trigger will be dropped. The action-specific arguments - are the trigger name and the table name. - - - - - A temporary view will be dropped. The action-specific arguments are - the view name and a null value. - - - - - A trigger will be dropped. The action-specific arguments are the - trigger name and the table name. - - - - - A view will be dropped. The action-specific arguments are the view - name and a null value. - - - - - An INSERT statement will be executed. The action-specific arguments - are the table name and a null value. - - - - - A PRAGMA statement will be executed. The action-specific arguments - are the name of the PRAGMA and the new value or a null value. - - - - - A table column will be read. The action-specific arguments are the - table name and the column name. - - - - - A SELECT statement will be executed. The action-specific arguments - are both null values. - - - - - A transaction will be started, committed, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - COMMIT, or ROLLBACK) and a null value. - - - - - An UPDATE statement will be executed. The action-specific arguments - are the table name and the column name. - - - - - A database will be attached to the connection. The action-specific - arguments are the database file name and a null value. - - - - - A database will be detached from the connection. The action-specific - arguments are the database name and a null value. - - - - - The schema of a table will be altered. The action-specific arguments - are the database name and the table name. - - - - - An index will be deleted and then recreated. The action-specific - arguments are the index name and a null value. - - - - - A table will be analyzed to gathers statistics about it. The - action-specific arguments are the table name and a null value. - - - - - A virtual table will be created. The action-specific arguments are - the table name and the module name. - - - - - A virtual table will be dropped. The action-specific arguments are - the table name and the module name. - - - - - A SQL function will be called. The action-specific arguments are a - null value and the function name. - - - - - A savepoint will be created, released, or rolled back. The - action-specific arguments are the name of the operation (BEGIN, - RELEASE, or ROLLBACK) and the savepoint name. - - - - - A recursive query will be executed. The action-specific arguments - are two null values. - - - - - The possible return codes for the progress callback. - - - - - The operation should continue. - - - - - The operation should be interrupted. - - - - - The return code for the current call into the authorizer. - - - - - The action will be allowed. - - - - - The overall action will be disallowed and an error message will be - returned from the query preparation method. - - - - - The specific action will be disallowed; however, the overall action - will continue. The exact effects of this return code vary depending - on the specific action, please refer to the SQLite core library - documentation for futher details. - - - - - Class used internally to determine the datatype of a column in a resultset - - - - - The DbType of the column, or DbType.Object if it cannot be determined - - - - - The affinity of a column, used for expressions or when Type is DbType.Object - - - - - Constructs a default instance of this type. - - - - - Constructs an instance of this type with the specified field values. - - - The type affinity to use for the new instance. - - - The database type to use for the new instance. - - - - - SQLite implementation of DbDataAdapter. - - - - - This class is just a shell around the DbDataAdapter. Nothing from - DbDataAdapter is overridden here, just a few constructors are defined. - - - Default constructor. - - - - - Constructs a data adapter using the specified select command. - - - The select command to associate with the adapter. - - - - - Constructs a data adapter with the supplied select command text and - associated with the specified connection. - - - The select command text to associate with the data adapter. - - - The connection to associate with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - - - Constructs a data adapter with the specified select command text, - and using the specified database connection string. - - - The select command text to use to construct a select command. - - - A connection string suitable for passing to a new SQLiteConnection, - which is associated with the select command. - - - Non-zero to parse the connection string using the built-in (i.e. - framework provided) parser when opening the connection. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - Row updating event handler - - - - - Row updated event handler - - - - - Raised by the underlying DbDataAdapter when a row is being updated - - The event's specifics - - - - Raised by DbDataAdapter after a row is updated - - The event's specifics - - - - Gets/sets the select command for this DataAdapter - - - - - Gets/sets the insert command for this DataAdapter - - - - - Gets/sets the update command for this DataAdapter - - - - - Gets/sets the delete command for this DataAdapter - - - - - SQLite implementation of DbDataReader. - - - - - Underlying command this reader is attached to - - - - - The flags pertaining to the associated connection (via the command). - - - - - Index of the current statement in the command being processed - - - - - Current statement being Read() - - - - - State of the current statement being processed. - -1 = First Step() executed, so the first Read() will be ignored - 0 = Actively reading - 1 = Finished reading - 2 = Non-row-returning statement, no records - - - - - Number of records affected by the insert/update statements executed on the command - - - - - Count of fields (columns) in the row-returning statement currently being processed - - - - - The number of calls to Step() that have returned true (i.e. the number of rows that - have been read in the current result set). - - - - - Maps the field (column) names to their corresponding indexes within the results. - - - - - Datatypes of active fields (columns) in the current statement, used for type-restricting data - - - - - The behavior of the datareader - - - - - If set, then dispose of the command object when the reader is finished - - - - - If set, then raise an exception when the object is accessed after being disposed. - - - - - An array of rowid's for the active statement if CommandBehavior.KeyInfo is specified - - - - - Matches the version of the connection. - - - - - The "stub" (i.e. placeholder) base schema name to use when returning - column schema information. Matches the base schema name used by the - associated connection. - - - - - Internal constructor, initializes the datareader and sets up to begin executing statements - - The SQLiteCommand this data reader is for - The expected behavior of the data reader - - - - Dispose of all resources used by this datareader. - - - - - - Closes the datareader, potentially closing the connection as well if CommandBehavior.CloseConnection was specified. - - - - - Throw an error if the datareader is closed - - - - - Throw an error if a row is not loaded - - - - - Enumerator support - - Returns a DbEnumerator object. - - - - Not implemented. Returns 0 - - - - - Returns the number of columns in the current resultset - - - - - Forces the connection flags cached by this data reader to be refreshed - from the underlying connection. - - - - - Returns the number of rows seen so far in the current result set. - - - - - Returns the number of visible fields in the current resultset - - - - - This method is used to make sure the result set is open and a row is currently available. - - - - - SQLite is inherently un-typed. All datatypes in SQLite are natively strings. The definition of the columns of a table - and the affinity of returned types are all we have to go on to type-restrict data in the reader. - - This function attempts to verify that the type of data being requested of a column matches the datatype of the column. In - the case of columns that are not backed into a table definition, we attempt to match up the affinity of a column (int, double, string or blob) - to a set of known types that closely match that affinity. It's not an exact science, but its the best we can do. - - - This function throws an InvalidTypeCast() exception if the requested type doesn't match the column's definition or affinity. - - The index of the column to type-check - The type we want to get out of the column - - - - Invokes the data reader value callback configured for the database - type name associated with the specified column. If no data reader - value callback is available for the database type name, do nothing. - - - The index of the column being read. - - - The extra event data to pass into the callback. - - - Non-zero if the default handling for the data reader call should be - skipped. If this is set to non-zero and the necessary return value - is unavailable or unsuitable, an exception will be thrown. - - - - - Attempts to query the integer identifier for the current row. This - will not work for tables that were created WITHOUT ROWID -OR- if the - query does not include the "rowid" column or one of its aliases -OR- - if the was not created with the - flag. - - - The index of the BLOB column. - - - The integer identifier for the current row -OR- null if it could not - be determined. - - - - - Retrieves the column as a object. - This will not work for tables that were created WITHOUT ROWID - -OR- if the query does not include the "rowid" column or one - of its aliases -OR- if the was - not created with the - flag. - - The index of the column. - - Non-zero to open the blob object for read-only access. - - A new object. - - - - Retrieves the column as a boolean value - - The index of the column. - bool - - - - Retrieves the column as a single byte value - - The index of the column. - byte - - - - Retrieves a column as an array of bytes (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the bytes into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of bytes written into the array - - To determine the number of bytes in the column, pass a null value for the buffer. The total length will be returned. - - - - - Returns the column as a single character - - The index of the column. - char - - - - Retrieves a column as an array of chars (blob) - - The index of the column. - The zero-based index of where to begin reading the data - The buffer to write the characters into - The zero-based index of where to begin writing into the array - The number of bytes to retrieve - The actual number of characters written into the array - - To determine the number of characters in the column, pass a null value for the buffer. The total length will be returned. - - - - - Retrieves the name of the back-end datatype of the column - - The index of the column. - string - - - - Retrieve the column as a date/time value - - The index of the column. - DateTime - - - - Retrieve the column as a decimal value - - The index of the column. - decimal - - - - Returns the column as a double - - The index of the column. - double - - - - Determines and returns the of the - specified column. - - - The index of the column. - - - The associated with the specified - column, if any. - - - - - Returns the .NET type of a given column - - The index of the column. - Type - - - - Returns a column as a float value - - The index of the column. - float - - - - Returns the column as a Guid - - The index of the column. - Guid - - - - Returns the column as a short - - The index of the column. - Int16 - - - - Retrieves the column as an int - - The index of the column. - Int32 - - - - Retrieves the column as a long - - The index of the column. - Int64 - - - - Retrieves the name of the column - - The index of the column. - string - - - - Returns the name of the database associated with the specified column. - - The index of the column. - string - - - - Returns the name of the table associated with the specified column. - - The index of the column. - string - - - - Returns the original name of the specified column. - - The index of the column. - string - - - - Retrieves the i of a column, given its name - - The name of the column to retrieve - The int i of the column - - - - Schema information in SQLite is difficult to map into .NET conventions, so a lot of work must be done - to gather the necessary information so it can be represented in an ADO.NET manner. - - Returns a DataTable containing the schema information for the active SELECT statement being processed. - - - - Retrieves the column as a string - - The index of the column. - string - - - - Retrieves the column as an object corresponding to the underlying datatype of the column - - The index of the column. - object - - - - Retreives the values of multiple columns, up to the size of the supplied array - - The array to fill with values from the columns in the current resultset - The number of columns retrieved - - - - Returns a collection containing all the column names and values for the - current row of data in the current resultset, if any. If there is no - current row or no current resultset, an exception may be thrown. - - - The collection containing the column name and value information for the - current row of data in the current resultset or null if this information - cannot be obtained. - - - - - Returns True if the resultset has rows that can be fetched - - - - - Returns True if the data reader is closed - - - - - Returns True if the specified column is null - - The index of the column. - True or False - - - - Moves to the next resultset in multiple row-returning SQL command. - - True if the command was successful and a new resultset is available, False otherwise. - - - - This method attempts to query the database connection associated with - the data reader in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Retrieves the SQLiteType for a given column and row value. - - - The original SQLiteType structure, based only on the column. - - - The textual value of the column for a given row. - - - The SQLiteType structure. - - - - - Retrieves the SQLiteType for a given column, and caches it to avoid repetetive interop calls. - - The flags associated with the parent connection object. - The index of the column. - A SQLiteType structure - - - - Reads the next row from the resultset - - True if a new row was successfully loaded and is ready for processing - - - - Returns the number of rows affected by the statement being executed. - The value returned may not be accurate for DDL statements. Also, it - will be -1 for any statement that does not modify the database (e.g. - SELECT). If an otherwise read-only statement modifies the database - indirectly (e.g. via a virtual table or user-defined function), the - value returned is undefined. - - - - - Indexer to retrieve data from a column given its name - - The name of the column to retrieve data for - The value contained in the column - - - - Indexer to retrieve data from a column given its i - - The index of the column. - The value contained in the column - - - - SQLite exception class. - - - - - This value was copied from the "WinError.h" file included with the - Platform SDK for Windows 10. - - - - - Private constructor for use with serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - Public constructor for generating a SQLite exception given the error - code and message. - - - The SQLite return code to report. - - - Message text to go along with the return code message text. - - - - - Public constructor that uses the base class constructor for the error - message. - - Error message text. - - - - Public constructor that uses the default base class constructor. - - - - - Public constructor that uses the base class constructor for the error - message and inner exception. - - Error message text. - The original (inner) exception. - - - - Adds extra information to the serialized object data specific to this - class type. This is only used for serialization. - - - Holds the serialized object data about the exception being thrown. - - - Contains contextual information about the source or destination. - - - - - Gets the associated SQLite result code for this exception as a - . This property returns the same - underlying value as the property. - - - - - Gets the associated SQLite return code for this exception as an - . For desktop versions of the .NET Framework, - this property overrides the property of the same name within the - - class. This property returns the same underlying value as the - property. - - - - - This method performs extra initialization tasks. It may be called by - any of the constructors of this class. It must not throw exceptions. - - - - - Maps a Win32 error code to an HRESULT. - - - The specified Win32 error code. It must be within the range of zero - (0) to 0xFFFF (65535). - - - Non-zero if the HRESULT should indicate success; otherwise, zero. - - - The integer value of the HRESULT. - - - - - Attempts to map the specified onto an - existing HRESULT -OR- a Win32 error code wrapped in an HRESULT. The - mappings may not have perfectly matching semantics; however, they do - have the benefit of being unique within the context of this exception - type. - - - The to map. - - - The integer HRESULT value -OR- null if there is no known mapping. - - - - - Returns the error message for the specified SQLite return code. - - The SQLite return code. - The error message or null if it cannot be found. - - - - Returns the composite error message based on the SQLite return code - and the optional detailed error message. - - The SQLite return code. - Optional detailed error message. - Error message text for the return code. - - - - SQLite error codes. Actually, this enumeration represents a return code, - which may also indicate success in one of several ways (e.g. SQLITE_OK, - SQLITE_ROW, and SQLITE_DONE). Therefore, the name of this enumeration is - something of a misnomer. - - - - - The error code is unknown. This error code - is only used by the managed wrapper itself. - - - - - Successful result - - - - - SQL error or missing database - - - - - Internal logic error in SQLite - - - - - Access permission denied - - - - - Callback routine requested an abort - - - - - The database file is locked - - - - - A table in the database is locked - - - - - A malloc() failed - - - - - Attempt to write a readonly database - - - - - Operation terminated by sqlite3_interrupt() - - - - - Some kind of disk I/O error occurred - - - - - The database disk image is malformed - - - - - Unknown opcode in sqlite3_file_control() - - - - - Insertion failed because database is full - - - - - Unable to open the database file - - - - - Database lock protocol error - - - - - Database is empty - - - - - The database schema changed - - - - - String or BLOB exceeds size limit - - - - - Abort due to constraint violation - - - - - Data type mismatch - - - - - Library used incorrectly - - - - - Uses OS features not supported on host - - - - - Authorization denied - - - - - Auxiliary database format error - - - - - 2nd parameter to sqlite3_bind out of range - - - - - File opened that is not a database file - - - - - Notifications from sqlite3_log() - - - - - Warnings from sqlite3_log() - - - - - sqlite3_step() has another row ready - - - - - sqlite3_step() has finished executing - - - - - Used to mask off extended result codes - - - - - A collation sequence was referenced by a schema and it cannot be - found. - - - - - An internal operation failed and it may succeed if retried. - - - - - The specified snapshot has been overwritten by a checkpoint. - - - - - A file read operation failed. - - - - - A file read operation returned less data than requested. - - - - - A file write operation failed. - - - - - A file synchronization operation failed. - - - - - A directory synchronization operation failed. - - - - - A file truncate operation failed. - - - - - A file metadata operation failed. - - - - - A file unlock operation failed. - - - - - A file lock operation failed. - - - - - A file delete operation failed. - - - - - Not currently used. - - - - - Out-of-memory during a file operation. - - - - - A file existence/status operation failed. - - - - - A check for a reserved lock failed. - - - - - A file lock operation failed. - - - - - A file close operation failed. - - - - - A directory close operation failed. - - - - - A shared memory open operation failed. - - - - - A shared memory size operation failed. - - - - - A shared memory lock operation failed. - - - - - A shared memory map operation failed. - - - - - A file seek operation failed. - - - - - A file delete operation failed because it does not exist. - - - - - A file memory mapping operation failed. - - - - - The temporary directory path could not be obtained. - - - - - A path string conversion operation failed. - - - - - Reserved. - - - - - An attempt to authenticate failed. - - - - - An attempt to begin a file system transaction failed. - - - - - An attempt to commit a file system transaction failed. - - - - - An attempt to rollback a file system transaction failed. - - - - - A database table is locked in shared-cache mode. - - - - - A virtual table in the database is locked. - - - - - A database file is locked due to a recovery operation. - - - - - A database file is locked due to snapshot semantics. - - - - - A database file cannot be opened because no temporary directory is available. - - - - - A database file cannot be opened because its path represents a directory. - - - - - A database file cannot be opened because its full path could not be obtained. - - - - - A database file cannot be opened because a path string conversion operation failed. - - - - - No longer used. - - - - - A database file is a symbolic link and cannot be opened. - - - - - A virtual table is malformed. - - - - - A required sequence table is missing or corrupt. - - - - - A database file is read-only due to a recovery operation. - - - - - A database file is read-only because a lock could not be obtained. - - - - - A database file is read-only because it needs rollback processing. - - - - - A database file is read-only because it was moved while open. - - - - - The shared-memory file is read-only and it should be read-write. - - - - - Unable to create journal file because the directory is read-only. - - - - - An operation is being aborted due to rollback processing. - - - - - A CHECK constraint failed. - - - - - A commit hook produced a unsuccessful return code. - - - - - A FOREIGN KEY constraint failed. - - - - - Not currently used. - - - - - A NOT NULL constraint failed. - - - - - A PRIMARY KEY constraint failed. - - - - - The RAISE function was used by a trigger-program. - - - - - A UNIQUE constraint failed. - - - - - Not currently used. - - - - - A ROWID constraint failed. - - - - - A database cursor is busy and cannot be moved. - - - - - Frames were recovered from the WAL log file. - - - - - Pages were recovered from the journal file. - - - - - An automatic index was created to process a query. - - - - - User authentication failed. - - - - - Success. Prevents the extension from unloading until the process - terminates. - - - - - Success. The specified file name refers to a symbolic link. - - - - - SQLite implementation of . - - - - - Constructs a new instance. - - - - - Cleans up resources (native and managed) associated with the current instance. - - - - - Cleans up resources associated with the current instance. - - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. This event is provided for backward compatibility only. - New code should use the class instead. - - - - - Static instance member which returns an instanced class. - - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - Creates and returns a new object. - - The new object. - - - - This abstract class is designed to handle user-defined functions easily. An instance of the derived class is made for each - connection to the database. - - - Although there is one instance of a class derived from SQLiteFunction per database connection, the derived class has no access - to the underlying connection. This is necessary to deter implementers from thinking it would be a good idea to make database - calls during processing. - - It is important to distinguish between a per-connection instance, and a per-SQL statement context. One instance of this class - services all SQL statements being stepped through on that connection, and there can be many. One should never store per-statement - information in member variables of user-defined function classes. - - For aggregate functions, always create and store your per-statement data in the contextData object on the 1st step. This data will - be automatically freed for you (and Dispose() called if the item supports IDisposable) when the statement completes. - - - - - The base connection this function is attached to - - - - - Internal array used to keep track of aggregate function context data - - - - - The connection flags associated with this object (this should be the - same value as the flags associated with the parent connection object). - - - - - Holds a reference to the callback function for user functions - - - - - Holds a reference to the callbakc function for stepping in an aggregate function - - - - - Holds a reference to the callback function for finalizing an aggregate function - - - - - Holds a reference to the callback function for collating sequences - - - - - Current context of the current callback. Only valid during a callback - - - - - This static dictionary contains all the registered (known) user-defined - functions declared using the proper attributes. The contained dictionary - values are always null and are not currently used. - - - - - Internal constructor, initializes the function's internal variables. - - - - - Constructs an instance of this class using the specified data-type - conversion parameters. - - - The DateTime format to be used when converting string values to a - DateTime and binding DateTime parameters. - - - The to be used when creating DateTime - values. - - - The format string to be used when parsing and formatting DateTime - values. - - - Non-zero to create a UTF-16 data-type conversion context; otherwise, - a UTF-8 data-type conversion context will be created. - - - - - Disposes of any active contextData variables that were not automatically cleaned up. Sometimes this can happen if - someone closes the connection while a DataReader is open. - - - - - Placeholder for a user-defined disposal routine - - True if the object is being disposed explicitly - - - - Cleans up resources associated with the current instance. - - - - - Returns a reference to the underlying connection's SQLiteConvert class, which can be used to convert - strings and DateTime's into the current connection's encoding schema. - - - - - Scalar functions override this method to do their magic. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The arguments for the command to process - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - Aggregate functions override this method to do their magic. - - - Typically you'll be updating whatever you've placed in the contextData field and returning as quickly as possible. - - The arguments for the command to process - The 1-based step number. This is incrememted each time the step method is called. - A placeholder for implementers to store contextual data pertaining to the current context. - - - - Aggregate functions override this method to finish their aggregate processing. - - - If you implemented your aggregate function properly, - you've been recording and keeping track of your data in the contextData object provided, and now at this stage you should have - all the information you need in there to figure out what to return. - NOTE: It is possible to arrive here without receiving a previous call to Step(), in which case the contextData will - be null. This can happen when no rows were returned. You can either return null, or 0 or some other custom return value - if that is the case. - - Your own assigned contextData, provided for you so you can return your final results. - You may return most simple types as a return value, null or DBNull.Value to return null, DateTime, or - you may return an Exception-derived class if you wish to return an error to SQLite. Do not actually throw the error, - just return it! - - - - - User-defined collating sequences override this method to provide a custom string sorting algorithm. - - The first string to compare. - The second strnig to compare. - 1 if param1 is greater than param2, 0 if they are equal, or -1 if param1 is less than param2. - - - - Converts an IntPtr array of context arguments to an object array containing the resolved parameters the pointers point to. - - - Parameters passed to functions have only an affinity for a certain data type, there is no underlying schema available - to force them into a certain type. Therefore the only types you will ever see as parameters are - DBNull.Value, Int64, Double, String or byte[] array. - - The number of arguments - A pointer to the array of arguments - An object array of the arguments once they've been converted to .NET values - - - - Takes the return value from Invoke() and Final() and figures out how to return it to SQLite's context. - - The context the return value applies to - The parameter to return to SQLite - - - - Internal scalar callback function, which wraps the raw context pointer and calls the virtual Invoke() method. - WARNING: Must not throw exceptions. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - Internal collating sequence function, which wraps up the raw string pointers and executes the Compare() virtual function. - WARNING: Must not throw exceptions. - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. Returns 0 if an exception is caught. - - - - The internal aggregate Step function callback, which wraps the raw context pointer and calls the virtual Step() method. - WARNING: Must not throw exceptions. - - - This function takes care of doing the lookups and getting the important information put together to call the Step() function. - That includes pulling out the user's contextData and updating it after the call is made. We use a sorted list for this so - binary searches can be done to find the data. - - A raw context pointer - Number of arguments passed in - A pointer to the array of arguments - - - - An internal aggregate Final function callback, which wraps the context pointer and calls the virtual Final() method. - WARNING: Must not throw exceptions. - - A raw context pointer - - - - Using reflection, enumerate all assemblies in the current appdomain looking for classes that - have a SQLiteFunctionAttribute attribute, and registering them accordingly. - - - - - Manual method of registering a function. The type must still have the SQLiteFunctionAttributes in order to work - properly, but this is a workaround for the Compact Framework where enumerating assemblies is not currently supported. - - The type of the function to register - - - - Alternative method of registering a function. This method - does not require the specified type to be annotated with - . - - - The name of the function to register. - - - The number of arguments accepted by the function. - - - The type of SQLite function being resitered (e.g. scalar, - aggregate, or collating sequence). - - - The that actually implements the function. - This will only be used if the - and parameters are null. - - - The to be used for all calls into the - , - , - and virtual methods. - - - The to be used for all calls into the - virtual method. This - parameter is only necessary for aggregate functions. - - - - - Replaces a registered function, disposing of the associated (old) - value if necessary. - - - The attribute that describes the function to replace. - - - The new value to use. - - - Non-zero if an existing registered function was replaced; otherwise, - zero. - - - - - Creates a instance based on the specified - . - - - The containing the metadata about - the function to create. - - - The created function -OR- null if the function could not be created. - - - Non-zero if the function was created; otherwise, zero. - - - - - Called by the SQLiteBase derived classes, this method binds all registered (known) user-defined functions to a connection. - It is done this way so that all user-defined functions will access the database using the same encoding scheme - as the connection (UTF-8 or UTF-16). - - - The wrapper functions that interop with SQLite will create a unique cookie value, which internally is a pointer to - all the wrapped callback functions. The interop function uses it to map CDecl callbacks to StdCall callbacks. - - The base object on which the functions are to bind. - The flags associated with the parent connection object. - Returns a logical list of functions which the connection should retain until it is closed. - - - - Called by the SQLiteBase derived classes, this method unbinds all registered (known) - functions -OR- all previously bound user-defined functions from a connection. - - The base object from which the functions are to be unbound. - The flags associated with the parent connection object. - - Non-zero to unbind all registered (known) functions -OR- zero to unbind all functions - currently bound to the connection. - - Non-zero if all the specified user-defined functions were unbound. - - - - This function binds a user-defined function to a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - - - - This function unbinds a user-defined functions from a connection. - - - The object instance associated with the - that the function should be bound to. - - - The object instance containing - the metadata for the function to be bound. - - - The object instance that implements the - function to be bound. - - - The flags associated with the parent connection object. - - Non-zero if the function was unbound. - - - - This type is used with the - method. - - - This is always the string literal "Invoke". - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This type is used with the - method. - - - This is always the string literal "Step". - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This type is used with the - method. - - - This is always the string literal "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This type is used with the - method. - - - This is always the string literal "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - This class implements a SQLite function using a . - All the virtual methods of the class are - implemented using calls to the , - , , - and strongly typed delegate types - or via the method. - The arguments are presented in the same order they appear in - the associated methods with one exception: - the first argument is the name of the virtual method being implemented. - - - - - This error message is used by the overridden virtual methods when - a required property (e.g. - or ) has not been - set. - - - - - This error message is used by the overridden - method when the result does not have a type of . - - - - - Constructs an empty instance of this class. - - - - - Constructs an instance of this class using the specified - as the - implementation. - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Invoke". - - - The original arguments received by the method. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Step". - - - The original arguments received by the method. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Updates the output arguments for the method, - using an of . The first - argument is always the literal string "Step". Currently, only the - parameter is updated. - - - The original arguments received by the method. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Final". - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - Returns the list of arguments for the method, - as an of . The first - argument is always the literal string "Compare". - - - The first string to compare. - - - The second strnig to compare. - - - Non-zero if the returned arguments are going to be used with the - type; otherwise, zero. - - - The arguments to pass to the configured . - - - - - The to be used for all calls into the - , , and - virtual methods needed by the - base class. - - - - - The to be used for all calls into the - virtual methods needed by the - base class. - - - - - This virtual method is the implementation for scalar functions. - See the method for more - details. - - - The arguments for the scalar function. - - - The result of the scalar function. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - The arguments for the aggregate function. - - - The step number (one based). This is incrememted each time the - method is called. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - - - This virtual method is part of the implementation for aggregate - functions. See the method - for more details. - - - A placeholder for implementers to store contextual data pertaining - to the current context. - - - The result of the aggregate function. - - - - - This virtual method is part of the implementation for collating - sequences. See the method - for more details. - - - The first string to compare. - - - The second strnig to compare. - - - A positive integer if the parameter is - greater than the parameter, a negative - integer if the parameter is less than - the parameter, or zero if they are - equal. - - - - - Extends SQLiteFunction and allows an inherited class to obtain the collating sequence associated with a function call. - - - User-defined functions can call the GetCollationSequence() method in this class and use it to compare strings and char arrays. - - - - - Obtains the collating sequence in effect for the given function. - - - - - - Cleans up resources (native and managed) associated with the current instance. - - - Zero when being disposed via garbage collection; otherwise, non-zero. - - - - - The type of user-defined function to declare - - - - - Scalar functions are designed to be called and return a result immediately. Examples include ABS(), Upper(), Lower(), etc. - - - - - Aggregate functions are designed to accumulate data until the end of a call and then return a result gleaned from the accumulated data. - Examples include SUM(), COUNT(), AVG(), etc. - - - - - Collating sequences are used to sort textual data in a custom manner, and appear in an ORDER BY clause. Typically text in an ORDER BY is - sorted using a straight case-insensitive comparison function. Custom collating sequences can be used to alter the behavior of text sorting - in a user-defined manner. - - - - - An internal callback delegate declaration. - - Raw native context pointer for the user function. - Total number of arguments to the user function. - Raw native pointer to the array of raw native argument pointers. - - - - An internal final callback delegate declaration. - - Raw context pointer for the user function - - - - Internal callback delegate for implementing collating sequences - - Not used - Length of the string pv1 - Pointer to the first string to compare - Length of the string pv2 - Pointer to the second string to compare - Returns -1 if the first string is less than the second. 0 if they are equal, or 1 if the first string is greater - than the second. - - - - The type of collating sequence - - - - - The built-in BINARY collating sequence - - - - - The built-in NOCASE collating sequence - - - - - The built-in REVERSE collating sequence - - - - - A custom user-defined collating sequence - - - - - The encoding type the collation sequence uses - - - - - The collation sequence is UTF8 - - - - - The collation sequence is UTF16 little-endian - - - - - The collation sequence is UTF16 big-endian - - - - - A struct describing the collating sequence a function is executing in - - - - - The name of the collating sequence - - - - - The type of collating sequence - - - - - The text encoding of the collation sequence - - - - - Context of the function that requested the collating sequence - - - - - Calls the base collating sequence to compare two strings - - The first string to compare - The second string to compare - -1 if s1 is less than s2, 0 if s1 is equal to s2, and 1 if s1 is greater than s2 - - - - Calls the base collating sequence to compare two character arrays - - The first array to compare - The second array to compare - -1 if c1 is less than c2, 0 if c1 is equal to c2, and 1 if c1 is greater than c2 - - - - A simple custom attribute to enable us to easily find user-defined functions in - the loaded assemblies and initialize them in SQLite as connections are made. - - - - - Default constructor, initializes the internal variables for the function. - - - - - Constructs an instance of this class. This sets the initial - , , and - properties to null. - - - The name of the function, as seen by the SQLite core library. - - - The number of arguments that the function will accept. - - - The type of function being declared. This will either be Scalar, - Aggregate, or Collation. - - - - - The function's name as it will be used in SQLite command text. - - - - - The number of arguments this function expects. -1 if the number of arguments is variable. - - - - - The type of function this implementation will be. - - - - - The object instance that describes the class - containing the implementation for the associated function. The value of - this property will not be used if either the or - property values are set to non-null. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - The that refers to the implementation for the - associated function. If this property value is set to non-null, it will - be used instead of the property value. - - - - - This class provides key info for a given SQLite statement. - - Providing key information for a given statement is non-trivial :( - - - - - - Used to support CommandBehavior.KeyInfo - - - - - Used to keep track of the per-table RowId column metadata. - - - - - A single sub-query for a given table/database. - - - - - This function does all the nasty work at determining what keys need to be returned for - a given statement. - - - - - - - - How many additional columns of keyinfo we're holding - - - - - Make sure all the subqueries are open and ready and sync'd with the current rowid - of the table they're supporting - - - - - Release any readers on any subqueries - - - - - Append all the columns we've added to the original query to the schema - - - - - - Event data for logging event handlers. - - - - - The error code. The type of this object value should be - or . - - - - - SQL statement text as the statement first begins executing - - - - - Extra data associated with this event, if any. - - - - - Constructs the object. - - Should be null. - - The error code. The type of this object value should be - or . - - The error message, if any. - The extra data, if any. - - - - Raised when a log event occurs. - - The current connection - Event arguments of the trace - - - - Manages the SQLite custom logging functionality and the associated - callback for the whole process. - - - - - Object used to synchronize access to the static instance data - for this class. - - - - - Member variable to store the AppDomain.DomainUnload event handler. - - - - - Member variable to store the application log handler to call. - - - - - The default log event handler. - - - - - The log callback passed to native SQLite engine. This must live - as long as the SQLite library has a pointer to it. - - - - - The base SQLite object to interop with. - - - - - The number of times that the - has been called when the logging subystem was actually eligible - to be initialized (i.e. without the "No_SQLiteLog" environment - variable being set). - - - - - This will be non-zero if an attempt was already made to initialize - the (managed) logging subsystem. - - - - - This will be non-zero if logging is currently enabled. - - - - - Initializes the SQLite logging facilities. - - - - - Initializes the SQLite logging facilities. - - - The name of the managed class that called this method. This - parameter may be null. - - - - - Handles the AppDomain being unloaded. - - Should be null. - The data associated with this event. - - - - This event is raised whenever SQLite raises a logging event. - Note that this should be set as one of the first things in the - application. - - - - - If this property is true, logging is enabled; otherwise, logging is - disabled. When logging is disabled, no logging events will fire. - - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The SQLite error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - The integer error code. - The message to be logged. - - - - Log a message to all the registered log event handlers without going - through the SQLite library. - - - The error code. The type of this object value should be - System.Int32 or SQLiteErrorCode. - - The message to be logged. - - - - Creates and initializes the default log event handler. - - - - - Adds the default log event handler to the list of handlers. - - - - - Removes the default log event handler from the list of handlers. - - - - - Internal proxy function that calls any registered application log - event handlers. - - WARNING: This method is used more-or-less directly by native code, - do not modify its type signature. - - - The extra data associated with this message, if any. - - - The error code associated with this message. - - - The message string to be logged. - - - - - Default logger. Currently, uses the Trace class (i.e. sends events - to the current trace listeners, if any). - - Should be null. - The data associated with this event. - - - - MetaDataCollections specific to SQLite - - - - - Returns a list of databases attached to the connection - - - - - Returns column information for the specified table - - - - - Returns index information for the optionally-specified table - - - - - Returns base columns for the given index - - - - - Returns the tables in the given catalog - - - - - Returns user-defined views in the given catalog - - - - - Returns underlying column information on the given view - - - - - Returns foreign key information for the given catalog - - - - - Returns the triggers on the database - - - - - SQLite implementation of DbParameter. - - - - - This value represents an "unknown" . - - - - - The command associated with this parameter. - - - - - The data type of the parameter - - - - - The version information for mapping the parameter - - - - - The value of the data in the parameter - - - - - The source column for the parameter - - - - - The column name - - - - - The data size, unused by SQLite - - - - - The database type name associated with this parameter, if any. - - - - - Constructor used when creating for use with a specific command. - - - The command associated with this parameter. - - - - - Default constructor - - - - - Constructs a named parameter given the specified parameter name - - The parameter name - - - - Constructs a named parameter given the specified parameter name and initial value - - The parameter name - The initial value of the parameter - - - - Constructs a named parameter of the specified type - - The parameter name - The datatype of the parameter - - - - Constructs a named parameter of the specified type and source column reference - - The parameter name - The data type - The source column - - - - Constructs a named parameter of the specified type, source column and row version - - The parameter name - The data type - The source column - The row version information - - - - Constructs an unnamed parameter of the specified data type - - The datatype of the parameter - - - - Constructs an unnamed parameter of the specified data type and sets the initial value - - The datatype of the parameter - The initial value of the parameter - - - - Constructs an unnamed parameter of the specified data type and source column - - The datatype of the parameter - The source column - - - - Constructs an unnamed parameter of the specified data type, source column and row version - - The data type - The source column - The row version information - - - - Constructs a named parameter of the specified type and size - - The parameter name - The data type - The size of the parameter - - - - Constructs a named parameter of the specified type, size and source column - - The name of the parameter - The data type - The size of the parameter - The source column - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - The source column - The row version information - - - - Constructs a named parameter of the specified type, size, source column and row version - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - Ignored - The source column - The row version information - The initial value to assign the parameter - - - - Constructs a named parameter, yet another flavor - - The name of the parameter - The data type - The size of the parameter - Only input parameters are supported in SQLite - Ignored - Ignored - The source column - The row version information - Whether or not this parameter is for comparing NULL's - The intial value to assign the parameter - - - - Constructs an unnamed parameter of the specified type and size - - The data type - The size of the parameter - - - - Constructs an unnamed parameter of the specified type, size, and source column - - The data type - The size of the parameter - The source column - - - - Constructs an unnamed parameter of the specified type, size, source column and row version - - The data type - The size of the parameter - The source column - The row version information - - - - The command associated with this parameter. - - - - - Whether or not the parameter can contain a null value - - - - - Returns the datatype of the parameter - - - - - Supports only input parameters - - - - - Returns the parameter name - - - - - Resets the DbType of the parameter so it can be inferred from the value - - - - - Returns the size of the parameter - - - - - Gets/sets the source column - - - - - Used by DbCommandBuilder to determine the mapping for nullable fields - - - - - Gets and sets the row version - - - - - Gets and sets the parameter value. If no datatype was specified, the datatype will assume the type from the value given. - - - - - The database type name associated with this parameter, if any. - - - - - Clones a parameter - - A new, unassociated SQLiteParameter - - - - SQLite implementation of DbParameterCollection. - - - - - The underlying command to which this collection belongs - - - - - The internal array of parameters in this collection - - - - - Determines whether or not all parameters have been bound to their statement(s) - - - - - Initializes the collection - - The command to which the collection belongs - - - - Returns false - - - - - Returns false - - - - - Returns false - - - - - Returns null - - - - - Retrieves an enumerator for the collection - - An enumerator for the underlying array - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - The source column - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - The size of the value - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter name - The data type - A SQLiteParameter object - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a parameter to the collection - - The parameter to add - A zero-based index of where the parameter is located in the array - - - - Adds a named/unnamed parameter and its value to the parameter collection. - - Name of the parameter, or null to indicate an unnamed parameter - The initial value of the parameter - Returns the SQLiteParameter object created during the call. - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Adds an array of parameters to the collection - - The array of parameters to add - - - - Clears the array and resets the collection - - - - - Determines if the named parameter exists in the collection - - The name of the parameter to check - True if the parameter is in the collection - - - - Determines if the parameter exists in the collection - - The SQLiteParameter to check - True if the parameter is in the collection - - - - Not implemented - - - - - - - Returns a count of parameters in the collection - - - - - Overloaded to specialize the return value of the default indexer - - Name of the parameter to get/set - The specified named SQLite parameter - - - - Overloaded to specialize the return value of the default indexer - - The index of the parameter to get/set - The specified SQLite parameter - - - - Retrieve a parameter by name from the collection - - The name of the parameter to fetch - A DbParameter object - - - - Retrieves a parameter by its index in the collection - - The index of the parameter to retrieve - A DbParameter object - - - - Returns the index of a parameter given its name - - The name of the parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Returns the index of a parameter - - The parameter to find - -1 if not found, otherwise a zero-based index of the parameter - - - - Inserts a parameter into the array at the specified location - - The zero-based index to insert the parameter at - The parameter to insert - - - - Removes a parameter from the collection - - The parameter to remove - - - - Removes a parameter from the collection given its name - - The name of the parameter to remove - - - - Removes a parameter from the collection given its index - - The zero-based parameter index to remove - - - - Re-assign the named parameter to a new parameter object - - The name of the parameter to replace - The new parameter - - - - Re-assign a parameter at the specified index - - The zero-based index of the parameter to replace - The new parameter - - - - Un-binds all parameters from their statements - - - - - This function attempts to map all parameters in the collection to all statements in a Command. - Since named parameters may span multiple statements, this function makes sure all statements are bound - to the same named parameter. Unnamed parameters are bound in sequence. - - - - - Represents a single SQL statement in SQLite. - - - - - The underlying SQLite object this statement is bound to - - - - - The command text of this SQL statement - - - - - The actual statement pointer - - - - - An index from which unnamed parameters begin - - - - - Names of the parameters as SQLite understands them to be - - - - - Parameters for this statement - - - - - Command this statement belongs to (if any) - - - - - The flags associated with the parent connection object. - - - - - Initializes the statement and attempts to get all information about parameters in the statement - - The base SQLite object - The flags associated with the parent connection object - The statement - The command text for this statement - The previous command in a multi-statement command - - - - Disposes and finalizes the statement - - - - - If the underlying database connection is open, fetches the number of changed rows - resulting from the most recent query; otherwise, does nothing. - - - The number of changes when true is returned. - Undefined if false is returned. - - - The read-only flag when true is returned. - Undefined if false is returned. - - Non-zero if the number of changed rows was fetched. - - - - Called by SQLiteParameterCollection, this function determines if the specified parameter name belongs to - this statement, and if so, keeps a reference to the parameter so it can be bound later. - - The parameter name to map - The parameter to assign it - - - - Bind all parameters, making sure the caller didn't miss any - - - - - This method attempts to query the database connection associated with - the statement in use. If the underlying command or connection is - unavailable, a null value will be returned. - - - The connection object -OR- null if it is unavailable. - - - - - Invokes the parameter binding callback configured for the database - type name associated with the specified column. If no parameter - binding callback is available for the database type name, do - nothing. - - - The index of the column being read. - - - The instance being bound to the - command. - - - Non-zero if the default handling for the parameter binding call - should be skipped (i.e. the parameter should not be bound at all). - Great care should be used when setting this to non-zero. - - - - - Perform the bind operation for an individual parameter - - The index of the parameter to bind - The parameter we're binding - - - - SQLite implementation of DbTransaction that does not support nested transactions. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - SQLite implementation of DbTransaction that does support nested transactions. - - - - - The original transaction level for the associated connection - when this transaction was created (i.e. begun). - - - - - The SAVEPOINT name for this transaction, if any. This will - only be non-null if this transaction is a nested one. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Commits the current transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Constructs the name of a new savepoint for this transaction. It - should only be called from the constructor of this class. - - - The name of the new savepoint -OR- null if it cannot be constructed. - - - - - Base class used by to implement DbTransaction for SQLite. - - - - - The connection to which this transaction is bound. - - - - - Matches the version of the connection. - - - - - The isolation level for this transaction. - - - - - Constructs the transaction object, binding it to the supplied connection - - The connection to open a transaction on - TRUE to defer the writelock, or FALSE to lock immediately - - - - Gets the isolation level of the transaction. SQLite only supports Serializable transactions. - - - - - Disposes the transaction. If it is currently active, any changes are rolled back. - - - - - Returns the underlying connection to which this transaction applies. - - - - - Forwards to the local Connection property - - - - - Rolls back the active transaction. - - - - - Attempts to start a transaction. An exception will be thrown if the transaction cannot - be started for any reason. - - TRUE to defer the writelock, or FALSE to lock immediately - - - - Issue a ROLLBACK command against the database connection, - optionally re-throwing any caught exception. - - - Non-zero to re-throw caught exceptions. - - - - - Checks the state of this transaction, optionally throwing an exception if a state - inconsistency is found. - - - Non-zero to throw an exception if a state inconsistency is found. - - - Non-zero if this transaction is valid; otherwise, false. - - - - - This static class provides some methods that are shared between the - native library pre-loader and other classes. - - - - - This lock is used to protect the static and - fields. - - - - - This type is only present when running on Mono. - - - - - This type is only present when running on .NET Core. - - - - - Keeps track of whether we are running on Mono. Initially null, it is - set by the method on its first call. Later, it - is returned verbatim by the method. - - - - - Keeps track of whether we are running on .NET Core. Initially null, - it is set by the method on its first - call. Later, it is returned verbatim by the - method. - - - - - Keeps track of whether we successfully invoked the - method. Initially null, it is set by - the method on its first call. - - - - - Determines the ID of the current process. Only used for debugging. - - - The ID of the current process -OR- zero if it cannot be determined. - - - - - Determines whether or not this assembly is running on Mono. - - - Non-zero if this assembly is running on Mono. - - - - - Determines whether or not this assembly is running on .NET Core. - - - Non-zero if this assembly is running on .NET Core. - - - - - Resets the cached value for the "PreLoadSQLite_BreakIntoDebugger" - configuration setting. - - - - - If the "PreLoadSQLite_BreakIntoDebugger" configuration setting is - present (e.g. via the environment), give the interactive user an - opportunity to attach a debugger to the current process; otherwise, - do nothing. - - - - - Determines the ID of the current thread. Only used for debugging. - - - The ID of the current thread -OR- zero if it cannot be determined. - - - - - Determines if the specified flags are present within the flags - associated with the parent connection object. - - - The flags associated with the parent connection object. - - - The flags to check for. - - - Non-zero if the specified flag or flags were present; otherwise, - zero. - - - - - Determines if preparing a query should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the query preparation should be logged; otherwise, zero. - - - - - Determines if pre-parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the pre-parameter binding should be logged; otherwise, - zero. - - - - - Determines if parameter binding should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the parameter binding should be logged; otherwise, zero. - - - - - Determines if an exception in a native callback should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be logged; otherwise, zero. - - - - - Determines if backup API errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the backup API error should be logged; otherwise, zero. - - - - - Determines if logging for the class is - disabled. - - - The flags associated with the parent connection object. - - - Non-zero if logging for the class is - disabled; otherwise, zero. - - - - - Determines if errors should be logged. - - - The flags associated with the parent connection object. - - - Non-zero if the error should be logged; - otherwise, zero. - - - - - Determines if exceptions should be - logged. - - - The flags associated with the parent connection object. - - - Non-zero if the exception should be - logged; otherwise, zero. - - - - - Determines if the current process is running on one of the Windows - [sub-]platforms. - - - Non-zero when running on Windows; otherwise, zero. - - - - - This is a wrapper around the - method. - On Mono, it has to call the method overload without the - parameter, due to a bug in Mono. - - - This is used for culture-specific formatting. - - - The format string. - - - An array the objects to format. - - - The resulting string. - - - - - This static class provides a thin wrapper around the native library - loading features of the underlying platform. - - - - - This delegate is used to wrap the concept of loading a native - library, based on a file name, and returning the loaded module - handle. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This delegate is used to wrap the concept of querying the machine - name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file using the Win32 - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the Win32 API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file using the POSIX - API. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process using - the POSIX API. - - - The machine name for the current process -OR- null on failure. - - - - - Attempts to load the specified native library file. - - - The file name of the native library to load. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - Attempts to determine the machine name of the current process. - - - The machine name for the current process -OR- null on failure. - - - - - This class declares P/Invoke methods to call native POSIX APIs. - - - - - This structure is used when running on POSIX operating systems - to store information about the current machine, including the - human readable name of the operating system as well as that of - the underlying hardware. - - - - - This structure is passed directly to the P/Invoke method to - obtain the information about the current machine, including - the human readable name of the operating system as well as - that of the underlying hardware. - - - - - This is the P/Invoke method that wraps the native Unix uname - function. See the POSIX documentation for full details on what it - does. - - - Structure containing a preallocated byte buffer to fill with the - requested information. - - - Zero for success and less than zero upon failure. - - - - - This is the P/Invoke method that wraps the native Unix dlopen - function. See the POSIX documentation for full details on what it - does. - - - The name of the executable library. - - - This must be a combination of the individual bit flags RTLD_LAZY, - RTLD_NOW, RTLD_GLOBAL, and/or RTLD_LOCAL. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Unix dlclose - function. See the POSIX documentation for full details on what it - does. - - - The handle to the loaded native library. - - - Zero upon success -OR- non-zero on failure. - - - - - For use with dlopen(), bind function calls lazily. - - - - - For use with dlopen(), bind function calls immediately. - - - - - For use with dlopen(), make symbols globally available. - - - - - For use with dlopen(), opposite of RTLD_GLOBAL, and the default. - - - - - For use with dlopen(), the defaults used by this class. - - - - - These are the characters used to separate the string fields within - the raw buffer returned by the P/Invoke method. - - - - - This method is a wrapper around the P/Invoke - method that extracts and returns the human readable strings from - the raw buffer. - - - This structure, which contains strings, will be filled based on the - data placed in the raw buffer returned by the - P/Invoke method. - - - Non-zero upon success; otherwise, zero. - - - - - This class declares P/Invoke methods to call native Win32 APIs. - - - - - This is the P/Invoke method that wraps the native Win32 LoadLibrary - function. See the MSDN documentation for full details on what it - does. - - - The name of the executable library. - - - The native module handle upon success -OR- IntPtr.Zero on failure. - - - - - This is the P/Invoke method that wraps the native Win32 GetSystemInfo - function. See the MSDN documentation for full details on what it - does. - - - The system information structure to be filled in by the function. - - - - - This enumeration contains the possible values for the processor - architecture field of the system information structure. - - - - - This structure contains information about the current computer. This - includes the processor type, page size, memory addresses, etc. - - - - - This class declares P/Invoke methods to call native SQLite APIs. - - - - - The file extension used for dynamic link libraries. - - - - - The file extension used for the XML configuration file. - - - - - This is the name of the XML configuration file specific to the - System.Data.SQLite assembly. - - - - - This is the XML configuratrion file token that will be replaced with - the qualified path to the directory containing the XML configuration - file. - - - - - This is the environment variable token that will be replaced with - the qualified path to the directory containing this assembly. - - - - - This is the environment variable token that will be replaced with an - abbreviation of the target framework attribute value associated with - this assembly. - - - - - This lock is used to protect the static _SQLiteNativeModuleFileName, - _SQLiteNativeModuleHandle, and processorArchitecturePlatforms fields. - - - - - This dictionary stores the mappings between target framework names - and their associated (NuGet) abbreviations. These mappings are only - used by the method. - - - - - This dictionary stores the mappings between processor architecture - names and platform names. These mappings are now used for two - purposes. First, they are used to determine if the assembly code - base should be used instead of the location, based upon whether one - or more of the named sub-directories exist within the assembly code - base. Second, they are used to assist in loading the appropriate - SQLite interop assembly into the current process. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable assembly directory. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - This is the cached return value from the - method -OR- null if that method - has never returned a valid value. - - - - - When this field is non-zero, it indicates the - method was not able to locate a - suitable XML configuration file name. The - method will check this - field and skips calls into the - method whenever it is non-zero. - - - - - For now, this method simply calls the Initialize method. - - - - - Attempts to initialize this class by pre-loading the native SQLite - library for the processor architecture of the current process. - - - - - Combines two path strings. - - - The first path -OR- null. - - - The second path -OR- null. - - - The combined path string -OR- null if both of the original path - strings are null. - - - - - Resets the cached XML configuration file name value, thus forcing the - next call to method to rely - upon the method to fetch the - XML configuration file name. - - - - - Queries and returns the cached XML configuration file name for the - assembly containing the managed System.Data.SQLite components, if - available. If the cached XML configuration file name value is not - available, the method will - be used to obtain the XML configuration file name. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - Queries and returns the XML configuration file name for the assembly - containing the managed System.Data.SQLite components. - - - The XML configuration file name -OR- null if it cannot be determined - or does not exist. - - - - - If necessary, replaces all supported XML configuration file tokens - with their associated values. - - - The name of the XML configuration file being read. - - - A setting value read from the XML configuration file. - - - The value of the will all supported XML - configuration file tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the - specified XML configuration file. - - - The name of the XML configuration file to read. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - Non-zero to expand any environment variable references contained in - the setting value to be returned. This has no effect on the .NET - Compact Framework. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. - - - - - Attempts to determine the target framework attribute value that is - associated with the specified managed assembly, if applicable. - - - The managed assembly to read the target framework attribute value - from. - - - The value of the target framework attribute value for the specified - managed assembly -OR- null if it cannot be determined. If this - assembly was compiled with a version of the .NET Framework prior to - version 4.0, the value returned MAY reflect that version of the .NET - Framework instead of the one associated with the specified managed - assembly. - - - - - Accepts a long target framework attribute value and makes it into a - much shorter version, suitable for use with NuGet packages. - - - The long target framework attribute value to convert. - - - The short target framework attribute value -OR- null if it cannot - be determined or converted. - - - - - If necessary, replaces all supported environment variable tokens - with their associated values. - - - A setting value read from an environment variable. - - - The value of the will all supported - environment variable tokens replaced. No return value is reserved - to indicate an error. This method cannot fail. - - - - - Queries and returns the value of the specified setting, using the XML - configuration file and/or the environment variables for the current - process and/or the current system, when available. - - - The name of the setting. - - - The value to be returned if the setting has not been set explicitly - or cannot be determined. - - - The value of the setting -OR- the default value specified by - if it has not been set explicitly or - cannot be determined. By default, all references to existing - environment variables will be expanded to their corresponding values - within the value to be returned unless either the "No_Expand" or - "No_Expand_" environment variable is set [to - anything]. - - - - - Resets the cached assembly directory value, thus forcing the next - call to method to rely - upon the method to fetch the - assembly directory. - - - - - Queries and returns the cached directory for the assembly currently - being executed, if available. If the cached assembly directory value - is not available, the method will - be used to obtain the assembly directory. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - Queries and returns the directory for the assembly currently being - executed. - - - The directory for the assembly currently being executed -OR- null if - it cannot be determined. - - - - - The name of the environment variable containing the processor - architecture of the current process. - - - - - The native module file name for the native SQLite library or null. - - - - - The native module handle for the native SQLite library or the value - IntPtr.Zero. - - - - - Determines the base file name (without any directory information) - for the native SQLite library to be pre-loaded by this class. - - - The base file name for the native SQLite library to be pre-loaded by - this class -OR- null if its value cannot be determined. - - - - - Searches for the native SQLite library in the directory containing - the assembly currently being executed as well as the base directory - for the current application domain. - - - Upon success, this parameter will be modified to refer to the base - directory containing the native SQLite library. - - - Upon success, this parameter will be modified to refer to the name - of the immediate directory (i.e. the offset from the base directory) - containing the native SQLite library. - - - Upon success, this parameter will be modified to non-zero only if - the base directory itself should be allowed for loading the native - library. - - - Non-zero (success) if the native SQLite library was found; otherwise, - zero (failure). - - - - - Queries and returns the base directory of the current application - domain. - - - The base directory for the current application domain -OR- null if it - cannot be determined. - - - - - Determines if the dynamic link library file name requires a suffix - and adds it if necessary. - - - The original dynamic link library file name to inspect. - - - The dynamic link library file name, possibly modified to include an - extension. - - - - - Queries and returns the processor architecture of the current - process. - - - The processor architecture of the current process -OR- null if it - cannot be determined. - - - - - Given the processor architecture, returns the name of the platform. - - - The processor architecture to be translated to a platform name. - - - The platform name for the specified processor architecture -OR- null - if it cannot be determined. - - - - - Attempts to load the native SQLite library based on the specified - directory and processor architecture. - - - The base directory to use, null for default (the base directory of - the current application domain). This directory should contain the - processor architecture specific sub-directories. - - - The requested processor architecture, null for default (the - processor architecture of the current process). This caller should - almost always specify null for this parameter. - - - Non-zero indicates that the native SQLite library can be loaded - from the base directory itself. - - - The candidate native module file name to load will be stored here, - if necessary. - - - The native module handle as returned by LoadLibrary will be stored - here, if necessary. This value will be IntPtr.Zero if the call to - LoadLibrary fails. - - - Non-zero if the native module was loaded successfully; otherwise, - zero. - - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to <?xml version="1.0" standalone="yes"?> - <DocumentElement> - <DataTypes> - <TypeName>smallint</TypeName> - <ProviderDbType>10</ProviderDbType> - <ColumnSize>5</ColumnSize> - <DataType>System.Int16</DataType> - <CreateFormat>smallint</CreateFormat> - <IsAutoIncrementable>false</IsAutoIncrementable> - <IsCaseSensitive>false</IsCaseSensitive> - <IsFixedLength>true</IsFixedLength> - <IsFixedPrecisionScale>true</IsFixedPrecisionScale> - <IsLong>false</IsLong> - <IsNullable>true</ [rest of string was truncated]";. - - - - - Looks up a localized string similar to ALL,ALTER,AND,AS,AUTOINCREMENT,BETWEEN,BY,CASE,CHECK,COLLATE,COMMIT,CONSTRAINT,CREATE,CROSS,DEFAULT,DEFERRABLE,DELETE,DISTINCT,DROP,ELSE,ESCAPE,EXCEPT,FOREIGN,FROM,FULL,GROUP,HAVING,IN,INDEX,INNER,INSERT,INTERSECT,INTO,IS,ISNULL,JOIN,LEFT,LIMIT,NATURAL,NOT,NOTNULL,NULL,ON,OR,ORDER,OUTER,PRIMARY,REFERENCES,RIGHT,ROLLBACK,SELECT,SET,TABLE,THEN,TO,TRANSACTION,UNION,UNIQUE,UPDATE,USING,VALUES,WHEN,WHERE. - - - - - Looks up a localized string similar to <?xml version="1.0" encoding="utf-8" ?> - <DocumentElement> - <MetaDataCollections> - <CollectionName>MetaDataCollections</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataCollections> - <CollectionName>DataSourceInformation</CollectionName> - <NumberOfRestrictions>0</NumberOfRestrictions> - <NumberOfIdentifierParts>0</NumberOfIdentifierParts> - </MetaDataCollections> - <MetaDataC [rest of string was truncated]";. - - - - - This interface represents a virtual table implementation written in - native code. - - - - - - int (*xCreate)(sqlite3 *db, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xCreate method is called to create a new instance of a virtual table - in response to a CREATE VIRTUAL TABLE statement. - If the xCreate method is the same pointer as the xConnect method, then the - virtual table is an eponymous virtual table. - If the xCreate method is omitted (if it is a NULL pointer) then the virtual - table is an eponymous-only virtual table. - - - The db parameter is a pointer to the SQLite database connection that - is executing the CREATE VIRTUAL TABLE statement. - The pAux argument is the copy of the client data pointer that was the - fourth argument to the sqlite3_create_module() or - sqlite3_create_module_v2() call that registered the - virtual table module. - The argv parameter is an array of argc pointers to null terminated strings. - The first string, argv[0], is the name of the module being invoked. The - module name is the name provided as the second argument to - sqlite3_create_module() and as the argument to the USING clause of the - CREATE VIRTUAL TABLE statement that is running. - The second, argv[1], is the name of the database in which the new virtual table is being created. The database name is "main" for the primary database, or - "temp" for TEMP database, or the name given at the end of the ATTACH - statement for attached databases. The third element of the array, argv[2], - is the name of the new virtual table, as specified following the TABLE - keyword in the CREATE VIRTUAL TABLE statement. - If present, the fourth and subsequent strings in the argv[] array report - the arguments to the module name in the CREATE VIRTUAL TABLE statement. - - - The job of this method is to construct the new virtual table object - (an sqlite3_vtab object) and return a pointer to it in *ppVTab. - - - As part of the task of creating a new sqlite3_vtab structure, this - method must invoke sqlite3_declare_vtab() to tell the SQLite - core about the columns and datatypes in the virtual table. - The sqlite3_declare_vtab() API has the following prototype: - - - int sqlite3_declare_vtab(sqlite3 *db, const char *zCreateTable) - - - The first argument to sqlite3_declare_vtab() must be the same - database connection pointer as the first parameter to this method. - The second argument to sqlite3_declare_vtab() must a zero-terminated - UTF-8 string that contains a well-formed CREATE TABLE statement that - defines the columns in the virtual table and their data types. - The name of the table in this CREATE TABLE statement is ignored, - as are all constraints. Only the column names and datatypes matter. - The CREATE TABLE statement string need not to be - held in persistent memory. The string can be - deallocated and/or reused as soon as the sqlite3_declare_vtab() - routine returns. - - - The xCreate method need not initialize the pModule, nRef, and zErrMsg - fields of the sqlite3_vtab object. The SQLite core will take care of - that chore. - - - The xCreate should return SQLITE_OK if it is successful in - creating the new virtual table, or SQLITE_ERROR if it is not successful. - If not successful, the sqlite3_vtab structure must not be allocated. - An error message may optionally be returned in *pzErr if unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - If the xCreate method is omitted (left as a NULL pointer) then the - virtual table is an eponymous-only virtual table. New instances of - the virtual table cannot be created using CREATE VIRTUAL TABLE and the - virtual table can only be used via its module name. - Note that SQLite versions prior to 3.9.0 (2015-10-14) do not understand - eponymous-only virtual tables and will segfault if an attempt is made - to CREATE VIRTUAL TABLE on an eponymous-only virtual table because - the xCreate method was not checked for null. - - - If the xCreate method is the exact same pointer as the xConnect method, - that indicates that the virtual table does not need to initialize backing - store. Such a virtual table can be used as an eponymous virtual table - or as a named virtual table using CREATE VIRTUAL TABLE or both. - - - If a column datatype contains the special keyword "HIDDEN" - (in any combination of upper and lower case letters) then that keyword - it is omitted from the column datatype name and the column is marked - as a hidden column internally. - A hidden column differs from a normal column in three respects: - - - ]]> - ]]> Hidden columns are not listed in the dataset returned by - "PRAGMA table_info", - ]]>]]> Hidden columns are not included in the expansion of a "*" - expression in the result set of a SELECT, and - ]]>]]> Hidden columns are not included in the implicit column-list - used by an INSERT statement that lacks an explicit column-list. - ]]>]]> - - - For example, if the following SQL is passed to sqlite3_declare_vtab(): - - - CREATE TABLE x(a HIDDEN VARCHAR(12), b INTEGER, c INTEGER Hidden); - - - Then the virtual table would be created with two hidden columns, - and with datatypes of "VARCHAR(12)" and "INTEGER". - - - An example use of hidden columns can be seen in the FTS3 virtual - table implementation, where every FTS virtual table - contains an FTS hidden column that is used to pass information from the - virtual table into FTS auxiliary functions and to the FTS MATCH operator. - - - A virtual table that contains hidden columns can be used like - a table-valued function in the FROM clause of a SELECT statement. - The arguments to the table-valued function become constraints on - the HIDDEN columns of the virtual table. - - - For example, the "generate_series" extension (located in the - ext/misc/series.c - file in the source tree) - implements an eponymous virtual table with the following schema: - - - CREATE TABLE generate_series( - value, - start HIDDEN, - stop HIDDEN, - step HIDDEN - ); - - - The sqlite3_module.xBestIndex method in the implementation of this - table checks for equality constraints against the HIDDEN columns, and uses - those as input parameters to determine the range of integer "value" outputs - to generate. Reasonable defaults are used for any unconstrained columns. - For example, to list all integers between 5 and 50: - - - SELECT value FROM generate_series(5,50); - - - The previous query is equivalent to the following: - - - SELECT value FROM generate_series WHERE start=5 AND stop=50; - - - Arguments on the virtual table name are matched to hidden columns - in order. The number of arguments can be less than the - number of hidden columns, in which case the latter hidden columns are - unconstrained. However, an error results if there are more arguments - than there are hidden columns in the virtual table. - - - Beginning with SQLite version 3.14.0 (2016-08-08), - the CREATE TABLE statement that - is passed into sqlite3_declare_vtab() may contain a WITHOUT ROWID clause. - This is useful for cases where the virtual table rows - cannot easily be mapped into unique integers. A CREATE TABLE - statement that includes WITHOUT ROWID must define one or more columns as - the PRIMARY KEY. Every column of the PRIMARY KEY must individually be - NOT NULL and all columns for each row must be collectively unique. - - - Note that SQLite does not enforce the PRIMARY KEY for a WITHOUT ROWID - virtual table. Enforcement is the responsibility of the underlying - virtual table implementation. But SQLite does assume that the PRIMARY KEY - constraint is valid - that the identified columns really are UNIQUE and - NOT NULL - and it uses that assumption to optimize queries against the - virtual table. - - - The rowid column is not accessible on a - WITHOUT ROWID virtual table (of course). - - - The xUpdate method was originally designed around having a - ROWID as a single value. The xUpdate method has been expanded to - accommodate an arbitrary PRIMARY KEY in place of the ROWID, but the - PRIMARY KEY must still be only one column. For this reason, SQLite - will reject any WITHOUT ROWID virtual table that has more than one - PRIMARY KEY column and a non-NULL xUpdate method. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - int (*xConnect)(sqlite3*, void *pAux, - int argc, char *const*argv, - sqlite3_vtab **ppVTab, - char **pzErr); - - - The xConnect method is very similar to xCreate. - It has the same parameters and constructs a new sqlite3_vtab structure - just like xCreate. - And it must also call sqlite3_declare_vtab() like xCreate. - - - The difference is that xConnect is called to establish a new - connection to an existing virtual table whereas xCreate is called - to create a new virtual table from scratch. - - - The xCreate and xConnect methods are only different when the - virtual table has some kind of backing store that must be initialized - the first time the virtual table is created. The xCreate method creates - and initializes the backing store. The xConnect method just connects - to an existing backing store. When xCreate and xConnect are the same, - the table is an eponymous virtual table. - - - As an example, consider a virtual table implementation that - provides read-only access to existing comma-separated-value (CSV) - files on disk. There is no backing store that needs to be created - or initialized for such a virtual table (since the CSV files already - exist on disk) so the xCreate and xConnect methods will be identical - for that module. - - - Another example is a virtual table that implements a full-text index. - The xCreate method must create and initialize data structures to hold - the dictionary and posting lists for that index. The xConnect method, - on the other hand, only has to locate and use an existing dictionary - and posting lists that were created by a prior xCreate call. - - - The xConnect method must return SQLITE_OK if it is successful - in creating the new virtual table, or SQLITE_ERROR if it is not - successful. If not successful, the sqlite3_vtab structure must not be - allocated. An error message may optionally be returned in *pzErr if - unsuccessful. - Space to hold the error message string must be allocated using - an SQLite memory allocation function like - sqlite3_malloc() or sqlite3_mprintf() as the SQLite core will - attempt to free the space using sqlite3_free() after the error has - been reported up to the application. - - - The xConnect method is required for every virtual table implementation, - though the xCreate and xConnect pointers of the sqlite3_module object - may point to the same function if the virtual table does not need to - initialize backing store. - - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - - SQLite uses the xBestIndex method of a virtual table module to determine - the best way to access the virtual table. - The xBestIndex method has a prototype like this: - - - int (*xBestIndex)(sqlite3_vtab *pVTab, sqlite3_index_info*); - - - The SQLite core communicates with the xBestIndex method by filling - in certain fields of the sqlite3_index_info structure and passing a - pointer to that structure into xBestIndex as the second parameter. - The xBestIndex method fills out other fields of this structure which - forms the reply. The sqlite3_index_info structure looks like this: - - - struct sqlite3_index_info { - /* Inputs */ - const int nConstraint; /* Number of entries in aConstraint */ - const struct sqlite3_index_constraint { - int iColumn; /* Column constrained. -1 for ROWID */ - unsigned char op; /* Constraint operator */ - unsigned char usable; /* True if this constraint is usable */ - int iTermOffset; /* Used internally - xBestIndex should ignore */ - } *const aConstraint; /* Table of WHERE clause constraints */ - const int nOrderBy; /* Number of terms in the ORDER BY clause */ - const struct sqlite3_index_orderby { - int iColumn; /* Column number */ - unsigned char desc; /* True for DESC. False for ASC. */ - } *const aOrderBy; /* The ORDER BY clause */ - /* Outputs */ - struct sqlite3_index_constraint_usage { - int argvIndex; /* if >0, constraint is part of argv to xFilter */ - unsigned char omit; /* Do not code a test for this constraint */ - } *const aConstraintUsage; - int idxNum; /* Number used to identify the index */ - char *idxStr; /* String, possibly obtained from sqlite3_malloc */ - int needToFreeIdxStr; /* Free idxStr using sqlite3_free() if true */ - int orderByConsumed; /* True if output is already ordered */ - double estimatedCost; /* Estimated cost of using this index */ - ]]>/* Fields below are only available in SQLite 3.8.2 and later */]]> - sqlite3_int64 estimatedRows; /* Estimated number of rows returned */ - ]]>/* Fields below are only available in SQLite 3.9.0 and later */]]> - int idxFlags; /* Mask of SQLITE_INDEX_SCAN_* flags */ - ]]>/* Fields below are only available in SQLite 3.10.0 and later */]]> - sqlite3_uint64 colUsed; /* Input: Mask of columns used by statement */ - }; - - - Note the warnings on the "estimatedRows", "idxFlags", and colUsed fields. - These fields were added with SQLite versions 3.8.2, 3.9.0, and 3.10.0, respectively. - Any extension that reads or writes these fields must first check that the - version of the SQLite library in use is greater than or equal to appropriate - version - perhaps comparing the value returned from sqlite3_libversion_number() - against constants 3008002, 3009000, and/or 3010000. The result of attempting - to access these fields in an sqlite3_index_info structure created by an - older version of SQLite are undefined. - - - In addition, there are some defined constants: - - - #define SQLITE_INDEX_CONSTRAINT_EQ 2 - #define SQLITE_INDEX_CONSTRAINT_GT 4 - #define SQLITE_INDEX_CONSTRAINT_LE 8 - #define SQLITE_INDEX_CONSTRAINT_LT 16 - #define SQLITE_INDEX_CONSTRAINT_GE 32 - #define SQLITE_INDEX_CONSTRAINT_MATCH 64 - #define SQLITE_INDEX_CONSTRAINT_LIKE 65 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_GLOB 66 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_REGEXP 67 /* 3.10.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_NE 68 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOT 69 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNOTNULL 70 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_ISNULL 71 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_IS 72 /* 3.21.0 and later */ - #define SQLITE_INDEX_CONSTRAINT_FUNCTION 150 /* 3.25.0 and later */ - #define SQLITE_INDEX_SCAN_UNIQUE 1 /* Scan visits at most 1 row */ - - - The SQLite core calls the xBestIndex method when it is compiling a query - that involves a virtual table. In other words, SQLite calls this method - when it is running sqlite3_prepare() or the equivalent. - By calling this method, the - SQLite core is saying to the virtual table that it needs to access - some subset of the rows in the virtual table and it wants to know the - most efficient way to do that access. The xBestIndex method replies - with information that the SQLite core can then use to conduct an - efficient search of the virtual table. - - - While compiling a single SQL query, the SQLite core might call - xBestIndex multiple times with different settings in sqlite3_index_info. - The SQLite core will then select the combination that appears to - give the best performance. - - - Before calling this method, the SQLite core initializes an instance - of the sqlite3_index_info structure with information about the - query that it is currently trying to process. This information - derives mainly from the WHERE clause and ORDER BY or GROUP BY clauses - of the query, but also from any ON or USING clauses if the query is a - join. The information that the SQLite core provides to the xBestIndex - method is held in the part of the structure that is marked as "Inputs". - The "Outputs" section is initialized to zero. - - - The information in the sqlite3_index_info structure is ephemeral - and may be overwritten or deallocated as soon as the xBestIndex method - returns. If the xBestIndex method needs to remember any part of the - sqlite3_index_info structure, it should make a copy. Care must be - take to store the copy in a place where it will be deallocated, such - as in the idxStr field with needToFreeIdxStr set to 1. - - - Note that xBestIndex will always be called before xFilter, since - the idxNum and idxStr outputs from xBestIndex are required inputs to - xFilter. However, there is no guarantee that xFilter will be called - following a successful xBestIndex. - - - The xBestIndex method is required for every virtual table implementation. - - - The main thing that the SQLite core is trying to communicate to - the virtual table is the constraints that are available to limit - the number of rows that need to be searched. The aConstraint[] array - contains one entry for each constraint. There will be exactly - nConstraint entries in that array. - - - Each constraint will usually correspond to a term in the WHERE clause - or in a USING or ON clause that is of the form - - - column OP EXPR - - - Where "column" is a column in the virtual table, OP is an operator - like "=" or "<", and EXPR is an arbitrary expression. So, for example, - if the WHERE clause contained a term like this: - - - a = 5 - - - Then one of the constraints would be on the "a" column with - operator "=" and an expression of "5". Constraints need not have a - literal representation of the WHERE clause. The query optimizer might - make transformations to the - WHERE clause in order to extract as many constraints - as it can. So, for example, if the WHERE clause contained something - like this: - - - x BETWEEN 10 AND 100 AND 999>y - - - The query optimizer might translate this into three separate constraints: - - - x >= 10 - x <= 100 - y < 999 - - - For each such constraint, the aConstraint[].iColumn field indicates which - column appears on the left-hand side of the constraint. - The first column of the virtual table is column 0. - The rowid of the virtual table is column -1. - The aConstraint[].op field indicates which operator is used. - The SQLITE_INDEX_CONSTRAINT_* constants map integer constants - into operator values. - Columns occur in the order they were defined by the call to - sqlite3_declare_vtab() in the xCreate or xConnect method. - Hidden columns are counted when determining the column index. - - - If the xFindFunction() method for the virtual table is defined, and - if xFindFunction() sometimes returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, then the constraints might also be of the form: - - - FUNCTION( column, EXPR) - - - In this case the aConstraint[].op value is the same as the value - returned by xFindFunction() for FUNCTION. - - - The aConstraint[] array contains information about all constraints - that apply to the virtual table. But some of the constraints might - not be usable because of the way tables are ordered in a join. - The xBestIndex method must therefore only consider constraints - that have an aConstraint[].usable flag which is true. - - - In addition to WHERE clause constraints, the SQLite core also - tells the xBestIndex method about the ORDER BY clause. - (In an aggregate query, the SQLite core might put in GROUP BY clause - information in place of the ORDER BY clause information, but this fact - should not make any difference to the xBestIndex method.) - If all terms of the ORDER BY clause are columns in the virtual table, - then nOrderBy will be the number of terms in the ORDER BY clause - and the aOrderBy[] array will identify the column for each term - in the order by clause and whether or not that column is ASC or DESC. - - - In SQLite version 3.10.0 (2016-01-06) and later, - the colUsed field is available - to indicate which fields of the virtual table are actually used by the - statement being prepared. If the lowest bit of colUsed is set, that - means that the first column is used. The second lowest bit corresponds - to the second column. And so forth. If the most significant bit of - colUsed is set, that means that one or more columns other than the - first 63 columns are used. If column usage information is needed by the - xFilter method, then the required bits must be encoded into either - the idxNum or idxStr output fields. - - - Given all of the information above, the job of the xBestIndex - method it to figure out the best way to search the virtual table. - - - The xBestIndex method fills the idxNum and idxStr fields with - information that communicates an indexing strategy to the xFilter - method. The information in idxNum and idxStr is arbitrary as far - as the SQLite core is concerned. The SQLite core just copies the - information through to the xFilter method. Any desired meaning can - be assigned to idxNum and idxStr as long as xBestIndex and xFilter - agree on what that meaning is. - - - The idxStr value may be a string obtained from an SQLite - memory allocation function such as sqlite3_mprintf(). - If this is the case, then the needToFreeIdxStr flag must be set to - true so that the SQLite core will know to call sqlite3_free() on - that string when it has finished with it, and thus avoid a memory leak. - The idxStr value may also be a static constant string, in which case - the needToFreeIdxStr boolean should remain false. - - - If the virtual table will output rows in the order specified by - the ORDER BY clause, then the orderByConsumed flag may be set to - true. If the output is not automatically in the correct order - then orderByConsumed must be left in its default false setting. - This will indicate to the SQLite core that it will need to do a - separate sorting pass over the data after it comes out of the virtual table. - - - The estimatedCost field should be set to the estimated number - of disk access operations required to execute this query against - the virtual table. The SQLite core will often call xBestIndex - multiple times with different constraints, obtain multiple cost - estimates, then choose the query plan that gives the lowest estimate. - The SQLite core initializes estimatedCost to a very large value - prior to invoking xBestIndex, so if xBestIndex determines that the - current combination of parameters is undesirable, it can leave the - estimatedCost field unchanged to discourage its use. - - - If the current version of SQLite is 3.8.2 or greater, the estimatedRows - field may be set to an estimate of the number of rows returned by the - proposed query plan. If this value is not explicitly set, the default - estimate of 25 rows is used. - - - If the current version of SQLite is 3.9.0 or greater, the idxFlags field - may be set to SQLITE_INDEX_SCAN_UNIQUE to indicate that the virtual table - will return only zero or one rows given the input constraints. Additional - bits of the idxFlags field might be understood in later versions of SQLite. - - - The aConstraintUsage[] array contains one element for each of - the nConstraint constraints in the inputs section of the - sqlite3_index_info structure. - The aConstraintUsage[] array is used by xBestIndex to tell the - core how it is using the constraints. - - - The xBestIndex method may set aConstraintUsage[].argvIndex - entries to values greater than zero. - Exactly one entry should be set to 1, another to 2, another to 3, - and so forth up to as many or as few as the xBestIndex method wants. - The EXPR of the corresponding constraints will then be passed - in as the argv[] parameters to xFilter. - - - For example, if the aConstraint[3].argvIndex is set to 1, then - when xFilter is called, the argv[0] passed to xFilter will have - the EXPR value of the aConstraint[3] constraint. - - - By default, the SQLite core double checks all constraints on - each row of the virtual table that it receives. If such a check - is redundant, the xBestFilter method can suppress that double-check by - setting aConstraintUsage[].omit. - - - The xBestIndex method should return SQLITE_OK on success. If any - kind of fatal error occurs, an appropriate error code (ex: SQLITE_NOMEM) - should be returned instead. - - - If xBestIndex returns SQLITE_CONSTRAINT, that does not indicate an - error. Rather, SQLITE_CONSTRAINT indicates that the particular combination - of input parameters specified should not be used in the query plan. - The SQLITE_CONSTRAINT return is useful for table-valued functions that - have required parameters. If the aConstraint[].usable field is false - for one of the required parameter, then the xBestIndex method should - return SQLITE_CONSTRAINT. - - - The following example will better illustrate the use of SQLITE_CONSTRAINT - as a return value from xBestIndex: - - - SELECT * FROM realtab, tablevaluedfunc(realtab.x); - - - Assuming that the first hidden column of "tablevaluedfunc" is "param1", - the query above is semantically equivalent to this: - - - SELECT * FROM realtab, tablevaluedfunc - WHERE tablevaluedfunc.param1 = realtab.x; - - - The query planner must decide between many possible implementations - of this query, but two plans in particular are of note: - - ]]> - ]]>Scan all - rows of realtab and for each row, find rows in tablevaluedfunc where - param1 is equal to realtab.x - ]]>]]>Scan all rows of tablevalued func and for each row find rows - in realtab where x is equal to tablevaluedfunc.param1. - ]]>]]> - - The xBestIndex method will be invoked once for each of the potential - plans above. For plan 1, the aConstraint[].usable flag for for the - SQLITE_CONSTRAINT_EQ constraint on the param1 column will be true because - the right-hand side value for the "param1 = ?" constraint will be known, - since it is determined by the outer realtab loop. - But for plan 2, the aConstraint[].usable flag for "param1 = ?" will be false - because the right-hand side value is determined by an inner loop and is thus - an unknown quantity. Because param1 is a required input to the table-valued - functions, the xBestIndex method should return SQLITE_CONSTRAINT when presented - with plan 2, indicating that a required input is missing. This forces the - query planner to select plan 1. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_index_info structure. - - - A standard SQLite return code. - - - - - - int (*xDisconnect)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table. - Only the sqlite3_vtab object is destroyed. - The virtual table is not destroyed and any backing store - associated with the virtual table persists. - - This method undoes the work of xConnect. - - This method is a destructor for a connection to the virtual table. - Contrast this method with xDestroy. The xDestroy is a destructor - for the entire virtual table. - - - The xDisconnect method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xDestroy)(sqlite3_vtab *pVTab); - - - This method releases a connection to a virtual table, just like - the xDisconnect method, and it also destroys the underlying - table implementation. This method undoes the work of xCreate. - - - The xDisconnect method is called whenever a database connection - that uses a virtual table is closed. The xDestroy method is only - called when a DROP TABLE statement is executed against the virtual table. - - - The xDestroy method is required for every virtual table implementation, - though it is acceptable for the xDisconnect and xDestroy methods to be - the same function if that makes sense for the particular virtual table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xOpen)(sqlite3_vtab *pVTab, sqlite3_vtab_cursor **ppCursor); - - - The xOpen method creates a new cursor used for accessing (read and/or - writing) a virtual table. A successful invocation of this method - will allocate the memory for the sqlite3_vtab_cursor (or a subclass), - initialize the new object, and make *ppCursor point to the new object. - The successful call then returns SQLITE_OK. - - - For every successful call to this method, the SQLite core will - later invoke the xClose method to destroy - the allocated cursor. - - - The xOpen method need not initialize the pVtab field of the - sqlite3_vtab_cursor structure. The SQLite core will take care - of that chore automatically. - - - A virtual table implementation must be able to support an arbitrary - number of simultaneously open cursors. - - - When initially opened, the cursor is in an undefined state. - The SQLite core will invoke the xFilter method - on the cursor prior to any attempt to position or read from the cursor. - - - The xOpen method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab derived structure. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xClose)(sqlite3_vtab_cursor*); - - - The xClose method closes a cursor previously opened by - xOpen. - The SQLite core will always call xClose once for each cursor opened - using xOpen. - - - This method must release all resources allocated by the - corresponding xOpen call. The routine will not be called again even if it - returns an error. The SQLite core will not use the - sqlite3_vtab_cursor again after it has been closed. - - - The xClose method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xFilter)(sqlite3_vtab_cursor*, int idxNum, const char *idxStr, - int argc, sqlite3_value **argv); - - - This method begins a search of a virtual table. - The first argument is a cursor opened by xOpen. - The next two arguments define a particular search index previously - chosen by xBestIndex. The specific meanings of idxNum and idxStr - are unimportant as long as xFilter and xBestIndex agree on what - that meaning is. - - - The xBestIndex function may have requested the values of - certain expressions using the aConstraintUsage[].argvIndex values - of the sqlite3_index_info structure. - Those values are passed to xFilter using the argc and argv parameters. - - - If the virtual table contains one or more rows that match the - search criteria, then the cursor must be left point at the first row. - Subsequent calls to xEof must return false (zero). - If there are no rows match, then the cursor must be left in a state - that will cause the xEof to return true (non-zero). - The SQLite engine will use - the xColumn and xRowid methods to access that row content. - The xNext method will be used to advance to the next row. - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xFilter method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Number used to help identify the selected index. - - - The native pointer to the UTF-8 encoded string containing the - string used to help identify the selected index. - - - The number of native pointers to sqlite3_value structures specified - in . - - - An array of native pointers to sqlite3_value structures containing - filtering criteria for the selected index. - - - A standard SQLite return code. - - - - - - int (*xNext)(sqlite3_vtab_cursor*); - - - The xNext method advances a virtual table cursor - to the next row of a result set initiated by xFilter. - If the cursor is already pointing at the last row when this - routine is called, then the cursor no longer points to valid - data and a subsequent call to the xEof method must return true (non-zero). - If the cursor is successfully advanced to another row of content, then - subsequent calls to xEof must return false (zero). - - - This method must return SQLITE_OK if successful, or an sqlite - error code if an error occurs. - - - The xNext method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - A standard SQLite return code. - - - - - - int (*xEof)(sqlite3_vtab_cursor*); - - - The xEof method must return false (zero) if the specified cursor - currently points to a valid row of data, or true (non-zero) otherwise. - This method is called by the SQL engine immediately after each - xFilter and xNext invocation. - - - The xEof method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Non-zero if no more rows are available; zero otherwise. - - - - - - int (*xColumn)(sqlite3_vtab_cursor*, sqlite3_context*, int N); - - - The SQLite core invokes this method in order to find the value for - the N-th column of the current row. N is zero-based so the first column - is numbered 0. - The xColumn method may return its result back to SQLite using one of the - following interface: - - - ]]> - ]]> sqlite3_result_blob() - ]]>]]> sqlite3_result_double() - ]]>]]> sqlite3_result_int() - ]]>]]> sqlite3_result_int64() - ]]>]]> sqlite3_result_null() - ]]>]]> sqlite3_result_text() - ]]>]]> sqlite3_result_text16() - ]]>]]> sqlite3_result_text16le() - ]]>]]> sqlite3_result_text16be() - ]]>]]> sqlite3_result_zeroblob() - ]]>]]> - - - If the xColumn method implementation calls none of the functions above, - then the value of the column defaults to an SQL NULL. - - - To raise an error, the xColumn method should use one of the result_text() - methods to set the error message text, then return an appropriate - error code. The xColumn method must return SQLITE_OK on success. - - - The xColumn method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_context structure to be used - for returning the specified column value to the SQLite core - library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - - int (*xRowid)(sqlite3_vtab_cursor *pCur, sqlite_int64 *pRowid); - - - A successful invocation of this method will cause *pRowid to be - filled with the rowid of row that the - virtual table cursor pCur is currently pointing at. - This method returns SQLITE_OK on success. - It returns an appropriate error code on failure. - - - The xRowid method is required for every virtual table implementation. - - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - - int (*xUpdate)( - sqlite3_vtab *pVTab, - int argc, - sqlite3_value **argv, - sqlite_int64 *pRowid - ); - - - All changes to a virtual table are made using the xUpdate method. - This one method can be used to insert, delete, or update. - - - The argc parameter specifies the number of entries in the argv array. - The value of argc will be 1 for a pure delete operation or N+2 for an insert - or replace or update where N is the number of columns in the table. - In the previous sentence, N includes any hidden columns. - - - Every argv entry will have a non-NULL value in C but may contain the - SQL value NULL. In other words, it is always true that - ]]>argv[i]!=0]]> for ]]>i]]> between 0 and ]]>argc-1]]>. - However, it might be the case that - ]]>sqlite3_value_type(argv[i])==SQLITE_NULL]]>. - - - The argv[0] parameter is the rowid of a row in the virtual table - to be deleted. If argv[0] is an SQL NULL, then no deletion occurs. - - - The argv[1] parameter is the rowid of a new row to be inserted - into the virtual table. If argv[1] is an SQL NULL, then the implementation - must choose a rowid for the newly inserted row. Subsequent argv[] - entries contain values of the columns of the virtual table, in the - order that the columns were declared. The number of columns will - match the table declaration that the xConnect or xCreate method made - using the sqlite3_declare_vtab() call. All hidden columns are included. - - - When doing an insert without a rowid (argc>1, argv[1] is an SQL NULL), - on a virtual table that uses ROWID (but not on a WITHOUT ROWID virtual table), - the implementation must set *pRowid to the rowid of the newly inserted row; - this will become the value returned by the sqlite3_last_insert_rowid() - function. Setting this value in all the other cases is a harmless no-op; - the SQLite engine ignores the *pRowid return value if argc==1 or - argv[1] is not an SQL NULL. - - - Each call to xUpdate will fall into one of cases shown below. - Not that references to ]]>argv[i]]]> mean the SQL value - held within the argv[i] object, not the argv[i] - object itself. - - - ]]> - ]]>]]>argc = 1 ]]> argv[0] ≠ NULL]]> - ]]>]]> - DELETE: The single row with rowid or PRIMARY KEY equal to argv[0] is deleted. - No insert occurs. - ]]>]]>]]>argc > 1 ]]> argv[0] = NULL]]> - ]]>]]> - INSERT: A new row is inserted with column values taken from - argv[2] and following. In a rowid virtual table, if argv[1] is an SQL NULL, - then a new unique rowid is generated automatically. The argv[1] will be NULL - for a WITHOUT ROWID virtual table, in which case the implementation should - take the PRIMARY KEY value from the appropriate column in argv[2] and following. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] = argv[1]]]> - ]]>]]> - UPDATE: - The row with rowid or PRIMARY KEY argv[0] is updated with new values - in argv[2] and following parameters. - ]]>]]>]]>argc > 1 ]]> argv[0] ≠ NULL ]]> argv[0] ≠ argv[1]]]> - ]]>]]> - UPDATE with rowid or PRIMARY KEY change: - The row with rowid or PRIMARY KEY argv[0] is updated with - the rowid or PRIMARY KEY in argv[1] - and new values in argv[2] and following parameters. This will occur - when an SQL statement updates a rowid, as in the statement: - - UPDATE table SET rowid=rowid+1 WHERE ...; - - ]]>]]> - - - The xUpdate method must return SQLITE_OK if and only if it is - successful. If a failure occurs, the xUpdate must return an appropriate - error code. On a failure, the pVTab->zErrMsg element may optionally - be replaced with error message text stored in memory allocated from SQLite - using functions such as sqlite3_mprintf() or sqlite3_malloc(). - - - If the xUpdate method violates some constraint of the virtual table - (including, but not limited to, attempting to store a value of the wrong - datatype, attempting to store a value that is too - large or too small, or attempting to change a read-only value) then the - xUpdate must fail with an appropriate error code. - - - If the xUpdate method is performing an UPDATE, then - sqlite3_value_nochange(X) can be used to discover which columns - of the virtual table were actually modified by the UPDATE - statement. The sqlite3_value_nochange(X) interface returns - true for columns that do not change. - On every UPDATE, SQLite will first invoke - xColumn separately for each unchanging column in the table to - obtain the value for that column. The xColumn method can - check to see if the column is unchanged at the SQL level - by invoking sqlite3_vtab_nochange(). If xColumn sees that - the column is not being modified, it should return without setting - a result using one of the sqlite3_result_xxxxx() - interfaces. Only in that case sqlite3_value_nochange() will be - true within the xUpdate method. If xColumn does - invoke one or more sqlite3_result_xxxxx() - interfaces, then SQLite understands that as a change in the value - of the column and the sqlite3_value_nochange() call for that - column within xUpdate will return false. - - - There might be one or more sqlite3_vtab_cursor objects open and in use - on the virtual table instance and perhaps even on the row of the virtual - table when the xUpdate method is invoked. The implementation of - xUpdate must be prepared for attempts to delete or modify rows of the table - out from other existing cursors. If the virtual table cannot accommodate - such changes, the xUpdate method must return an error code. - - - The xUpdate method is optional. - If the xUpdate pointer in the sqlite3_module for a virtual table - is a NULL pointer, then the virtual table is read-only. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of new or modified column values contained in - . - - - The array of native pointers to sqlite3_value structures containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - - int (*xBegin)(sqlite3_vtab *pVTab); - - - This method begins a transaction on a virtual table. - This is method is optional. The xBegin pointer of sqlite3_module - may be NULL. - - - This method is always followed by one call to either the - xCommit or xRollback method. Virtual table transactions do - not nest, so the xBegin method will not be invoked more than once - on a single virtual table - without an intervening call to either xCommit or xRollback. - Multiple calls to other methods can and likely will occur in between - the xBegin and the corresponding xCommit or xRollback. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xSync)(sqlite3_vtab *pVTab); - - - This method signals the start of a two-phase commit on a virtual - table. - This is method is optional. The xSync pointer of sqlite3_module - may be NULL. - - - This method is only invoked after call to the xBegin method and - prior to an xCommit or xRollback. In order to implement two-phase - commit, the xSync method on all virtual tables is invoked prior to - invoking the xCommit method on any virtual table. If any of the - xSync methods fail, the entire transaction is rolled back. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xCommit)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to commit. - This is method is optional. The xCommit pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin and - xSync. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xRollback)(sqlite3_vtab *pVTab); - - - This method causes a virtual table transaction to rollback. - This is method is optional. The xRollback pointer of sqlite3_module - may be NULL. - - - A call to this method always follows a prior call to xBegin. - - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - - int (*xFindFunction)( - sqlite3_vtab *pVtab, - int nArg, - const char *zName, - void (**pxFunc)(sqlite3_context*,int,sqlite3_value**), - void **ppArg - ); - - - This method is called during sqlite3_prepare() to give the virtual - table implementation an opportunity to overload functions. - This method may be set to NULL in which case no overloading occurs. - - - When a function uses a column from a virtual table as its first - argument, this method is called to see if the virtual table would - like to overload the function. The first three parameters are inputs: - the virtual table, the number of arguments to the function, and the - name of the function. If no overloading is desired, this method - returns 0. To overload the function, this method writes the new - function implementation into *pxFunc and writes user data into *ppArg - and returns either 1 or a number between - SQLITE_INDEX_CONSTRAINT_FUNCTION and 255. - - - Historically, the return value from xFindFunction() was either zero - or one. Zero means that the function is not overloaded and one means that - it is overload. The ability to return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater was added in - version 3.25.0 (2018-09-15). If xFindFunction returns - SQLITE_INDEX_CONSTRAINT_FUNCTION or greater, than means that the function - takes two arguments and the function - can be used as a boolean in the WHERE clause of a query and that - the virtual table is able to exploit that function to speed up the query - result. When xFindFunction returns SQLITE_INDEX_CONSTRAINT_FUNCTION or - larger, the value returned becomes the sqlite3_index_info.aConstraint.op - value for one of the constraints passed into xBestIndex() and the second - argument becomes the value corresponding to that constraint that is passed - to xFilter(). This enables the - xBestIndex()/xFilter implementations to use the function to speed - its search. - - - The technique of having xFindFunction() return values of - SQLITE_INDEX_CONSTRAINT_FUNCTION was initially used in the implementation - of the Geopoly module. The xFindFunction() method of that module returns - SQLITE_INDEX_CONSTRAINT_FUNCTION for the geopoly_overlap() SQL function - and it returns - SQLITE_INDEX_CONSTRAINT_FUNCTION+1 for the geopoly_within() SQL function. - This permits search optimizations for queries such as: - - - SELECT * FROM geopolytab WHERE geopoly_overlap(_shape, $query_polygon); - - - Note that infix functions (LIKE, GLOB, REGEXP, and MATCH) reverse - the order of their arguments. So "like(A,B)" is equivalent to "B like A". - For the form "B like A" the B term is considered the first argument - to the function. But for "like(A,B)" the A term is considered the - first argument. - - - The function pointer returned by this routine must be valid for - the lifetime of the sqlite3_vtab object given in the first parameter. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - delegate responsible for implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - - int (*xRename)(sqlite3_vtab *pVtab, const char *zNew); - - - This method provides notification that the virtual table implementation - that the virtual table will be given a new name. - If this method returns SQLITE_OK then SQLite renames the table. - If this method returns an error code then the renaming is prevented. - - - The xRename method is optional. If omitted, then the virtual - table may not be renamed using the ALTER TABLE RENAME command. - - - The PRAGMA legacy_alter_table setting is enabled prior to invoking this - method, and the value for legacy_alter_table is restored after this - method finishes. This is necessary for the correct operation of virtual - tables that make use of shadow tables where the shadow tables must be - renamed to match the new virtual table name. If the legacy_alter_format is - off, then the xConnect method will be invoked for the virtual table every - time the xRename method tries to change the name of the shadow table. - - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the UTF-8 encoded string containing the new - name for the virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - - int (*xSavepoint)(sqlite3_vtab *pVtab, int); - int (*xRelease)(sqlite3_vtab *pVtab, int); - int (*xRollbackTo)(sqlite3_vtab *pVtab, int); - - - These methods provide the virtual table implementation an opportunity to - implement nested transactions. They are always optional and will only be - called in SQLite version 3.7.7 (2011-06-23) and later. - - - When xSavepoint(X,N) is invoked, that is a signal to the virtual table X - that it should save its current state as savepoint N. - A subsequent call - to xRollbackTo(X,R) means that the state of the virtual table should return - to what it was when xSavepoint(X,R) was last called. - The call - to xRollbackTo(X,R) will invalidate all savepoints with N>R; none of the - invalided savepoints will be rolled back or released without first - being reinitialized by a call to xSavepoint(). - A call to xRelease(X,M) invalidates all savepoints where N>=M. - - - None of the xSavepoint(), xRelease(), or xRollbackTo() methods will ever - be called except in between calls to xBegin() and - either xCommit() or xRollback(). - - - - The native pointer to the sqlite3_vtab derived structure. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - This class represents a context from the SQLite core library that can - be passed to the sqlite3_result_*() and associated functions. - - - - - The native context handle. - - - - - Constructs an instance of this class using the specified native - context handle. - - - The native context handle to use. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Sets the context result to NULL. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to the specified - value. - - - The value to use. This value will be - converted to the UTF-8 encoding prior to being used. - - - - - Sets the context result to the specified - value containing an error message. - - - The value containing the error message text. - This value will be converted to the UTF-8 encoding prior to being - used. - - - - - Sets the context result to the specified - value. - - - The value to use. - - - - - Sets the context result to contain the error code SQLITE_TOOBIG. - - - - - Sets the context result to contain the error code SQLITE_NOMEM. - - - - - Sets the context result to the specified array - value. - - - The array value to use. - - - - - Sets the context result to a BLOB of zeros of the specified size. - - - The number of zero bytes to use for the BLOB context result. - - - - - Sets the context result to the specified . - - - The to use. - - - - - This class represents a value from the SQLite core library that can be - passed to the sqlite3_value_*() and associated functions. - - - - - The native value handle. - - - - - Constructs an instance of this class using the specified native - value handle. - - - The native value handle to use. - - - - - Invalidates the native value handle, thereby preventing further - access to it from this object instance. - - - - - Converts a native pointer to a native sqlite3_value structure into - a managed object instance. - - - The native pointer to a native sqlite3_value structure to convert. - - - The managed object instance or null upon - failure. - - - - - Converts a logical array of native pointers to native sqlite3_value - structures into a managed array of - object instances. - - - The number of elements in the logical array of native sqlite3_value - structures. - - - The native pointer to the logical array of native sqlite3_value - structures to convert. - - - The managed array of object instances or - null upon failure. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Returns non-zero if the native SQLite value has been successfully - persisted as a managed value within this object instance (i.e. the - property may then be read successfully). - - - - - If the managed value for this object instance is available (i.e. it - has been previously persisted via the ) method, - that value is returned; otherwise, an exception is thrown. The - returned value may be null. - - - - - Gets and returns the type affinity associated with this value. - - - The type affinity associated with this value. - - - - - Gets and returns the number of bytes associated with this value, if - it refers to a UTF-8 encoded string. - - - The number of bytes associated with this value. The returned value - may be zero. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with - this value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. - - - - - Gets and returns the associated with this - value. - - - The associated with this value. The value is - converted from the UTF-8 encoding prior to being returned. - - - - - Gets and returns the array associated with this - value. - - - The array associated with this value. - - - - - Gets and returns an instance associated with - this value. - - - The associated with this value. If the type - affinity of the object is unknown or cannot be determined, a null - value will be returned. - - - - - Uses the native value handle to obtain and store the managed value - for this object instance, thus saving it for later use. The type - of the managed value is determined by the type affinity of the - native value. If the type affinity is not recognized by this - method, no work is done and false is returned. - - - Non-zero if the native value was persisted successfully. - - - - - These are the allowed values for the operators that are part of a - constraint term in the WHERE clause of a query that uses a virtual - table. - - - - - This value represents the equality operator. - - - - - This value represents the greater than operator. - - - - - This value represents the less than or equal to operator. - - - - - This value represents the less than operator. - - - - - This value represents the greater than or equal to operator. - - - - - This value represents the MATCH operator. - - - - - This value represents the LIKE operator. - - - - - This value represents the GLOB operator. - - - - - This value represents the REGEXP operator. - - - - - This value represents the inequality operator. - - - - - This value represents the IS NOT operator. - - - - - This value represents the IS NOT NULL operator. - - - - - This value represents the IS NULL operator. - - - - - This value represents the IS operator. - - - - - These are the allowed values for the index flags from the - method. - - - - - No special handling. This is the default. - - - - - This value indicates that the scan of the index will visit at - most one row. - - - - - This class represents the native sqlite3_index_constraint structure - from the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint structure. - - - The native sqlite3_index_constraint structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column on left-hand side of constraint. - - - Constraint operator (). - - - True if this constraint is usable. - - - Used internally - - should ignore. - - - - - Column on left-hand side of constraint. - - - - - Constraint operator (). - - - - - True if this constraint is usable. - - - - - Used internally - - should ignore. - - - - - This class represents the native sqlite3_index_orderby structure from - the SQLite core library. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_orderby structure. - - - The native sqlite3_index_orderby structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - Column number. - - - True for DESC. False for ASC. - - - - - Column number. - - - - - True for DESC. False for ASC. - - - - - This class represents the native sqlite3_index_constraint_usage - structure from the SQLite core library. - - - - - Constructs a default instance of this class. - - - - - Constructs an instance of this class using the specified native - sqlite3_index_constraint_usage structure. - - - The native sqlite3_index_constraint_usage structure to use. - - - - - Constructs an instance of this class using the specified field - values. - - - If greater than 0, constraint is part of argv to xFilter. - - - Do not code a test for this constraint. - - - - - If greater than 0, constraint is part of argv to xFilter. - - - - - Do not code a test for this constraint. - - - - - This class represents the various inputs provided by the SQLite core - library to the method. - - - - - Constructs an instance of this class. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - An array of object instances, - each containing information supplied by the SQLite core library. - - - - - This class represents the various outputs provided to the SQLite core - library by the method. - - - - - Constructs an instance of this class. - - - The number of instances - to pre-allocate space for. - - - - - Determines if the native estimatedRows field can be used, based on - the available version of the SQLite core library. - - - Non-zero if the property is supported - by the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - Determines if the native flags field can be used, based on the - available version of the SQLite core library. - - - Non-zero if the property is supported by - the SQLite core library. - - - - - An array of object - instances, each containing information to be supplied to the SQLite - core library. - - - - - Number used to help identify the selected index. This value will - later be provided to the - method. - - - - - String used to help identify the selected index. This value will - later be provided to the - method. - - - - - Non-zero if the index string must be freed by the SQLite core - library. - - - - - True if output is already ordered. - - - - - Estimated cost of using this index. Using a null value here - indicates that a default estimated cost value should be used. - - - - - Estimated number of rows returned. Using a null value here - indicates that a default estimated rows value should be used. - This property has no effect if the SQLite core library is not at - least version 3.8.2. - - - - - The flags that should be used with this index. Using a null value - here indicates that a default flags value should be used. This - property has no effect if the SQLite core library is not at least - version 3.9.0. - - - - - - Indicates which columns of the virtual table may be required by the - current scan. Virtual table columns are numbered from zero in the - order in which they appear within the CREATE TABLE statement passed - to sqlite3_declare_vtab(). For the first 63 columns (columns 0-62), - the corresponding bit is set within the bit mask if the column may - be required by SQLite. If the table has at least 64 columns and - any column to the right of the first 63 is required, then bit 63 of - colUsed is also set. In other words, column iCol may be required - if the expression - - - (colUsed & ((sqlite3_uint64)1 << (iCol>=63 ? 63 : iCol))) - - - evaluates to non-zero. Using a null value here indicates that a - default flags value should be used. This property has no effect if - the SQLite core library is not at least version 3.10.0. - - - - - - This class represents the various inputs and outputs used with the - method. - - - - - Constructs an instance of this class. - - - The number of (and - ) instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - - - Attempts to determine the structure sizes needed to create and - populate a native - - structure. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - The size of the native - - structure is stored here. - - - - - Attempts to allocate and initialize a native - - structure. - - - The number of instances to - pre-allocate space for. - - - The number of instances to - pre-allocate space for. - - - The newly allocated native - structure - -OR- if it could not be fully allocated. - - - - - Frees all the memory associated with a native - - structure. - - - The native pointer to the native sqlite3_index_info structure to - free. - - - - - Converts a native pointer to a native sqlite3_index_info structure - into a new object instance. - - - The native pointer to the native sqlite3_index_info structure to - convert. - - - Non-zero to include fields from the outputs portion of the native - structure; otherwise, the "output" fields will not be read. - - - Upon success, this parameter will be modified to contain the newly - created object instance. - - - - - Populates the outputs of a pre-allocated native sqlite3_index_info - structure using an existing object - instance. - - - The existing object instance containing - the output data to use. - - - The native pointer to the pre-allocated native sqlite3_index_info - structure. - - - Non-zero to include fields from the inputs portion of the native - structure; otherwise, the "input" fields will not be written. - - - - - The object instance containing - the inputs to the - method. - - - - - The object instance containing - the outputs from the - method. - - - - - This class represents a managed virtual table implementation. It is - not sealed and should be used as the base class for any user-defined - virtual table classes implemented in managed code. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the module implementing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the database containing this virtual table. - - - - - The index within the array of strings provided to the - and - methods containing the - name of the virtual table. - - - - - Constructs an instance of this class. - - - The original array of strings provided to the - and - methods. - - - - - The original array of strings provided to the - and - methods. - - - - - The name of the module implementing this virtual table. - - - - - The name of the database containing this virtual table. - - - - - The name of the virtual table. - - - - - The object instance containing all the - data for the inputs and outputs relating to the most recent index - selection. - - - - - This method should normally be used by the - method in order to - perform index selection based on the constraints provided by the - SQLite core library. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - Non-zero upon success. - - - - - Attempts to record the renaming of the virtual table associated - with this object instance. - - - The new name for the virtual table. - - - Non-zero upon success. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - This class represents a managed virtual table cursor implementation. - It is not sealed and should be used as the base class for any - user-defined virtual table cursor classes implemented in managed code. - - - - - This value represents an invalid integer row sequence number. - - - - - The field holds the integer row sequence number for the current row - pointed to by this cursor object instance. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - - - Constructs an instance of this class. - - - - - The object instance associated - with this object instance. - - - - - Number used to help identify the selected index. This value will - be set via the method. - - - - - String used to help identify the selected index. This value will - be set via the method. - - - - - The values used to filter the rows returned via this cursor object - instance. This value will be set via the - method. - - - - - Attempts to persist the specified object - instances in order to make them available after the - method returns. - - - The array of object instances to be - persisted. - - - The number of object instances that were - successfully persisted. - - - - - This method should normally be used by the - method in order to - perform filtering of the result rows and/or to record the filtering - criteria provided by the SQLite core library. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - - - Determines the integer row sequence number for the current row. - - - The integer row sequence number for the current row -OR- zero if - it cannot be determined. - - - - - Adjusts the integer row sequence number so that it refers to the - next row. - - - - - Returns the underlying SQLite native handle associated with this - object instance. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being called - from the finalizer. - - - - - Finalizes this object instance. - - - - - This interface represents a native handle provided by the SQLite core - library. - - - - - The native handle value. - - - - - This interface represents a virtual table implementation written in - managed code. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - This class contains static methods that are used to allocate, - manipulate, and free native memory provided by the SQLite core library. - - - - - Determines if the native sqlite3_msize() API can be used, based on - the available version of the SQLite core library. - - - Non-zero if the native sqlite3_msize() API is supported by the - SQLite core library. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer. If the TRACK_MEMORY_BYTES option - was enabled at compile-time, adjusts the number of bytes currently - allocated by this class. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Allocates at least the specified number of bytes of native memory - via the SQLite core library sqlite3_malloc64() function and returns - the resulting native pointer without adjusting the number of - allocated bytes currently tracked by this class. This is useful - when dealing with blocks of memory that will be freed directly by - the SQLite core library. - - - The number of bytes to allocate. - - - The native pointer that points to a block of memory of at least the - specified size -OR- if the memory could - not be allocated. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Gets and returns the actual size of the specified memory block - that was previously obtained from the , - , , or - methods or directly from the - SQLite core library. - - - The native pointer to the memory block previously obtained from - the , , - , or - methods or directly from the - SQLite core library. - - - The actual size, in bytes, of the memory block specified via the - native pointer. - - - - - Frees a memory block previously obtained from the - or methods. If - the TRACK_MEMORY_BYTES option was enabled at compile-time, adjusts - the number of bytes currently allocated by this class. - - - The native pointer to the memory block previously obtained from the - or methods. - - - - - Frees a memory block previously obtained from the SQLite core - library without adjusting the number of allocated bytes currently - tracked by this class. This is useful when dealing with blocks of - memory that were not allocated using this class. - - - The native pointer to the memory block previously obtained from the - SQLite core library. - - - - - This class contains static methods that are used to deal with native - UTF-8 string pointers to be used with the SQLite core library. - - - - - This is the maximum possible length for the native UTF-8 encoded - strings used with the SQLite core library. - - - - - This is the object instance used to handle - conversions from/to UTF-8. - - - - - Converts the specified managed string into the UTF-8 encoding and - returns the array of bytes containing its representation in that - encoding. - - - The managed string to convert. - - - The array of bytes containing the representation of the managed - string in the UTF-8 encoding or null upon failure. - - - - - Converts the specified array of bytes representing a string in the - UTF-8 encoding and returns a managed string. - - - The array of bytes to convert. - - - The managed string or null upon failure. - - - - - Probes a native pointer to a string in the UTF-8 encoding for its - terminating NUL character, within the specified length limit. - - - The native NUL-terminated string pointer. - - - The maximum length of the native string, in bytes. - - - The length of the native string, in bytes -OR- zero if the length - could not be determined. - - - - - Converts the specified native NUL-terminated UTF-8 string pointer - into a managed string. - - - The native NUL-terminated UTF-8 string pointer. - - - The managed string or null upon failure. - - - - - Converts the specified native UTF-8 string pointer of the specified - length into a managed string. - - - The native UTF-8 string pointer. - - - The length of the native string, in bytes. - - - The managed string or null upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts the specified managed string into a native NUL-terminated - UTF-8 string pointer using memory obtained from the SQLite core - library. - - - The managed string to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The length of the native string, in bytes. - - - The native NUL-terminated UTF-8 string pointer or - upon failure. - - - - - Converts a logical array of native NUL-terminated UTF-8 string - pointers into an array of managed strings. - - - The number of elements in the logical array of native - NUL-terminated UTF-8 string pointers. - - - The native pointer to the logical array of native NUL-terminated - UTF-8 string pointers to convert. - - - The array of managed strings or null upon failure. - - - - - Converts an array of managed strings into an array of native - NUL-terminated UTF-8 string pointers. - - - The array of managed strings to convert. - - - Non-zero to obtain memory from the SQLite core library without - adjusting the number of allocated bytes currently being tracked - by the class. - - - The array of native NUL-terminated UTF-8 string pointers or null - upon failure. - - - - - This class contains static methods that are used to deal with native - pointers to memory blocks that logically contain arrays of bytes to be - used with the SQLite core library. - - - - - Converts a native pointer to a logical array of bytes of the - specified length into a managed byte array. - - - The native pointer to the logical array of bytes to convert. - - - The length, in bytes, of the logical array of bytes to convert. - - - The managed byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The native pointer to a logical byte array or null upon failure. - - - - - Converts a managed byte array into a native pointer to a logical - array of bytes. - - - The managed byte array to convert. - - - The length, in bytes, of the converted logical array of bytes. - - - The native pointer to a logical byte array or null upon failure. - - - - - This class contains static methods that are used to perform several - low-level data marshalling tasks between native and managed code. - - - - - Returns a new object instance based on the - specified object instance and an integer - offset. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location that the new - object instance should point to. - - - The new object instance. - - - - - Rounds up an integer size to the next multiple of the alignment. - - - The size, in bytes, to be rounded up. - - - The required alignment for the return value. - - - The size, in bytes, rounded up to the next multiple of the - alignment. This value may end up being the same as the original - size. - - - - - Determines the offset, in bytes, of the next structure member. - - - The offset, in bytes, of the current structure member. - - - The size, in bytes, of the current structure member. - - - The alignment, in bytes, of the next structure member. - - - The offset, in bytes, of the next structure member. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Reads a value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - to be read is located. - - - The value at the specified memory location. - - - - - Reads an value from the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be read is located. - - - The value at the specified memory location. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes an value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Writes a value to the specified memory - location. - - - The object instance representing the base - memory location. - - - The integer offset from the base memory location where the - value to be written is located. - - - The value to write. - - - - - Generates a hash code value for the object. - - - The object instance used to calculate the hash code. - - - Non-zero if different object instances with the same value should - generate different hash codes, where applicable. This parameter - has no effect on the .NET Compact Framework. - - - The hash code value -OR- zero if the object is null. - - - - - This class represents a managed virtual table module implementation. - It is not sealed and must be used as the base class for any - user-defined virtual table module classes implemented in managed code. - - - - - This class implements the - interface by forwarding those method calls to the - object instance it contains. If the - contained object instance is null, all - the methods simply generate an - error. - - - - - This is the value that is always used for the "logErrors" - parameter to the various static error handling methods provided - by the class. - - - - - This is the value that is always used for the "logExceptions" - parameter to the various static error handling methods provided - by the class. - - - - - This is the error message text used when the contained - object instance is not available - for any reason. - - - - - The object instance used to provide - an implementation of the - interface. - - - - - Constructs an instance of this class. - - - The object instance used to provide - an implementation of the - interface. - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab derived structure. - - - The value of . - - - - - Sets the table error message to one that indicates the native - module implementation is not available. - - - The native pointer to the sqlite3_vtab_cursor derived - structure. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - The default version of the native sqlite3_module structure in use. - - - - - This field is used to store the native sqlite3_module structure - associated with this object instance. - - - - - This field is used to store the destructor delegate to be passed to - the SQLite core library via the sqlite3_create_disposable_module() - function. - - - - - This field is used to store a pointer to the native sqlite3_module - structure returned by the sqlite3_create_disposable_module - function. - - - - - This field is used to store the virtual table instances associated - with this module. The native pointer to the sqlite3_vtab derived - structure is used to key into this collection. - - - - - This field is used to store the virtual table cursor instances - associated with this module. The native pointer to the - sqlite3_vtab_cursor derived structure is used to key into this - collection. - - - - - This field is used to store the virtual table function instances - associated with this module. The case-insensitive function name - and the number of arguments (with -1 meaning "any") are used to - construct the string that is used to key into this collection. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Calls the native SQLite core library in order to create a new - disposable module containing the implementation of a virtual table. - - - The native database connection pointer to use. - - - Non-zero upon success. - - - - - This method is called by the SQLite core library when the native - module associated with this object instance is being destroyed due - to its parent connection being closed. It may also be called by - the "vtshim" module if/when the sqlite3_dispose_module() function - is called. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - - - Creates and returns the native sqlite_module structure using the - configured (or default) - interface implementation. - - - The native sqlite_module structure using the configured (or - default) interface - implementation. - - - - - Creates and returns the native sqlite_module structure using the - specified interface - implementation. - - - The interface implementation to - use. - - - The native sqlite_module structure using the specified - interface implementation. - - - - - Creates a copy of the specified - object instance, - using default implementations for the contained delegates when - necessary. - - - The object - instance to copy. - - - The new object - instance. - - - - - Calls one of the virtual table initialization methods. - - - Non-zero to call the - method; otherwise, the - method will be called. - - - The native database connection handle. - - - The original native pointer value that was provided to the - sqlite3_create_module(), sqlite3_create_module_v2() or - sqlite3_create_disposable_module() functions. - - - The number of arguments from the CREATE VIRTUAL TABLE statement. - - - The array of string arguments from the CREATE VIRTUAL TABLE - statement. - - - Upon success, this parameter must be modified to point to the newly - created native sqlite3_vtab derived structure. - - - Upon failure, this parameter must be modified to point to the error - message, with the underlying memory having been obtained from the - sqlite3_malloc() function. - - - A standard SQLite return code. - - - - - Calls one of the virtual table finalization methods. - - - Non-zero to call the - method; otherwise, the - method will be - called. - - - The native pointer to the sqlite3_vtab derived structure. - - - A standard SQLite return code. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - used to get the native pointer to the sqlite3_vtab derived - structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance to be used. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - Non-zero if this error message should also be logged using the - class. - - - Non-zero if caught exceptions should be logged using the - class. - - - The error message. - - - Non-zero upon success. - - - - - Gets and returns the interface - implementation to be used when creating the native sqlite3_module - structure. Derived classes may override this method to supply an - alternate implementation for the - interface. - - - The interface implementation to - be used when populating the native sqlite3_module structure. If - the returned value is null, the private methods provided by the - class and relating to the - interface will be used to - create the necessary delegates. - - - - - Creates and returns the - interface implementation corresponding to the current - object instance. - - - The interface implementation - corresponding to the current object - instance. - - - - - Allocates a native sqlite3_vtab derived structure and returns a - native pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Zeros out the fields of a native sqlite3_vtab derived structure. - - - The native pointer to the native sqlite3_vtab derived structure to - zero. - - - - - Frees a native sqlite3_vtab structure using the provided native - pointer to it. - - - A native pointer to a native sqlite3_vtab derived structure. - - - - - Allocates a native sqlite3_vtab_cursor derived structure and - returns a native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Frees a native sqlite3_vtab_cursor structure using the provided - native pointer to it. - - - A native pointer to a native sqlite3_vtab_cursor derived structure. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The object instance to be used. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Reads and returns the native pointer to the sqlite3_vtab derived - structure based on the native pointer to the sqlite3_vtab_cursor - derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure - from which to read the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure -OR- - if it cannot be determined. - - - - - Looks up and returns the object - instance based on the native pointer to the sqlite3_vtab derived - structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The object instance or null if - the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab derived - structure and creates an association between it and the specified - object instance. - - - The object instance to be used - when creating the association. - - - The native pointer to a sqlite3_vtab derived structure or - if the method fails for any reason. - - - - - Looks up and returns the - object instance based on the native pointer to the - sqlite3_vtab_cursor derived structure. - - - The native pointer to the sqlite3_vtab derived structure. - - - The native pointer to the sqlite3_vtab_cursor derived structure. - - - The object instance or null - if the corresponding one cannot be found. - - - - - Allocates and returns a native pointer to a sqlite3_vtab_cursor - derived structure and creates an association between it and the - specified object instance. - - - The object instance to be - used when creating the association. - - - The native pointer to a sqlite3_vtab_cursor derived structure or - if the method fails for any reason. - - - - - Deterimines the key that should be used to identify and store the - object instance for the virtual table - (i.e. to be returned via the - method). - - - The number of arguments to the virtual table function. - - - The name of the virtual table function. - - - The object instance associated with - this virtual table function. - - - The string that should be used to identify and store the virtual - table function instance. This method cannot return null. If null - is returned from this method, the behavior is undefined. - - - - - Attempts to declare the schema for the virtual table using the - specified database connection. - - - The object instance to use when - declaring the schema of the virtual table. This parameter may not - be null. - - - The string containing the CREATE TABLE statement that completely - describes the schema for the virtual table. This parameter may not - be null. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - Calls the native SQLite core library in order to declare a virtual - table function in response to a call into the - - or virtual table - methods. - - - The object instance to use when - declaring the schema of the virtual table. - - - The number of arguments to the function being declared. - - - The name of the function being declared. - - - Upon success, the contents of this parameter are undefined. Upon - failure, it should contain an appropriate error message. - - - A standard SQLite return code. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - the method, - the method, - the method, - and the method should be logged using the - class. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Arranges for the specified error message to be placed into the - zErrMsg field of a sqlite3_vtab derived structure, freeing the - existing error message, if any. - - - The object instance used to - lookup the native pointer to the sqlite3_vtab derived structure. - - - The error message. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated cost. - - - The object instance to modify. - - - The estimated cost value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated cost. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified estimated rows. - - - The object instance to modify. - - - The estimated rows value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default estimated rows. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the specified flags. - - - The object instance to modify. - - - The index flags value to use. Using a null value means that the - default value provided by the SQLite core library should be used. - - - Non-zero upon success. - - - - - Modifies the specified object instance - to contain the default index flags. - - - The object instance to modify. - - - Non-zero upon success. - - - - - Returns or sets a boolean value indicating whether virtual table - errors should be logged using the class. - - - - - Returns or sets a boolean value indicating whether exceptions - caught in the - method, - method, and the - method should be logged using the - class. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Returns non-zero if the schema for the virtual table has been - declared. - - - - - Returns the name of the module as it was registered with the SQLite - core library. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated with - the virtual table. - - - The native user-data pointer associated with this module, as it was - provided to the SQLite core library when the native module instance - was created. - - - The module name, database name, virtual table name, and all other - arguments passed to the CREATE VIRTUAL TABLE statement. - - - Upon success, this parameter must be modified to contain the - object instance associated with - the virtual table. - - - Upon failure, this parameter must be modified to contain an error - message. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The object instance containing all the - data for the inputs and outputs relating to index selection. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - Upon success, this parameter must be modified to contain the - object instance associated - with the newly opened virtual table cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Number used to help identify the selected index. - - - String used to help identify the selected index. - - - The values corresponding to each column in the selected index. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Non-zero if no more rows are available; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to be used for - returning the specified column value to the SQLite core library. - - - The zero-based index corresponding to the column containing the - value to be returned. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the current row for the specified cursor. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The array of object instances containing - the new or modified column values, if any. - - - Upon success, this parameter must be modified to contain the unique - integer row identifier for the row that was inserted, if any. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The number of arguments to the function being sought. - - - The name of the function being sought. - - - Upon success, this parameter must be modified to contain the - object instance responsible for - implementing the specified function. - - - Upon success, this parameter must be modified to contain the - native user-data pointer associated with - . - - - Non-zero if the specified function was found; zero otherwise. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - The new name for the virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier under which the the current state of - the virtual table should be saved. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer used to indicate that any saved states with an - identifier greater than or equal to this should be deleted by the - virtual table. - - - A standard SQLite return code. - - - - - This method is called in response to the - method. - - - The object instance associated - with this virtual table. - - - This is an integer identifier used to specify a specific saved - state for the virtual table for it to restore itself back to, which - should also have the effect of deleting all saved states with an - integer identifier greater than this one. - - - A standard SQLite return code. - - - - - Disposes of this object instance. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is being - called from the finalizer. - - - - - Finalizes this object instance. - - - - - This class contains some virtual methods that may be useful for other - virtual table classes. It specifically does NOT implement any of the - interface methods. - - - - - The CREATE TABLE statement used to declare the schema for the - virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Determines the SQL statement used to declare the virtual table. - This method should be overridden in derived classes if they require - a custom virtual table schema. - - - The SQL statement used to declare the virtual table -OR- null if it - cannot be determined. - - - - - Sets the table error message to one that indicates the virtual - table cursor is of the wrong type. - - - The object instance. - - - The that the virtual table cursor should be. - - - The value of . - - - - - Determines the string to return as the column value for the object - instance value. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a string representation for. - - - The string representation of the specified object instance or null - upon failure. - - - - - Constructs an unique row identifier from two - values. The first value - must contain the row sequence number for the current row and the - second value must contain the hash code of the key column value - for the current row. - - - The integer row sequence number for the current row. - - - The hash code of the key column value for the current row. - - - The unique row identifier or zero upon failure. - - - - - Determines the unique row identifier for the current row. - - - The object instance - associated with the previously opened virtual table cursor to be - used. - - - The object instance to return a unique row identifier for. - - - The unique row identifier or zero upon failure. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this cursor - was created. - - - - - This value will be non-zero if false has been returned from the - method. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Advances to the next row of the virtual table cursor using the - method of the - object instance. - - - Non-zero if the current row is valid; zero otherwise. If zero is - returned, no further rows are available. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - Resets the virtual table cursor position, also invalidating the - current row, using the method of - the object instance. - - - - - Returns non-zero if the end of the virtual table cursor has been - seen (i.e. no more rows are available, including the current one). - - - - - Returns non-zero if the virtual table cursor is open. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if the virtual - table cursor has been closed. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. The following short - example shows it being used to treat an array of strings as a table - data source: - - public static class Sample - { - public static void Main() - { - using (SQLiteConnection connection = new SQLiteConnection( - "Data Source=:memory:;")) - { - connection.Open(); - - connection.CreateModule(new SQLiteModuleEnumerable( - "sampleModule", new string[] { "one", "two", "three" })); - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = - "CREATE VIRTUAL TABLE t1 USING sampleModule;"; - - command.ExecuteNonQuery(); - } - - using (SQLiteCommand command = connection.CreateCommand()) - { - command.CommandText = "SELECT * FROM t1;"; - - using (SQLiteDataReader dataReader = command.ExecuteReader()) - { - while (dataReader.Read()) - Console.WriteLine(dataReader[0].ToString()); - } - } - - connection.Close(); - } - } - } - - - - - - The instance containing the backing data - for the virtual table. - - - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This has no - effect on the .NET Compact Framework. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - Non-zero if different object instances with the same value should - generate different row identifiers, where applicable. This - parameter has no effect on the .NET Compact Framework. - - - - - Sets the table error message to one that indicates the virtual - table cursor has no current row. - - - The object instance. - - - The value of . - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class represents a virtual table cursor to be used with the - class. It is not sealed and may - be used as the base class for any user-defined virtual table cursor - class that wraps an object instance. - - - - - The instance provided when this - cursor was created. - - - - - Constructs an instance of this class. - - - The object instance associated - with this object instance. - - - The instance to expose as a virtual - table cursor. - - - - - Returns the value for the current row of the virtual table cursor - using the property of the - object instance. - - - - - Closes the virtual table cursor. This method must not throw any - exceptions. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class implements a virtual table module that exposes an - object instance as a read-only virtual - table. It is not sealed and may be used as the base class for any - user-defined virtual table class that wraps an - object instance. - - - - - The instance containing the backing - data for the virtual table. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - The instance to expose as a virtual - table. This parameter cannot be null. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This class implements a virtual table module that does nothing by - providing "empty" implementations for all of the - interface methods. The result - codes returned by these "empty" method implementations may be - controlled on a per-method basis by using and/or overriding the - , - , - , - , and - methods from within derived classes. - - - - - This field is used to store the - values to return, on a per-method basis, for all methods that are - part of the interface. - - - - - Constructs an instance of this class. - - - The name of the module. This parameter cannot be null. - - - - - Determines the default value to be - returned by methods of the - interface that lack an overridden implementation in all classes - derived from the class. - - - The value that should be returned - by all interface methods unless - a more specific result code has been set for that interface method. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Converts a value into a boolean - return value for use with the - method. - - - The value to convert. - - - The value. - - - - - Determines the value that should be - returned by the specified - interface method if it lack an overridden implementation. If no - specific value is available (or set) - for the specified method, the value - returned by the method will be - returned instead. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - - - Sets the value that should be - returned by the specified - interface method if it lack an overridden implementation. - - - The name of the method. Currently, this method must be part of - the interface. - - - The value that should be returned - by the interface method. - - - Non-zero upon success. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - See the method. - - - See the method. - - - See the method. - - - See the method. - - - - - Throws an if this object - instance has been disposed. - - - - - Disposes of this object instance. - - - Non-zero if this method is being called from the - method. Zero if this method is - being called from the finalizer. - - - - - This enumerated type represents a type of conflict seen when apply - changes from a change set or patch set. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is present in the - database, but one or more other (non primary-key) fields modified - by the update do not contain the expected "before" values. - - - - - This value is seen when processing a DELETE or UPDATE change if a - row with the required PRIMARY KEY fields is not present in the - database. There is no conflicting row in this case. - - The results of invoking the - - method are undefined. - - - - - This value is seen when processing an INSERT change if the - operation would result in duplicate primary key values. - The conflicting row in this case is the database row with the - matching primary key. - - - - - If a non-foreign key constraint violation occurs while applying a - change (i.e. a UNIQUE, CHECK or NOT NULL constraint), the conflict - callback will see this value. - - There is no conflicting row in this case. The results of invoking - the - method are undefined. - - - - - If foreign key handling is enabled, and applying a changes leaves - the database in a state containing foreign key violations, this - value will be seen exactly once before the changes are committed. - If the conflict handler - , the changes, - including those that caused the foreign key constraint violation, - are committed. Or, if it returns - , the changes are - rolled back. - - No current or conflicting row information is provided. The only - method it is possible to call on the supplied - object is - . - - - - - This enumerated type represents the result of a user-defined conflict - resolution callback. - - - - - If a conflict callback returns this value no special action is - taken. The change that caused the conflict is not applied. The - application of changes continues with the next change. - - - - - This value may only be returned from a conflict callback if the - type of conflict was - or . If this is - not the case, any changes applied so far are rolled back and the - call to - - will raise a with an error code of - . - - If this value is returned for a - conflict, then the - conflicting row is either updated or deleted, depending on the type - of change. - - If this value is returned for a - conflict, then - the conflicting row is removed from the database and a second - attempt to apply the change is made. If this second attempt fails, - the original row is restored to the database before continuing. - - - - - If this value is returned, any changes applied so far are rolled - back and the call to - - will raise a with an error code of - . - - - - - This enumerated type represents possible flags that may be passed - to the appropriate overloads of various change set creation methods. - - - - - No special handling. - - - - - Invert the change set while iterating through it. - This is equivalent to inverting a change set using - before - applying it. It is an error to specify this flag - with a patch set. - - - - - This callback is invoked when a determination must be made about - whether changes to a specific table should be tracked -OR- applied. - It will not be called for tables that are already attached to a - . - - - The optional application-defined context data that was originally - passed to the or - - methods. This value may be null. - - - The name of the table. - - - Non-zero if changes to the table should be considered; otherwise, - zero. Throwing an exception from this callback will result in - undefined behavior. - - - - - This callback is invoked when there is a conflict while apply changes - to a database. - - - The optional application-defined context data that was originally - passed to the - - method. This value may be null. - - - The type of this conflict. - - - The object associated with - this conflict. This value may not be null; however, only properties - that are applicable to the conflict type will be available. Further - information on this is available within the descriptions of the - available values. - - - A value that indicates the - action to be taken in order to resolve the conflict. Throwing an - exception from this callback will result in undefined behavior. - - - - - This interface contains methods used to manipulate a set of changes for - a database. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes -OR- null if it is not available. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - This interface contains methods used to manipulate multiple sets of - changes for a database. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - This interface contains properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - The name of the table the change was made to. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - This interface contains methods to query and manipulate the state of a - change tracking session for a database. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this session instance as a - patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - This class contains some static helper methods for use within this - subsystem. - - - - - This method checks the byte array specified by the caller to make - sure it will be usable. - - - A byte array provided by the caller into one of the public methods - for the classes that belong to this subsystem. This value cannot - be null or represent an empty array; otherwise, an appropriate - exception will be thrown. - - - - - This class is used to hold the native connection handle associated with - a open until this subsystem is totally - done with it. This class is for internal use by this subsystem only. - - - - - The SQL statement used when creating the native statement handle. - There are no special requirements for this other than counting as - an "open statement handle". - - - - - The format of the error message used when reporting, during object - disposal, that the statement handle is still open (i.e. because - this situation is considered a fairly serious programming error). - - - - - The wrapped native connection handle associated with this lock. - - - - - The flags associated with the connection represented by the - value. - - - - - The native statement handle for this lock. The garbage collector - cannot cause this statement to be finalized; therefore, it will - serve to hold the associated native connection open until it is - freed manually using the method. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - lock. - - - The flags associated with the connection represented by the - value. - - - Non-zero if the method should be called prior - to returning from this constructor. - - - - - Queries and returns the wrapped native connection handle for this - instance. - - - The wrapped native connection handle for this instance -OR- null - if it is unavailable. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Queries and returns the native connection handle for this instance. - - - The native connection handle for this instance. If this value is - unavailable or invalid an exception will be thrown. - - - - - This method attempts to "lock" the associated native connection - handle by preparing a SQL statement that will not be finalized - until the method is called (i.e. and which - cannot be done by the garbage collector). If the statement is - already prepared, nothing is done. If the statement cannot be - prepared for any reason, an exception will be thrown. - - - - - This method attempts to "unlock" the associated native connection - handle by finalizing the previously prepared statement. If the - statement is already finalized, nothing is done. If the statement - cannot be finalized for any reason, an exception will be thrown. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator. It is used as the - base class for the and - classes. It knows how to - advance the native iterator handle as well as finalize it. - - - - - The native change set (a.k.a. iterator) handle. - - - - - Non-zero if this instance owns the native iterator handle in the - field. In that case, this instance will - finalize the native iterator handle upon being disposed or - finalized. - - - - - Constructs a new instance of this class using the specified native - iterator handle. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Throws an exception if the native iterator handle is invalid. - - - - - Used to query the native iterator handle. This method is only used - by the class. - - - The native iterator handle -OR- if it - is not available. - - - - - Attempts to advance the native iterator handle to its next item. - - - Non-zero if the native iterator handle was advanced and contains - more data; otherwise, zero. If the underlying native API returns - an unexpected value then an exception will be thrown. - - - - - Attempts to create an instance of this class that is associated - with the specified native iterator handle. Ownership of the - native iterator handle is NOT transferred to the new instance of - this class. - - - The native iterator handle to use. - - - The new instance of this class. No return value is reserved to - indicate an error; however, if the native iterator handle is not - valid, any subsequent attempt to make use of it via the returned - instance of this class may throw exceptions. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages the native change set iterator for a set of changes - contained entirely in memory. - - - - - The native memory buffer allocated to contain the set of changes - associated with this instance. This will always be freed when this - instance is disposed or finalized. - - - - - Constructs an instance of this class using the specified native - memory buffer and native iterator handle. - - - The native memory buffer to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - raw byte data. - - - The raw byte data containing the set of changes for this native - iterator. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class manages the native change set iterator for a set of changes - backed by a instance. - - - - - The instance that is managing - the underlying used as the backing store for - the set of changes associated with this native change set iterator. - - - - - Constructs an instance of this class using the specified native - iterator handle and . - - - The instance to use. - - - The native iterator handle to use. - - - Non-zero if this instance is to take ownership of the native - iterator handle specified by . - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Attempts to create an instance of this class using the specified - . - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - The new instance of this class -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class is used to act as a bridge between a - instance and the delegates used with the native streaming API. - - - - - The managed stream instance used to in order to service the native - delegates for both input and output. - - - - - The flags associated with the connection. - - - - - The delegate used to provide input to the native streaming API. - It will be null -OR- point to the method. - - - - - The delegate used to provide output to the native streaming API. - It will be null -OR- point to the method. - - - - - Constructs a new instance of this class using the specified managed - stream and connection flags. - - - The managed stream instance to be used in order to service the - native delegates for both input and output. - - - The flags associated with the parent connection. - - - - - Queries and returns the flags associated with the connection for - this instance. - - - The value. There is no return - value reserved to indicate an error. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - Returns a delegate that wraps the method, - creating it first if necessary. - - - A delegate that refers to the method. - - - - - This method attempts to read bytes from - the managed stream, writing them to the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer to receive the requested input bytes. - It must be at least bytes in size. - - - Upon entry, the number of bytes to read. Upon exit, the number of - bytes actually read. This value may be zero upon exit. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - This method attempts to write bytes to - the managed stream, reading them from the - buffer. - - - Optional extra context information. Currently, this will always - have a value of . - - - A preallocated native buffer containing the requested output - bytes. It must be at least bytes in - size. - - - The number of bytes to write. - - - The value upon success -OR- an - appropriate error code upon failure. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class manages a collection of - instances. When used, it takes responsibility for creating, returning, - and disposing of its instances. - - - - - The managed collection of - instances, keyed by their associated - instance. - - - - - The flags associated with the connection. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Makes sure the collection of - is created. - - - - - Makes sure the collection of - is disposed. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents a group of change sets (or patch sets). - - - - - The instance associated - with this change group. - - - - - The flags associated with the connection. - - - - - The native handle for this change group. This will be deleted when - this instance is disposed or finalized. - - - - - Constructs a new instance of this class using the specified - connection flags. - - - The flags associated with the parent connection. - - - - - Throws an exception if the native change group handle is invalid. - - - - - Makes sure the native change group handle is valid, creating it if - necessary. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data must be contained entirely within - the byte array. - - - The raw byte data for the specified change set (or patch set). - - - - - Attempts to add a change set (or patch set) to this change group - instance. The underlying data will be read from the specified - . - - - The instance containing the raw change set - (or patch set) data to read. - - - - - Attempts to create and return, via , the - combined set of changes represented by this change group instance. - - - Upon success, this will contain the raw byte data for all the - changes in this change group instance. - - - - - Attempts to create and write, via , the - combined set of changes represented by this change group instance. - - - Upon success, the raw byte data for all the changes in this change - group instance will be written to this . - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents the change tracking session associated with a - database. - - - - - The instance associated - with this session. - - - - - The name of the database (e.g. "main") for this session. - - - - - The native handle for this session. This will be deleted when - this instance is disposed or finalized. - - - - - The delegate used to provide table filtering to the native API. - It will be null -OR- point to the method. - - - - - The managed callback used to filter tables for this session. Set - via the method. - - - - - The optional application-defined context data that was passed to - the method. This value may be null. - - - - - Constructs a new instance of this class using the specified wrapped - native connection handle and associated flags. - - - The wrapped native connection handle to be associated with this - session. - - - The flags associated with the connection represented by the - value. - - - The name of the database (e.g. "main") for this session. - - - - - Throws an exception if the native session handle is invalid. - - - - - Makes sure the native session handle is valid, creating it if - necessary. - - - - - This method sets up the internal table filtering associated state - of this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - The native - delegate -OR- null to clear any existing table filter. - - - - - Makes sure the instance - is available, creating it if necessary. - - - - - Attempts to return a instance - suitable for the specified . - - - The instance. If this value is null, a null - value will be returned. - - - A instance. Typically, these - are always freshly created; however, this method is designed to - return the existing instance - associated with the specified stream, should one exist. - - - - - This method is called when determining if a table needs to be - included in the tracked changes for the associated database. - - - Optional extra context information. Currently, this will always - have a value of . - - - The native pointer to the name of the table. - - - Non-zero if changes to the specified table should be considered; - otherwise, zero. - - - - - Determines if this session is currently tracking changes to its - associated database. - - - Non-zero if changes to the associated database are being trakced; - otherwise, zero. - - - - - Enables tracking of changes to the associated database. - - - - - Disables tracking of changes to the associated database. - - - - - Determines if this session is currently set to mark changes as - indirect (i.e. as though they were made via a trigger or foreign - key action). - - - Non-zero if changes to the associated database are being marked as - indirect; otherwise, zero. - - - - - Sets the indirect flag for this session. Subsequent changes will - be marked as indirect until this flag is changed again. - - - - - Clears the indirect flag for this session. Subsequent changes will - be marked as direct until this flag is changed again. - - - - - Determines if there are any tracked changes currently within the - data for this session. - - - Non-zero if there are no changes within the data for this session; - otherwise, zero. - - - - - Upon success, causes changes to the specified table(s) to start - being tracked. Any tables impacted by calls to this method will - not cause the callback - to be invoked. - - - The name of the table to be tracked -OR- null to track all - applicable tables within this database. - - - - - This method is used to set the table filter for this instance. - - - The table filter callback -OR- null to clear any existing table - filter callback. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to create and return, via , the - set of changes represented by this session instance. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - Attempts to create and return, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, this will contain the raw byte data for all the - changes in this session instance. - - - - - Attempts to create and write, via , the - set of changes represented by this session instance as a patch set. - - - Upon success, the raw byte data for all the changes in this session - instance will be written to this . - - - - - This method loads the differences between two tables [with the same - name, set of columns, and primary key definition] into this session - instance. - - - The name of the database containing the table with the original - data (i.e. it will need updating in order to be identical to the - one within the database associated with this session instance). - - - The name of the table. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents the abstract concept of a set of changes. It - acts as the base class for the - and classes. It derives from - the class, which is used to hold - the underlying native connection handle open until the instances of - this class are disposed or finalized. It also provides the ability - to construct wrapped native delegates of the - and - types. - - - - - Constructs an instance of this class using the specified wrapped - native connection handle. - - - The wrapped native connection handle to be associated with this - change set. - - - The flags associated with the connection represented by the - value. - - - - - Creates and returns a concrete implementation of the - interface. - - - The native iterator handle to use. - - - An instance of the - interface, which can be used to fetch metadata associated with - the current item in this set of changes. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Attempts to create a - native delegate - that invokes the specified - delegate. - - - The to invoke when the - native delegate - is called. If this value is null then null is returned. - - - The optional application-defined context data. This value may be - null. - - - The created - native delegate -OR- null if it cannot be created. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified raw byte - data and wrapped native connection handle. - - - The raw byte data for the specified change set (or patch set). - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - The new instance that represents - the resulting set of changes. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - The new instance that represents - the resulting set of changes. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents a set of changes that are backed by a - instance. - - - - - The instance that is managing - the underlying input used as the backing - store for the set of changes associated with this instance. - - - - - The instance that is managing - the underlying output used as the backing - store for the set of changes generated by the - or methods. - - - - - The instance used as the backing store for - the set of changes associated with this instance. - - - - - The instance used as the backing store for - the set of changes generated by the or - methods. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - - - Constructs an instance of this class using the specified streams - and wrapped native connection handle. - - - The where the raw byte data for the set of - changes may be read. - - - The where the raw byte data for resulting - sets of changes may be written. - - - The wrapped native connection handle to be associated with this - set of changes. - - - The flags associated with the connection represented by the - value. - - - The flags used to create the change set iterator. - - - - - Throws an exception if the input stream or its associated stream - adapter are invalid. - - - - - Throws an exception if the output stream or its associated stream - adapter are invalid. - - - - - This method "inverts" the set of changes within this instance. - Applying an inverted set of changes to a database reverses the - effects of applying the uninverted changes. Specifically: - ]]>]]> - Each DELETE change is changed to an INSERT, and - ]]>]]> - Each INSERT change is changed to a DELETE, and - ]]>]]> - For each UPDATE change, the old.* and new.* values are exchanged. - ]]>]]> - This method does not change the order in which changes appear - within the set of changes. It merely reverses the sense of each - individual change. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - This method combines the specified set of changes with the ones - contained in this instance. - - - The changes to be combined with those in this instance. - - - Since the resulting set of changes is written to the output stream, - this method always returns null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional application-defined context data. This value may be - null. - - - - - Attempts to apply the set of changes in this instance to the - associated database. - - - The delegate that will need - to handle any conflicting changes that may arise. - - - The optional delegate - that can be used to filter the list of tables impacted by the set - of changes. - - - The optional application-defined context data. This value may be - null. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new - instance. - - - - - Creates an capable of iterating over the - items within this set of changes. - - - The new instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes. It serves as the base class for the - and - classes. It manages and - owns an instance of the class. - - - - - This managed change set iterator is managed and owned by this - class. It will be disposed when this class is disposed. - - - - - Constructs an instance of this class using the specified managed - change set iterator. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Sets the managed iterator instance to a new value. - - - The new managed iterator instance to use. - - - - - Disposes of the managed iterator instance and sets its value to - null. - - - - - Disposes of the existing managed iterator instance and then sets it - to a new value. - - - The new managed iterator instance to use. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - Returns the current change within the set of changes, represented - by a instance. - - - - - Attempts to advance to the next item in the set of changes. - - - Non-zero if more items are available; otherwise, zero. - - - - - Throws because not all the - derived classes are able to support reset functionality. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - - - - This class represents an that is capable of - enumerating over a set of changes contained entirely in memory. - - - - - The raw byte data for this set of changes. Since this data must - be marshalled to a native memory buffer before being used, there - must be enough memory available to store at least two times the - amount of data contained within it. - - - - - The flags used to create the change set iterator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - - - Constructs an instance of this class using the specified raw byte - data. - - - The raw byte data containing the set of changes for this - enumerator. - - - The flags used to create the change set iterator. - - - - - Resets the enumerator to its initial position. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This class represents an that is capable of - enumerating over a set of changes backed by a - instance. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - - - Constructs an instance of this class using the specified stream. - - - The where the raw byte data for the set of - changes may be read. - - - The flags associated with the parent connection. - - - The flags used to create the change set iterator. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - This interface implements properties and methods used to fetch metadata - about one change within a set of changes for a database. - - - - - The instance to use. This - will NOT be owned by this class and will not be disposed upon this - class being disposed or finalized. - - - - - Constructs an instance of this class using the specified iterator - instance. - - - The managed iterator instance to use. - - - - - Throws an exception if the managed iterator instance is invalid. - - - - - Populates the underlying data for the , - , , and - properties, using the appropriate native - API. - - - - - Populates the underlying data for the - property using the appropriate - native API. - - - - - Populates the underlying data for the - property using the - appropriate native API. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - The name of the table the change was made to. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - The number of columns impacted by this change. This value can be - used to determine the highest valid column index that may be used - with the , , - and methods of this interface. It - will be this value minus one. - - - - - Backing field for the property. This - value will be null if this field has not yet been populated via the - underlying native API. - - - - - This will contain the value - , - , or - , corresponding to - the overall type of change this item represents. - - - - - Backing field for the property. This value - will be null if this field has not yet been populated via the - underlying native API. - - - - - Non-zero if this change is considered to be indirect (i.e. as - though they were made via a trigger or foreign key action). - - - - - Backing field for the property. - This value will be null if this field has not yet been populated - via the underlying native API. - - - - - This array contains a for each column in - the table associated with this change. The element will be zero - if the column is not part of the primary key; otherwise, it will - be non-zero. - - - - - Backing field for the - property. This value will be null if this field has not yet been - populated via the underlying native API. - - - - - This method may only be called from within a - delegate when the conflict - type is . It - returns the total number of known foreign key violations in the - destination database. - - - - - Queries and returns the original value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The original value of a given column for this change. - - - - - Queries and returns the updated value of a given column for this - change. This method may only be called when the - has a value of - or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The updated value of a given column for this change. - - - - - Queries and returns the conflicting value of a given column for - this change. This method may only be called from within a - delegate when the conflict - type is or - . - - - The index for the column. This value must be between zero and one - less than the total number of columns for this table. - - - The conflicting value of a given column for this change. - - - - - Disposes of this object instance. - - - - - Non-zero if this object instance has been disposed. - - - - - Throws an exception if this object instance has been disposed. - - - - - Disposes or finalizes this object instance. - - - Non-zero if this object is being disposed; otherwise, this object - is being finalized. - - - - - Finalizes this object instance. - - -
-
diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/linux-x64/native/netstandard2.0/SQLite.Interop.dll b/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/linux-x64/native/netstandard2.0/SQLite.Interop.dll deleted file mode 100644 index 75fee13..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/linux-x64/native/netstandard2.0/SQLite.Interop.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/osx-x64/native/netstandard2.0/SQLite.Interop.dll b/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/osx-x64/native/netstandard2.0/SQLite.Interop.dll deleted file mode 100644 index e41ae45..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/osx-x64/native/netstandard2.0/SQLite.Interop.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x64/native/netstandard2.0/SQLite.Interop.dll b/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x64/native/netstandard2.0/SQLite.Interop.dll deleted file mode 100644 index 60430b3..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x64/native/netstandard2.0/SQLite.Interop.dll and /dev/null differ diff --git a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x86/native/netstandard2.0/SQLite.Interop.dll b/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x86/native/netstandard2.0/SQLite.Interop.dll deleted file mode 100644 index 363d2d3..0000000 Binary files a/packages/System.Data.SQLite.Core.1.0.112.1/runtimes/win-x86/native/netstandard2.0/SQLite.Interop.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/.signature.p7s b/packages/TaskScheduler.2.9.0/.signature.p7s deleted file mode 100644 index 49bf2b9..0000000 Binary files a/packages/TaskScheduler.2.9.0/.signature.p7s and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/TaskScheduler.2.9.0.nupkg b/packages/TaskScheduler.2.9.0/TaskScheduler.2.9.0.nupkg deleted file mode 100644 index d4f49c1..0000000 Binary files a/packages/TaskScheduler.2.9.0/TaskScheduler.2.9.0.nupkg and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 3662ac7..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index 52f90e1..0000000 --- a/packages/TaskScheduler.2.9.0/lib/net20/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,9149 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - - - The application - - - The system - - - The custom - - - - - - The circular - - - The automatic backup - - - The retain - - - - - - The administrative - - - The operational - - - The analytical - - - The debug - - - PathType - - - The file path - - - The log name - - - SessionAuthentication - - - The default - - - The negotiate - - - The kerberos - - - The NTLM - - - Defines the standard keywords that are attached to events by the event provider. For more information about keywords, see . - - - The audit failure - - - The audit success - - - The correlation hint - - - The correlation hint2 - - - The event log classic - - - The none - - - The response time - - - The SQM - - - The wdi context - - - The wdi diagnostic - - - - Represents a placeholder (bookmark) within an event stream. You can use the placeholder to mark a position and return to this position in a stream of - events. An instance of this object can be obtained from an EventRecord object, in which case it corresponds to the position of that event record. - - - - Initializes a new instance of the class. - The information. - The context. - - - Gets the object data. - The information. - The context. - - - - Represents a keyword for an event. Keywords are defined in an event provider and are used to group the event with other similar events (based on the - usage of the events). - - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - Contains an event level that is defined in an event provider. The level signifies the severity of the event. - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - EventLogConfiguration - - - Initializes a new instance of the class. - Name of the log. - - - Initializes a new instance of the class. - Name of the log. - The session. - - - Gets a value indicating whether this instance is classic log. - true if this instance is classic log; otherwise, false. - - - Gets or sets a value indicating whether this instance is enabled. - true if this instance is enabled; otherwise, false. - - - Gets or sets the log file path. - The log file path. - - - Gets the log isolation. - The log isolation. - - - Gets or sets the log mode. - The log mode. - - - Gets the name of the log. - The name of the log. - - - Gets the type of the log. - The type of the log. - - - Gets or sets the maximum size in bytes. - The maximum size in bytes. - - - Gets the name of the owning provider. - The name of the owning provider. - - - Gets the size of the provider buffer. - The size of the provider buffer. - - - Gets the provider control unique identifier. - The provider control unique identifier. - - - Gets or sets the provider keywords. - The provider keywords. - - - Gets the provider latency. - The provider latency. - - - Gets or sets the provider level. - The provider level. - - - Gets the provider maximum number of buffers. - The provider maximum number of buffers. - - - Gets the provider minimum number of buffers. - The provider minimum number of buffers. - - - Gets the provider names. - The provider names. - - - Gets or sets the security descriptor. - The security descriptor. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Saves the changes. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Allows you to access the run-time properties of active event logs and event log files. These properties include the number of events in the log, the size of the log, a value that determines whether the log is full, and the last time the log was written to or accessed. - - - - Gets the attributes. - The attributes. - - - Gets the creation time. - The creation time. - - - Gets the size of the file. - The size of the file. - - - Gets the is log full. - The is log full. - - - Gets the last access time. - The last access time. - - - Gets the last write time. - The last write time. - - - Gets the oldest record number. - The oldest record number. - - - Gets the record count. - The record count. - - - - Represents a link between an event provider and an event log that the provider publishes events into. This object cannot be instantiated. - - - - Gets the display name. - The display name. - - - Gets a value indicating whether this instance is imported. - true if this instance is imported; otherwise, false. - - - Gets the name of the log. - The name of the log. - - - - Contains an array of strings that represent XPath queries for elements in the XML representation of an event, which is based on the Event Schema. The queries in this object are used to extract values from the event. - - - - - Initializes a new instance of the class. - The property queries. - - - Releases unmanaged and - optionally - managed resources. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Contains the properties of an event instance for an event that is received from an EventLogReader object. The event properties provide information about the event such as the name of the computer where the event was logged and the time that the event was created. - - - - - Gets the activity identifier. - The activity identifier. - - - Gets the bookmark. - The bookmark. - - - Gets the container log. - The container log. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the keywords display names. - The keywords display names. - - - Gets the level. - The level. - - - Gets the display name of the level. - The display name of the level. - - - Gets the name of the log. - The name of the log. - - - Gets the name of the machine. - The name of the machine. - - - Gets the matched query ids. - The matched query ids. - - - Gets the opcode. - The opcode. - - - Gets the display name of the opcode. - The display name of the opcode. - - - Gets the process identifier. - The process identifier. - - - Gets the properties. - The properties. - - - Gets the provider identifier. - The provider identifier. - - - Gets the name of the provider. - The name of the provider. - - - Gets the qualifiers. - The qualifiers. - - - Gets the record identifier. - The record identifier. - - - Gets the related activity identifier. - The related activity identifier. - - - Gets the task. - The task. - - - Gets the display name of the task. - The display name of the task. - - - Gets the thread identifier. - The thread identifier. - - - Gets the time created. - The time created. - - - Gets the user identifier. - The user identifier. - - - Gets the version. - The version. - - - Formats the description. - - - - Formats the description. - The values. - - - - Gets the property values. - The property selector. - - - - To the XML. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Enables you to read events from an event log based on an event query. The events that are read by this object are returned as EventRecord objects. - - - - - Initializes a new instance of the class. - - - Initializes a new instance of the class. - The server. - - - Initializes a new instance of the class. - The server. - The domain. - The user. - The password. - Type of the log on. - - - Gets the global session. - The global session. - - - Cancels the current operations. - - - Clears the log. - Name of the log. - - - Clears the log. - Name of the log. - The backup path. - logName - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Exports the log. - The path. - Type of the path. - The query. - The target file path. - - - Exports the log. - The path. - Type of the path. - The query. - The target file path. - if set to true [tolerate query errors]. - path or targetFilePath - pathType - - - Exports the log and messages. - The path. - Type of the path. - The query. - The target file path. - - - Exports the log and messages. - The path. - Type of the path. - The query. - The target file path. - if set to true [tolerate query errors]. - The target culture information. - - - Gets the log information. - Name of the log. - Type of the path. - - logName - - - Gets the log names. - - - - Gets the provider names. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Contains the metadata (properties and settings) for an event that is defined in an event provider. - - - Gets the description. - The description. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the level. - The level. - - - Gets the log link. - The log link. - - - Gets the opcode. - The opcode. - - - Gets the task. - The task. - - - Gets the template. - The template. - - - Gets the version. - The version. - - - - Contains an event opcode that is defined in an event provider. An opcode defines a numeric value that identifies the activity or a point within an activity that the application was performing when it raised the event. - - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - - Contains the value of an event property that is specified by the event provider when the event is published. - - - - Gets the value. - The value. - - - - Contains the value of an event property that is specified by the event provider when the event is published. - - Contains the properties of an event instance for an event that is received from an EventLogReader object. The event properties provide information about - the event such as the name of the computer where the event was logged and the time that the event was created. - - - - Initializes a new instance of the class. - - - Gets the activity identifier. - The activity identifier. - - - Gets the bookmark. - The bookmark. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the keywords display names. - The keywords display names. - - - Gets the level. - The level. - - - Gets the display name of the level. - The display name of the level. - - - Gets the name of the log. - The name of the log. - - - Gets the name of the machine. - The name of the machine. - - - Gets the opcode. - The opcode. - - - Gets the display name of the opcode. - The display name of the opcode. - - - Gets the process identifier. - The process identifier. - - - Gets the properties. - The properties. - - - Gets the provider identifier. - The provider identifier. - - - Gets the name of the provider. - The name of the provider. - - - Gets the qualifiers. - The qualifiers. - - - Gets the record identifier. - The record identifier. - - - Gets the related activity identifier. - The related activity identifier. - - - Gets the task. - The task. - - - Gets the display name of the task. - The display name of the task. - - - Gets the thread identifier. - The thread identifier. - - - Gets the time created. - The time created. - - - Gets the user identifier. - The user identifier. - - - Gets the version. - The version. - - - Releases unmanaged and - optionally - managed resources. - - - Formats the description. - - - - Formats the description. - The values. - - - - To the XML. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - the custom event handler args. - - - - If any error occurred during subscription, this will be non-null. After a notification containing an exception, no more notifications will be made - for this subscription. - - - - - The EventRecord being notified. - NOTE: If non null, then caller is required to call Dispose(). - - - - - Contains an event task that is defined in an event provider. The task identifies a portion of an application or a component that publishes an event. A task is a 16-bit value with 16 top values reserved. - - - - Gets the display name. - The display name. - - - Gets the event unique identifier. - The event unique identifier. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - - Contains static information about an event provider, such as the name and id of the provider, and the collection of events defined in the provider. - - - - - Initializes a new instance of the class. - Name of the provider. - - - Initializes a new instance of the class. - Name of the provider. - The session. - The target culture information. - - - Gets the display name. - The display name. - - - Gets the events. - The events. - - - Gets the help link. - The help link. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the levels. - The levels. - - - Gets the log links. - The log links. - - - Gets the message file path. - The message file path. - - - Gets the name. - The name. - - - Gets the opcodes. - The opcodes. - - - Gets the parameter file path. - The parameter file path. - - - Gets the resource file path. - The resource file path. - - - Gets the tasks. - The tasks. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - - - - Allows you to access the run-time properties of active event logs and event log files. These properties include the number of events in the log, the size - of the log, a value that determines whether the log is full, and the last time the log was written to or accessed. - - - - Represents a link between an event provider and an event log that the provider publishes events into. This object cannot be instantiated. - - - - Contains an array of strings that represent XPath queries for elements in the XML representation of an event, which is based on the Event Schema. The - queries in this object are used to extract values from the event. - - - - - Contains the status code or error code for a specific event log. This status can be used to determine if the event log is available for an operation. - - - - Gets the name of the log. - The name of the log. - - - Gets the status code. - The status code. - - - Used for subscribing to event record notifications from event log. - - - Maintains cached display / metadata information returned from EventRecords that were obtained from this reader. - - - Initializes a new instance of the class. - The path. - - - Initializes a new instance of the class. - The event query. - - - Initializes a new instance of the class. - The event query. - The bookmark. - - - Initializes a new instance of the class. - The event query. - The bookmark. - if set to true [read existing events]. - eventQuery - - - - Occurs when [event record written]. - - - - Attribute allowing extenders to be used with .NET Framework 2.0. - - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - Allows you to obtain the method or property name of the caller to the method. - - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Encapsulates a method that has one parameter and returns a value of the type specified by the TResult parameter. - The type of the return value of the method that this delegate encapsulates. - The return value of the method that this delegate encapsulates. - - - Encapsulates a method that has one parameter and returns a value of the type specified by the TResult parameter. - The type of the parameter of the method that this delegate encapsulates. - The type of the return value of the method that this delegate encapsulates. - The parameter of the method that this delegate encapsulates. - The return value of the method that this delegate encapsulates. - - - Encapsulates a method that has two parameters and returns a value of the type specified by the TResult parameter. - The type of the first parameter of the method that this delegate encapsulates. - The type of the second parameter of the method that this delegate encapsulates. - The type of the return value of the method that this delegate encapsulates. - The first parameter of the method that this delegate encapsulates. - The second parameter of the method that this delegate encapsulates. - The return value of the method that this delegate encapsulates. - - - Encapsulates a method that has two parameters and does not return a value. - The type of the first parameter of the method that this delegate encapsulates. - The type of the second parameter of the method that this delegate encapsulates. - The first parameter of the method that this delegate encapsulates. - The second parameter of the method that this delegate encapsulates. - - - Provides a set of static (Shared in Visual Basic) methods for querying objects that implement . - - - Determines whether any element of a sequence satisfies a condition. - The type of the elements of . - An whose elements to apply the predicate to. - A function to test each element for a condition. - true if any elements in the source sequence pass the test in the specified predicate; otherwise, false. - - - Casts the elements of an to the specified type. - The type to cast the elements of source to. - The that contains the elements to be cast to type . - An that contains each element of the source sequence cast to the specified type. - - - Determines whether a sequence contains a specified element by using the default equality comparer. - The type of the elements of . - A sequence in which to locate a value. - The value to locate in the sequence. - true if the source sequence contains an element that has the specified value; otherwise, false. - - - Returns the number of elements in a sequence. - The type of the elements of . - A sequence that contains elements to be counted. - The number of elements in the input sequence. - - - Returns distinct elements from a sequence by using the default equality comparer to compare values. - The type of the elements of . - The sequence to remove duplicate elements from. - An that contains distinct elements from the source sequence. - - - Returns the first element of a sequence. - The type of the elements of . - The to return the first element of. - The first element in the specified sequence. - - - Returns the first element of a sequence that satisfies a specified condition. - The type of the elements of . - The to return the first element of. - A function to test each element for a condition. - The first element in the sequence that passes the test in the specified predicate function. - - - Returns the first element of a sequence, or a default value if the sequence contains no elements. - The type of the elements of . - The to return the first element of. - default( ) if is empty; otherwise, the first element in . - - - Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. - The type of the elements of source. - An to return an element from. - A function to test each element for a condition. - default() if is empty or if no element passes the test specified by ; otherwise, the first element in that passes the test specified by . - - - Returns the minimum value in a generic sequence. - The type of the elements of source. - A sequence of values to determine the minimum value of. - The minimum value in the sequence. - - - Returns the maximum value in a generic sequence. - The type of the elements of source. - A sequence of values to determine the maximum value of. - The maximum value in the sequence. - - - Sorts the elements of a sequence in ascending order according to a key. - The type of the elements of . - The type of the key returned by . - A sequence of values to order. - A function to extract a key from an element. - An whose elements are sorted according to a key. - - - Projects each element of a sequence into a new form. - The type of the elements of . - The type of the value returned by . - A sequence of values to invoke a transform function on. - A transform function to apply to each element. - An whose elements are the result of invoking the transform function on each element of . - - - Returns the only element of a sequence that satisfies a specified condition, and throws an exception if more than one such element exists. - The type of the elements of . - An to return a single element from. - A function to test an element for a condition. - The single element of the input sequence that satisfies a condition. - - - Computes the sum of a sequence of nullable values. - A sequence of nullable values to calculate the sum of. - The sum of the values in the sequence. - - - - Computes the sum of the sequence of nullable values that are obtained by invoking a transform function on each element of the input sequence. - - The type of the elements of . - A sequence of values that are used to calculate a sum. - A transform function to apply to each element. - The sum of the projected values. - - - Creates an array from a . - The type of the elements of . - An to create an array from. - An array that contains the elements from the input sequence. - - - - Creates a from an according to a specified key selector function, a comparer, and - an element selector function. - - The type of the elements of . - The type of the key returned by . - The type of the value returned by . - An to create a from. - A function to extract a key from each element. - A transform function to produce a result element value from each element. - An to compare keys. - A that contains values of type TElement selected from the input sequence. - - - Creates a from an . - The type of the elements of . - An to create a from. - A that contains elements from the input sequence. - - - Filters a sequence of values based on a predicate. - The type of the elements of . - An to filter. - A function to test each element for a condition. - An that contains elements from the input sequence that satisfy the condition. - - - Represents a strongly-typed, read-only collection of elements. - The type of the elements. - - - - Gets the number of elements in the collection. - The number of elements in the collection. - - - Represents a read-only collection of elements that can be accessed by index. - The type of elements in the read-only list. - - - - Gets the element at the specified index in the read-only list. - The element at the specified index in the read-only list. - The zero-based index of the element to get. - - - - Stub - - - - - Stub - - - - - Stub - - The sender. - The instance containing the event data. - - - - Stub - - - - - Initializes a new instance of the class. - - The action. - The new items. - The old items. - The new index. - The old index. - - - - Initializes a new instance of the class. - - The action. - - - - Initializes a new instance of the class. - - The action. - The item. - The index. - - - - Initializes a new instance of the class. - - The action. - The item. - The item2. - The index. - - - - Initializes a new instance of the class. - - The action. - The new items. - - - - Gets the action. - - - The action. - - - - - Gets the new items. - - - The new items. - - - - - Gets the new index of the starting. - - - The new index of the starting. - - - - - Gets the old items. - - - The old items. - - - - - Gets the old index of the starting. - - - The old index of the starting. - - - - - Stub - - - - - The add - - - - - The move - - - - - The remove - - - - - The replace - - - - - The reset - - - - - Provides thread-local storage of data. - - Specifies the type of data stored per-thread. - - - With the exception of , all public and protected members of - are thread-safe and may be used - concurrently from multiple threads. - - - - - - Initializes the instance. - - - - - Initializes the instance. - - Whether to track all values set on the instance and expose them through the Values property. - - - - Initializes the instance with the - specified function. - - - The invoked to produce a lazily-initialized value when - an attempt is made to retrieve without it having been previously initialized. - - - is a null reference (Nothing in Visual Basic). - - - - - Initializes the instance with the - specified function. - - - The invoked to produce a lazily-initialized value when - an attempt is made to retrieve without it having been previously initialized. - - Whether to track all values set on the instance and expose them via the Values property. - - is a null reference (Nothing in Visual Basic). - - - - - Releases the resources used by this instance. - - - - - Releases the resources used by this instance. - - - Unlike most of the members of , this method is not thread-safe. - - - - - Releases the resources used by this instance. - - - A Boolean value that indicates whether this method is being called due to a call to . - - - Unlike most of the members of , this method is not thread-safe. - - - - Creates and returns a string representation of this instance for the current thread. - The result of calling on the . - - The for the current thread is a null reference (Nothing in Visual Basic). - - - The initialization function referenced in an improper manner. - - - The instance has been disposed. - - - Calling this method forces initialization for the current thread, as is the - case with accessing directly. - - - - - Gets or sets the value of this instance for the current thread. - - - The initialization function referenced in an improper manner. - - - The instance has been disposed. - - - If this instance was not previously initialized for the current thread, - accessing will attempt to initialize it. If an initialization function was - supplied during the construction, that initialization will happen by invoking the function - to retrieve the initial value for . Otherwise, the default value of - will be used. - - - - - Creates a LinkedSlot and inserts it into the linked list for this ThreadLocal instance. - - - - - Gets a list for all of the values currently stored by all of the threads that have accessed this instance. - - - The instance has been disposed. - - - - Gets all of the threads' values in a list. - - - Gets the number of threads that have data in this instance. - - - - Gets whether is initialized on the current thread. - - - The instance has been disposed. - - - - Gets the value of the ThreadLocal<T> for debugging display purposes. It takes care of getting - the value for the current thread in the ThreadLocal mode. - - - Gets the values of all threads that accessed the ThreadLocal<T>. - - - - Resizes a table to a certain length (or larger). - - - - - Chooses the next larger table size - - - - - A wrapper struct used as LinkedSlotVolatile[] - an array of LinkedSlot instances, but with volatile semantics - on array accesses. - - - - - A node in the doubly-linked list stored in the ThreadLocal instance. - - The value is stored in one of two places: - - 1. If SlotArray is not null, the value is in SlotArray.Table[id] - 2. If SlotArray is null, the value is in FinalValue. - - - - - A manager class that assigns IDs to ThreadLocal instances - - - - - A class that facilitates ThreadLocal cleanup after a thread exits. - - After a thread with an associated thread-local table has exited, the FinalizationHelper - is responsible for removing back-references to the table. Since an instance of FinalizationHelper - is only referenced from a single thread-local slot, the FinalizationHelper will be GC'd once - the thread has exited. - - The FinalizationHelper then locates all LinkedSlot instances with back-references to the table - (all those LinkedSlot instances can be found by following references from the table slots) and - releases the table so that it can get GC'd. - - - - A debugger view of the ThreadLocal<T> to surface additional debugging properties and - to ensure that the ThreadLocal<T> does not become initialized if it was not already. - - - Constructs a new debugger view object for the provided ThreadLocal object. - A ThreadLocal object to browse in the debugger. - - - Returns whether the ThreadLocal object is initialized or not. - - - Returns the value of the ThreadLocal object. - - - Return all values for all threads that have accessed this instance. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/net20/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index eee359d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 23b4fd9..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 5004c4d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index c6b0345..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index bb17c3a..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index d800ab5..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net20/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net20/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index b6cd44b..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net20/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index bdb0c40..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index 19cc5c5..0000000 --- a/packages/TaskScheduler.2.9.0/lib/net35/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,8072 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - Allows you to obtain the method or property name of the caller to the method. - - - - Represents a strongly-typed, read-only collection of elements. - The type of the elements. - - - - Gets the number of elements in the collection. - The number of elements in the collection. - - - Represents a read-only collection of elements that can be accessed by index. - The type of elements in the read-only list. - - - - Gets the element at the specified index in the read-only list. - The element at the specified index in the read-only list. - The zero-based index of the element to get. - - - - Stub - - - - - Stub - - - - - Stub - - The sender. - The instance containing the event data. - - - - Stub - - - - - Initializes a new instance of the class. - - The action. - The new items. - The old items. - The new index. - The old index. - - - - Initializes a new instance of the class. - - The action. - - - - Initializes a new instance of the class. - - The action. - The item. - The index. - - - - Initializes a new instance of the class. - - The action. - The item. - The item2. - The index. - - - - Initializes a new instance of the class. - - The action. - The new items. - - - - Gets the action. - - - The action. - - - - - Gets the new items. - - - The new items. - - - - - Gets the new index of the starting. - - - The new index of the starting. - - - - - Gets the old items. - - - The old items. - - - - - Gets the old index of the starting. - - - The old index of the starting. - - - - - Stub - - - - - The add - - - - - The move - - - - - The remove - - - - - The replace - - - - - The reset - - - - - Provides thread-local storage of data. - - Specifies the type of data stored per-thread. - - - With the exception of , all public and protected members of - are thread-safe and may be used - concurrently from multiple threads. - - - - - - Initializes the instance. - - - - - Initializes the instance. - - Whether to track all values set on the instance and expose them through the Values property. - - - - Initializes the instance with the - specified function. - - - The invoked to produce a lazily-initialized value when - an attempt is made to retrieve without it having been previously initialized. - - - is a null reference (Nothing in Visual Basic). - - - - - Initializes the instance with the - specified function. - - - The invoked to produce a lazily-initialized value when - an attempt is made to retrieve without it having been previously initialized. - - Whether to track all values set on the instance and expose them via the Values property. - - is a null reference (Nothing in Visual Basic). - - - - - Releases the resources used by this instance. - - - - - Releases the resources used by this instance. - - - Unlike most of the members of , this method is not thread-safe. - - - - - Releases the resources used by this instance. - - - A Boolean value that indicates whether this method is being called due to a call to . - - - Unlike most of the members of , this method is not thread-safe. - - - - Creates and returns a string representation of this instance for the current thread. - The result of calling on the . - - The for the current thread is a null reference (Nothing in Visual Basic). - - - The initialization function referenced in an improper manner. - - - The instance has been disposed. - - - Calling this method forces initialization for the current thread, as is the - case with accessing directly. - - - - - Gets or sets the value of this instance for the current thread. - - - The initialization function referenced in an improper manner. - - - The instance has been disposed. - - - If this instance was not previously initialized for the current thread, - accessing will attempt to initialize it. If an initialization function was - supplied during the construction, that initialization will happen by invoking the function - to retrieve the initial value for . Otherwise, the default value of - will be used. - - - - - Creates a LinkedSlot and inserts it into the linked list for this ThreadLocal instance. - - - - - Gets a list for all of the values currently stored by all of the threads that have accessed this instance. - - - The instance has been disposed. - - - - Gets all of the threads' values in a list. - - - Gets the number of threads that have data in this instance. - - - - Gets whether is initialized on the current thread. - - - The instance has been disposed. - - - - Gets the value of the ThreadLocal<T> for debugging display purposes. It takes care of getting - the value for the current thread in the ThreadLocal mode. - - - Gets the values of all threads that accessed the ThreadLocal<T>. - - - - Resizes a table to a certain length (or larger). - - - - - Chooses the next larger table size - - - - - A wrapper struct used as LinkedSlotVolatile[] - an array of LinkedSlot instances, but with volatile semantics - on array accesses. - - - - - A node in the doubly-linked list stored in the ThreadLocal instance. - - The value is stored in one of two places: - - 1. If SlotArray is not null, the value is in SlotArray.Table[id] - 2. If SlotArray is null, the value is in FinalValue. - - - - - A manager class that assigns IDs to ThreadLocal instances - - - - - A class that facilitates ThreadLocal cleanup after a thread exits. - - After a thread with an associated thread-local table has exited, the FinalizationHelper - is responsible for removing back-references to the table. Since an instance of FinalizationHelper - is only referenced from a single thread-local slot, the FinalizationHelper will be GC'd once - the thread has exited. - - The FinalizationHelper then locates all LinkedSlot instances with back-references to the table - (all those LinkedSlot instances can be found by following references from the table slots) and - releases the table so that it can get GC'd. - - - - A debugger view of the ThreadLocal<T> to surface additional debugging properties and - to ensure that the ThreadLocal<T> does not become initialized if it was not already. - - - Constructs a new debugger view object for the provided ThreadLocal object. - A ThreadLocal object to browse in the debugger. - - - Returns whether the ThreadLocal object is initialized or not. - - - Returns the value of the ThreadLocal object. - - - Return all values for all threads that have accessed this instance. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/net35/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index dfdb83c..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 8c710db..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 187b253..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index ccbf3b6..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 7621f0f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index d5c2701..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net35/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net35/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index a88474c..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net35/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 1bb0ee3..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index 404b9f9..0000000 --- a/packages/TaskScheduler.2.9.0/lib/net40/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7734 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - - Allows you to obtain the full path of the source file that contains the caller. This is the file path at the time of compile. - - - - - Allows you to obtain the line number in the source file at which the method is called. - - - - Allows you to obtain the method or property name of the caller to the method. - - - - Represents a strongly-typed, read-only collection of elements. - The type of the elements. - - - - Gets the number of elements in the collection. - The number of elements in the collection. - - - Represents a read-only collection of elements that can be accessed by index. - The type of elements in the read-only list. - - - - Gets the element at the specified index in the read-only list. - The element at the specified index in the read-only list. - The zero-based index of the element to get. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/net40/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 5671b31..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 0e181d6..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index eebea5d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 2722f84..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 9b2796d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 6dd415f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net40/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net40/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index fcd6c96..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net40/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index e266d47..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/net452/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/net452/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 980b21b..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 4b7a182..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 6506601..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 69a35e1..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 489e50f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 3a5c241..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net452/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net452/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index e449e76..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net452/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 6d1d86a..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index fba8924..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index a16294f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 8b3b16e..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 5956a76..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index f66a880..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 75e4b3b..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 39ecd81..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/net5.0-windows7.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index e4da9df..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 0fbcb0c..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 2f72f69..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 5b807cb..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 30b33b1..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 2564aac..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 43b8cac..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 10dc12f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 7ae691b..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 702b418..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index eca364c..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 4ee9cd9..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index d36b64d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 101babf..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 7f09b6f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index f9b1807..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp2.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 6a155b0..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index cf77564..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 65451fe..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index ab559cd..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 656971f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 9411f72..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 93b5790..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 300789c..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index 1c5af22..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index b664175..0000000 --- a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,7854 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 8d6c33a..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 04469ba..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 6601066..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 02ca5d1..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 84dda25..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 51dd06f..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 44709bf..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netcoreapp3.1/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.dll deleted file mode 100644 index e75f188..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.xml b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.xml deleted file mode 100644 index 306a6da..0000000 --- a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/Microsoft.Win32.TaskScheduler.xml +++ /dev/null @@ -1,8755 +0,0 @@ - - - - Microsoft.Win32.TaskScheduler - - - - Defines the type of actions a task can perform. - The action type is defined when the action is created and cannot be changed later. See . - - - - This action performs a command-line operation. For example, the action can run a script, launch an executable, or, if the name - of a document is provided, find its associated application and launch the application with the document. - - - - This action fires a handler. - - - This action sends and e-mail. - - - This action shows a message box. - - - An interface that exposes the ability to convert an actions functionality to a PowerShell script. - - - - Abstract base class that provides the common properties that are inherited by all action objects. An action object is created by the - method. - - - - List of unbound values when working with Actions not associated with a registered task. - - - Occurs when a property value changes. - - - Gets the type of the action. - The type of the action. - - - Gets or sets the identifier of the action. - - - Creates the specified action. - Type of the action to instantiate. - of specified type. - - - Creates a new object that is a copy of the current instance. - A new object that is a copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Returns the action Id. - String representation of action. - - - Returns a that represents this action. - The culture. - String representation of action. - - - Creates a specialized class from a defined interface. - Version 1.0 interface. - Specialized action class - - - Creates a specialized class from a defined interface. - Version 2.0 Action interface. - Specialized action class - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that fires a handler. Only available on Task Scheduler 2.0. Only available for Task Scheduler 2.0 on - Windows Vista or Windows Server 2003 and later. - - - This action is the most complex. It allows the task to execute and In-Proc COM server object that implements the ITaskHandler - interface. There is a sample project that shows how to do this in the Downloads section. - - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Identifier of the handler class. - Addition data associated with the handler. - - - Gets or sets the identifier of the handler class. - - - Gets the name of the object referred to by . - - - Gets or sets additional data that is associated with the handler. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Gets the name for CLSID. - The unique identifier. - - - - - Represents an action that sends an e-mail. Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and - later.This action has been deprecated in Windows 8 and later. However, this library is able to mimic its - functionality using PowerShell if the property is set to . To disable this conversion, set the value to . - - The EmailAction allows for an email to be sent when the task is triggered. - - - - - - - - Creates an unbound instance of . - - - Creates an unbound instance of . - Subject of the e-mail. - E-mail address that you want to send the e-mail from. - E-mail address or addresses that you want to send the e-mail to. - Body of the e-mail that contains the e-mail message. - Name of the server that you use to send e-mail from. - - - - Gets or sets an array of file paths to be sent as attachments with the e-mail. Each item must be a value - containing a path to file. - - - - Gets or sets the e-mail address or addresses that you want to Bcc in the e-mail. - - - Gets or sets the body of the e-mail that contains the e-mail message. - - - Gets or sets the e-mail address or addresses that you want to Cc in the e-mail. - - - Gets or sets the e-mail address that you want to send the e-mail from. - - - Gets or sets the header information in the e-mail message to send. - - - Gets or sets the priority of the e-mail message. - A that contains the priority of this message. - - - Gets or sets the e-mail address that you want to reply to. - - - Gets or sets the name of the server that you use to send e-mail from. - - - Gets or sets the subject of the e-mail. - - - Gets or sets the e-mail address or addresses that you want to send the e-mail to. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Represents an action that executes a command-line operation. - - All versions of the base library support the ExecAction. It only has three properties that allow it to run an executable with parameters. - - - - - - - - - Creates a new instance of an that can be added to . - - - Creates a new instance of an that can be added to . - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - - - Gets or sets the arguments associated with the command-line operation. - - - Gets or sets the path to an executable file. - - - - Gets or sets the directory that contains either the executable file or the files that are used by the executable file. - - - - Determines whether the specified path is a valid filename and, optionally, if it exists. - The path. - if set to true check if file exists. - if set to true throw exception on error. - true if the specified path is a valid filename; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Validates the input as a valid filename and optionally checks for its existence. If valid, the property is - set to the validated absolute file path. - - The file path to validate. - if set to true check if the file exists. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - - Represents an action that shows a message box when a task is activated. Only available for Task Scheduler 2.0 on Windows Vista - or Windows Server 2003 and later.This action has been deprecated in Windows 8 and later. However, this - library is able to mimic its functionality using PowerShell if the property is - set to . To disable this conversion, set the value to . - - Display a message when the trigger fires using the ShowMessageAction. - - - - - - - - Creates a new unbound instance of . - - - Creates a new unbound instance of . - Message text that is displayed in the body of the message box. - Title of the message box. - - - Gets or sets the message text that is displayed in the body of the message box. - - - Gets or sets the title of the message box. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets a string representation of the . - String representation of this action. - - - Copies the properties from another the current instance. - The source . - - - Options for when to convert actions to PowerShell equivalents. - - - - Never convert any actions to PowerShell. This will force exceptions to be thrown when unsupported actions our action quantities - are found. - - - - - Convert actions under Version 1 of the library (Windows XP or Windows Server 2003 and earlier). This option supports multiple - actions of all types. If not specified, only a single is supported. Developer must ensure that - PowerShell v2 or higher is installed on the target computer. - - - - - Convert all and references to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - - Convert all actions regardless of version or operating system. - - - Collection that contains the actions that are performed by the task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets or sets the identifier of the principal for the task. - - - - Gets or sets the systems under which unsupported actions will be converted to PowerShell instances. - - The PowerShell platform options. - - This property will affect how many actions are physically stored in the system and is tied to the version of Task Scheduler. - - If set to , then no actions will ever be converted to PowerShell. This will - force exceptions to be thrown when unsupported actions our action quantities are found. - - - If set to , then actions will be converted only under Version 1 of the - library (Windows XP or Windows Server 2003 and earlier). This option supports multiple actions of all types. If not specified, - only a single is supported. Developer must ensure that PowerShell v2 or higher is installed on the - target computer. - - - If set to (which is the default value), then and references will be converted to their PowerShell equivalents on systems - on or after Windows 8 / Server 2012. - - - If set to , then any actions not supported by the Task Scheduler version will be - converted to PowerShell. - - - - - Gets or sets an XML-formatted version of the collection. - - - Gets the number of actions in the collection. - - - Gets or sets a specified action from the collection. - The . - The id ( ) of the action to be retrieved. - Specialized instance. - - - - Mismatching Id for action and lookup. - - - Gets or sets a an action at the specified index. - The zero-based index of the action to get or set. - - - Adds an action to the task. - A type derived from . - A derived class. - The bound that was added to the collection. - - - Adds an to the task. - Path to an executable file. - Arguments associated with the command-line operation. This value can be null. - - Directory that contains either the executable file or the files that are used by the executable file. This value can be null. - - The bound that was added to the collection. - - - Adds a new instance to the task. - Type of task to be created - Specialized instance. - - - Adds a collection of actions to the end of the . - - The actions to be added to the end of the . The collection itself cannot be null and cannot - contain null elements. - - is null. - - - Clears all actions from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified action type is contained in this collection. - Type of the action. - true if the specified action type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an array of , starting at a particular index. - - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - - - - Copies the elements of the to an array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Retrieves an enumeration of each of the actions. - - Returns an object that implements the interface and that can iterate through the - objects within the . - - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the action to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an action at the specified index. - The zero-based index at which action should be inserted. - The action to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the action at a specified index. - Index of action to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the actions in this collection. - A that represents the actions in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Functions to provide localized strings for enumerated types and values. - - - - - Gets a string representing the localized value of the provided enum. - - The enum value. - A localized string, if available. - - - - Pair of name and value. - - - - - Occurs when a property has changed. - - - - - Initializes a new instance of the class. - - - - - Gets or sets the name. - - - The name. - - - - - Gets or sets the value. - - - The value. - - - - - Clones this instance. - - A copy of an unbound . - - - - Determines whether the specified , is equal to this instance. - - The to compare with this instance. - - true if the specified is equal to this instance; otherwise, false. - - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - - Returns a hash code for this instance. - - - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Implements the operator implicit NameValuePair. - - The KeyValuePair. - - The result of the operator. - - - - - Contains a collection of name-value pairs. - - - - - Occurs when the collection has changed. - - - - - Occurs when a property has changed. - - - - - Copies current to another. - - The destination collection. - - - - Releases all resources used by this class. - - - - - Gets the number of items in the collection. - - - - - Gets a collection of the names. - - - The names. - - - - - Gets a collection of the values. - - - The values. - - - - - Gets the value of the item at the specified index. - - The index of the item being requested. - The value of the name-value pair at the specified index. - - - - Gets the value of the item with the specified name. - - Name to get the value for. - Value for the name, or null if not found. - - - - Adds an item to the . - - The object to add to the . - - - - Adds a name-value pair to the collection. - - The name associated with a value in a name-value pair. - The value associated with a name in a name-value pair. - - - - Adds the elements of the specified collection to the end of . - - The collection of whose elements should be added to the end of . - - - - Clears the entire collection of name-value pairs. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Removes the name-value pair with the specified key from the collection. - - The name associated with a value in a name-value pair. - true if item successfully removed; false otherwise. - - - - Removes a selected name-value pair from the collection. - - Index of the pair to remove. - - - - Gets the value associated with the specified name. - - The name whose value to get. - When this method returns, the value associated with the specified name, if the name is found; otherwise, null. This parameter is passed uninitialized. - true if the collection contains an element with the specified name; otherwise, false. - - - - Gets the collection enumerator for the name-value collection. - - An for the collection. - - - - Abstract class for throwing a method specific exception. - - - - Defines the minimum supported version for the action not allowed by this exception. - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Gets a message that describes the current exception. - - - - - Gets the minimum supported TaskScheduler version required for this method or property. - - - - - Gets the object data. - - The information. - The context. - - - - Thrown when the calling method is not supported by Task Scheduler 1.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Initializes a new instance of the class. - - The message. - - - - Thrown when the calling method is not supported by Task Scheduler 2.0. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - Thrown when the calling method is not supported by Task Scheduler versions prior to the one specified. - - - - - Initializes a new instance of the class. - - The serialization information. - The streaming context. - - - - A strongly-typed resource class, for looking up localized strings, etc. - - - - - Returns the cached ResourceManager instance used by this class. - - - - - Overrides the current thread's CurrentUICulture property for all - resource lookups using this strongly typed resource class. - - - - - Looks up a localized string similar to Call a COM object. - - - - - Looks up a localized string similar to Start a program. - - - - - Looks up a localized string similar to Send an e-mail. - - - - - Looks up a localized string similar to Display a message. - - - - - Looks up a localized string similar to {3} {0:P}. - - - - - Looks up a localized string similar to every day. - - - - - Looks up a localized string similar to {1} {0}. - - - - - Looks up a localized string similar to .. - - - - - Looks up a localized string similar to The date and time a trigger expires must be later than the time time it starts or is activated.. - - - - - Looks up a localized string similar to {0} {1}. - - - - - Looks up a localized string similar to -. - - - - - Looks up a localized string similar to ,. - - - - - Looks up a localized string similar to every month. - - - - - Looks up a localized string similar to Multiple actions defined. - - - - - Looks up a localized string similar to Multiple triggers defined. - - - - - Looks up a localized string similar to {0}. - - - - - Looks up a localized string similar to Author. - - - - - Looks up a localized string similar to Disabled. - - - - - Looks up a localized string similar to Queued. - - - - - Looks up a localized string similar to Ready. - - - - - Looks up a localized string similar to Running. - - - - - Looks up a localized string similar to Unknown. - - - - - Looks up a localized string similar to any user. - - - - - Looks up a localized string similar to At system startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to At {0:t} every day. - - - - - Looks up a localized string similar to At {0:t} every {1} days. - - - - - Looks up a localized string similar to indefinitely. - - - - - Looks up a localized string similar to for a duration of {0}. - - - - - Looks up a localized string similar to for {0}. - - - - - Looks up a localized string similar to Trigger expires at {0:G}.. - - - - - Looks up a localized string similar to Custom event filter. - - - - - Looks up a localized string similar to On event - Log: {0}. - - - - - Looks up a localized string similar to , Source: {0}. - - - - - Looks up a localized string similar to , EventID: {0}. - - - - - Looks up a localized string similar to When computer is idle. - - - - - Looks up a localized string similar to At log on of {0}. - - - - - Looks up a localized string similar to At {0:t} on day {1} of {2}, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} on {1} {2:f} each {3}, starting {0:d}. - - - - - Looks up a localized string similar to When the task is created or modified. - - - - - Looks up a localized string similar to After triggered, repeat every {0} {1}.. - - - - - Looks up a localized string similar to Every {0} {1}.. - - - - - Looks up a localized string similar to On local connection to {0}.. - - - - - Looks up a localized string similar to On local disconnect from {0}.. - - - - - Looks up a localized string similar to On remote connection to {0}.. - - - - - Looks up a localized string similar to On remote disconnect from {0}.. - - - - - Looks up a localized string similar to On workstation lock of {0}.. - - - - - Looks up a localized string similar to On workstation unlock of {0}.. - - - - - Looks up a localized string similar to user session of {0}. - - - - - Looks up a localized string similar to At {0:t} on {0:d}. - - - - - Looks up a localized string similar to At startup. - - - - - Looks up a localized string similar to Custom Trigger. - - - - - Looks up a localized string similar to Daily. - - - - - Looks up a localized string similar to On an event. - - - - - Looks up a localized string similar to On idle. - - - - - Looks up a localized string similar to At log on. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to Monthly. - - - - - Looks up a localized string similar to At task creation/modification. - - - - - Looks up a localized string similar to On state change. - - - - - Looks up a localized string similar to One time. - - - - - Looks up a localized string similar to Weekly. - - - - - Looks up a localized string similar to At {0:t} every {1} of every week, starting {0:d}. - - - - - Looks up a localized string similar to At {0:t} every {1} of every {2} weeks, starting {0:d}. - - - - - Looks up a localized string similar to every. - - - - - Looks up a localized string similar to fifth. - - - - - Looks up a localized string similar to first. - - - - - Looks up a localized string similar to fourth. - - - - - Looks up a localized string similar to last. - - - - - Looks up a localized string similar to second. - - - - - Looks up a localized string similar to third. - - - - - Some string values of properties can be set to retrieve their value from existing DLLs as a resource. This class facilitates creating those reference strings. - - - - - Initializes a new instance of the class. - - The DLL path. - The resource identifier. - - - - Gets or sets the resource file path. This can be a relative path, full path or lookup path (e.g. %SystemRoot%\System32\ResourceName.dll). - - - The resource file path. - - - - - Gets or sets the resource identifier. - - The resource identifier. - - - - Performs an implicit conversion from to . - - The value. - The result of the conversion. - - - - Parses the input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - A new instance on success or null on failure. - is null - is not in the format "$(@ [Dll], [ResourceID])" - - - - Tries to parse to input string. String must be in the format "$(@ [Dll], [ResourceID])". - - The input string value. - The resource reference to be returned. On failure, this value equals null. - A new instance on success or null on failure. - - - - Gets the result of pulling the string from the resource file using the identifier. - - from resource file. - cannot be found. - Unable to load or string identified by . - - - - Returns a in the format required by the Task Scheduler to reference a string in a DLL. - - A formatted in the format $(@ [Dll], [ResourceID]). - - - Abstract class representing a secured item for storage in a . - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - Gets the path to the item. - The path to the item. - - - Gets the SDDL for the item. - The SDDL for the item. - - - Represents a instance and captures its name and security. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - - - - Represents all the information about the tasks and folders from a instance that can be used to reconstitute tasks and folders - on the same or different systems. This class and related classes are only available under the .NET 4.5.2 build and later .NET versions due to - dependencies on threading and compressed (zip) files. - - - - Creates a new instance of from an existing snapshot. - The zip file snapshot created by the method. - - - - Gets a list of and instances the represent the tasks and folders from a Task Scheduler instance. - - - - Gets the path of the file based snapshot. - - - Gets the machine name of the server from which the snapshot was taken. - The target server name. - - - Gets the UTC time stamp for when the snapshot was taken. - The time stamp. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method can take many seconds to execute. It is recommended to call the asynchronous - version.This method will execute without error even if the user does not have permissions to see all tasks and folders. - It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A instance with the contents of the specified Task Scheduler connection. - - - - Creates a compressed zip file that contains all the information accessible to the user from the instance necessary to - reconstitute its tasks and folders. This method will execute without error even if the user does not have permissions to see all - tasks and folders. It is imperative that the developer ensures that the user has Administrator or equivalent rights before calling this method. - - The from which to pull the tasks and folders. - The output zip file in which to place the snapshot information. - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance with the contents of the specified Task Scheduler connection. - - - Opens an existing snapshot and returns a new instance of . - The zip file snapshot created by the method. - A instance with the contents of the specified snapshot file. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of paths representing the tasks and folders from this snapshot that should be registered on the instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - A cancellation token to use to cancel this asynchronous operation. - An optional instance to use to report progress of the asynchronous operation. - An asynchronous instance. - - - Register a list of snapshot items (tasks and folders) into the specified Task Scheduler. - The into which the tasks and folders are registered. - - The list of instances representing the tasks and folders from this snapshot that should be registered on the - instance. - - - If true, takes the access rights from the snapshot item and applies it to both new and existing tasks and folders. - - - If true, overwrite any existing tasks and folders found in the target Task Scheduler that match the path of the snapshot item. - - - Lookup table for password. Provide pairs of the user/group account name and the associated passwords for any task that requires a password. - - - - Represents a instance and captures its details. - - - Initializes a new instance of the class. - The path to the item. - The SDDL for the item. - If set to true task is enabled. - The XML for the . - - - Gets a value indicating whether th is enabled. - true if enabled; otherwise, false. - - - Gets the XML. - The XML. - - - Defines what versions of Task Scheduler or the AT command that the task is compatible with. - - - The task is compatible with the AT command. - - - - The task is compatible with Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - Items not available when compared to V2: - - - TaskDefinition.Principal.GroupId - All account information can be retrieved via the UserId property. - - - TaskLogonType values Group, None and S4U are not supported. - - - TaskDefinition.Principal.RunLevel == TaskRunLevel.Highest is not supported. - - - - Assigning access security to a task is not supported using TaskDefinition.RegistrationInfo.SecurityDescriptorSddlForm or in RegisterTaskDefinition. - - - - - TaskDefinition.RegistrationInfo.Documentation, Source, URI and Version properties are only supported using this library. See - details in the remarks for . - - - - TaskDefinition.Settings.AllowDemandStart cannot be false. - - - TaskDefinition.Settings.AllowHardTerminate cannot be false. - - - TaskDefinition.Settings.MultipleInstances can only be IgnoreNew. - - - TaskDefinition.Settings.NetworkSettings cannot have any values. - - - TaskDefinition.Settings.RestartCount can only be 0. - - - TaskDefinition.Settings.StartWhenAvailable can only be false. - - - - TaskDefinition.Actions can only contain ExecAction instances unless the TaskDefinition.Actions.PowerShellConversion property has - the Version1 flag set. - - - - - TaskDefinition.Triggers cannot contain CustomTrigger, EventTrigger, SessionStateChangeTrigger, or RegistrationTrigger instances. - - - - TaskDefinition.Triggers cannot contain instances with delays set. - - - TaskDefinition.Triggers cannot contain instances with ExecutionTimeLimit or Id properties set. - - - TaskDefinition.Triggers cannot contain LogonTriggers instances with the UserId property set. - - - TaskDefinition.Triggers cannot contain MonthlyDOWTrigger instances with the RunOnLastWeekOfMonth property set to true. - - - TaskDefinition.Triggers cannot contain MonthlyTrigger instances with the RunOnDayWeekOfMonth property set to true. - - - - - - - The task is compatible with Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - This version is the baseline for the new, non-file based Task Scheduler. See remarks for - functionality that was not forward-compatible. - - - - - - The task is compatible with Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - Changes from V2: - - - TaskDefinition.Principal.ProcessTokenSidType can be defined as a value other than Default. - - - - TaskDefinition.Actions may not contain EmailAction or ShowMessageAction instances unless the - TaskDefinition.Actions.PowerShellConversion property has the Version2 flag set. - - - - TaskDefinition.Principal.RequiredPrivileges can have privilege values assigned. - - - TaskDefinition.Settings.DisallowStartOnRemoteAppSession can be set to true. - - - TaskDefinition.UseUnifiedSchedulingEngine can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - Changes from V2_1: - - - - TaskDefinition.Settings.MaintenanceSettings can have Period or Deadline be values other than TimeSpan.Zero or the Exclusive - property set to true. - - - - TaskDefinition.Settings.Volatile can be set to true. - - - - - - - The task is compatible with Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - Changes from V2_2: - - - None published. - - - - - - Defines how the Task Scheduler service creates, updates, or disables the task. - - - The Task Scheduler service registers the task as a new task. - - - - The Task Scheduler service either registers the task as a new task or as an updated version if the task already exists. - Equivalent to Create | Update. - - - - - The Task Scheduler service registers the disabled task. A disabled task cannot run until it is enabled. For more information, - see Enabled Property of TaskSettings and Enabled Property of RegisteredTask. - - - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. When the - TaskFolder.RegisterTaskDefinition or TaskFolder.RegisterTask functions are called with this flag to update a task, the Task - Scheduler service does not add the ACE for the new context principal and does not remove the ACE from the old context principal. - - - - - The Task Scheduler service creates the task, but ignores the registration triggers in the task. By ignoring the registration - triggers, the task will not execute when it is registered unless a time-based trigger causes it to execute on registration. - - - - - The Task Scheduler service registers the task as an updated version of an existing task. When a task with a registration trigger - is updated, the task will execute after the update occurs. - - - - - The Task Scheduler service checks the syntax of the XML that describes the task but does not register the task. This constant - cannot be combined with the Create, Update, or CreateOrUpdate values. - - - - Defines how the Task Scheduler handles existing instances of the task when it starts a new instance of the task. - - - Starts new instance while an existing instance is running. - - - Starts a new instance of the task after all other instances of the task are complete. - - - Does not start a new instance if an existing instance of the task is running. - - - Stops an existing instance of the task before it starts a new instance. - - - Defines what logon technique is required to run a task. - - - The logon method is not specified. Used for non-NT credentials. - - - Use a password for logging on the user. The password must be supplied at registration time. - - - - Use an existing interactive token to run a task. The user must log on using a service for user (S4U) logon. When an S4U logon is - used, no password is stored by the system and there is no access to either the network or to encrypted files. - - - - User must already be logged on. The task will be run only in an existing interactive session. - - - Group activation. The groupId field specifies the group. - - - - Indicates that a Local System, Local Service, or Network Service account is being used as a security context to run the task. - - - - - First use the interactive token. If the user is not logged on (no interactive token is available), then the password is used. - The password must be specified when a task is registered. This flag is not recommended for new tasks because it is less reliable - than Password. - - - - Defines which privileges must be required for a secured task. - - - Required to create a primary token. User Right: Create a token object. - - - Required to assign the primary token of a process. User Right: Replace a process-level token. - - - Required to lock physical pages in memory. User Right: Lock pages in memory. - - - Required to increase the quota assigned to a process. User Right: Adjust memory quotas for a process. - - - Required to read unsolicited input from a terminal device. User Right: Not applicable. - - - Required to create a computer account. User Right: Add workstations to domain. - - - - This privilege identifies its holder as part of the trusted computer base. Some trusted protected subsystems are granted this - privilege. User Right: Act as part of the operating system. - - - - - Required to perform a number of security-related functions, such as controlling and viewing audit messages. This privilege - identifies its holder as a security operator. User Right: Manage auditing and the security log. - - - - - Required to take ownership of an object without being granted discretionary access. This privilege allows the owner value to be - set only to those values that the holder may legitimately assign as the owner of an object. User Right: Take ownership of files - or other objects. - - - - Required to load or unload a device driver. User Right: Load and unload device drivers. - - - Required to gather profiling information for the entire system. User Right: Profile system performance. - - - Required to modify the system time. User Right: Change the system time. - - - Required to gather profiling information for a single process. User Right: Profile single process. - - - Required to increase the base priority of a process. User Right: Increase scheduling priority. - - - Required to create a paging file. User Right: Create a pagefile. - - - Required to create a permanent object. User Right: Create permanent shared objects. - - - - Required to perform backup operations. This privilege causes the system to grant all read access control to any file, regardless - of the access control list (ACL) specified for the file. Any access request other than read is still evaluated with the ACL. - This privilege is required by the RegSaveKey and RegSaveKeyExfunctions. The following access rights are granted if this - privilege is held: READ_CONTROL, ACCESS_SYSTEM_SECURITY, FILE_GENERIC_READ, FILE_TRAVERSE. User Right: Back up files and directories. - - - - - Required to perform restore operations. This privilege causes the system to grant all write access control to any file, - regardless of the ACL specified for the file. Any access request other than write is still evaluated with the ACL. Additionally, - this privilege enables you to set any valid user or group security identifier (SID) as the owner of a file. This privilege is - required by the RegLoadKey function. The following access rights are granted if this privilege is held: WRITE_DAC, WRITE_OWNER, - ACCESS_SYSTEM_SECURITY, FILE_GENERIC_WRITE, FILE_ADD_FILE, FILE_ADD_SUBDIRECTORY, DELETE. User Right: Restore files and directories. - - - - Required to shut down a local system. User Right: Shut down the system. - - - Required to debug and adjust the memory of a process owned by another account. User Right: Debug programs. - - - Required to generate audit-log entries. Give this privilege to secure servers. User Right: Generate security audits. - - - - Required to modify the nonvolatile RAM of systems that use this type of memory to store configuration information. User Right: - Modify firmware environment values. - - - - - Required to receive notifications of changes to files or directories. This privilege also causes the system to skip all - traversal access checks. It is enabled by default for all users. User Right: Bypass traverse checking. - - - - Required to shut down a system by using a network request. User Right: Force shutdown from a remote system. - - - Required to undock a laptop. User Right: Remove computer from docking station. - - - - Required for a domain controller to use the LDAP directory synchronization services. This privilege allows the holder to read - all objects and properties in the directory, regardless of the protection on the objects and properties. By default, it is - assigned to the Administrator and LocalSystem accounts on domain controllers. User Right: Synchronize directory service data. - - - - - Required to mark user and computer accounts as trusted for delegation. User Right: Enable computer and user accounts to be - trusted for delegation. - - - - Required to enable volume management privileges. User Right: Manage the files on a volume. - - - - Required to impersonate. User Right: Impersonate a client after authentication. Windows XP/2000: This privilege is not - supported. Note that this value is supported starting with Windows Server 2003, Windows XP with SP2, and Windows 2000 with SP4. - - - - - Required to create named file mapping objects in the global namespace during Terminal Services sessions. This privilege is - enabled by default for administrators, services, and the local system account. User Right: Create global objects. Windows - XP/2000: This privilege is not supported. Note that this value is supported starting with Windows Server 2003, Windows XP with - SP2, and Windows 2000 with SP4. - - - - Required to access Credential Manager as a trusted caller. User Right: Access Credential Manager as a trusted caller. - - - Required to modify the mandatory integrity level of an object. User Right: Modify an object label. - - - - Required to allocate more memory for applications that run in the context of users. User Right: Increase a process working set. - - - - Required to adjust the time zone associated with the computer's internal clock. User Right: Change the time zone. - - - Required to create a symbolic link. User Right: Create symbolic links. - - - - Defines the types of process security identifier (SID) that can be used by tasks. These changes are used to specify the type of - process SID in the IPrincipal2 interface. - - - - No changes will be made to the process token groups list. - - - - A task SID that is derived from the task name will be added to the process token groups list, and the token default - discretionary access control list (DACL) will be modified to allow only the task SID and local system full control and the - account SID read control. - - - - A Task Scheduler will apply default settings to the task process. - - - Defines how a task is run. - - - The task is run with all flags ignored. - - - The task is run as the user who is calling the Run method. - - - The task is run regardless of constraints such as "do not run on batteries" or "run only if idle". - - - The task is run using a terminal server session identifier. - - - The task is run using a security identifier. - - - Defines LUA elevation flags that specify with what privilege level the task will be run. - - - Tasks will be run with the least privileges. - - - Tasks will be run with the highest privileges. - - - - Defines what kind of Terminal Server session state change you can use to trigger a task to start. These changes are used to specify - the type of state change in the SessionStateChangeTrigger. - - - - - Terminal Server console connection state change. For example, when you connect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server console disconnection state change. For example, when you disconnect to a user session on the local computer by - switching users on the computer. - - - - - Terminal Server remote connection state change. For example, when a user connects to a user session by using the Remote Desktop - Connection program from a remote computer. - - - - - Terminal Server remote disconnection state change. For example, when a user disconnects from a user session while using the - Remote Desktop Connection program from a remote computer. - - - - - Terminal Server session locked state change. For example, this state change causes the task to run when the computer is locked. - - - - - Terminal Server session unlocked state change. For example, this state change causes the task to run when the computer is unlocked. - - - - Options for use when calling the SetSecurityDescriptorSddlForm methods. - - - No special handling. - - - The Task Scheduler service is prevented from adding the allow access-control entry (ACE) for the context principal. - - - Defines the different states that a registered task can be in. - - - The state of the task is unknown. - - - - The task is registered but is disabled and no instances of the task are queued or running. The task cannot be run until it is enabled. - - - - Instances of the task are queued. - - - The task is ready to be executed, but no instances are queued or running. - - - One or more instances of the task is running. - - - - Specifies how the Task Scheduler performs tasks when the computer is in an idle condition. For information about idle conditions, - see Task Idle Conditions. - - - - Occurs when a property value changes. - - - - Gets or sets a value that indicates the amount of time that the computer must be in an idle state before the task is run. - - - A value that indicates the amount of time that the computer must be in an idle state before the task is run. The minimum value - is one minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 10 minutes. - - - - - Gets or sets a Boolean value that indicates whether the task is restarted when the computer cycles into an idle condition more - than once. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will terminate the task if the idle condition ends before - the task is completed. - - - - - Gets or sets a value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. If no - value is specified for this property, then the Task Scheduler service will wait indefinitely for an idle condition to occur. - - - A value that indicates the amount of time that the Task Scheduler will wait for an idle condition to occur. The minimum time - allowed is 1 minute. If this value is TimeSpan.Zero, then the delay will be set to the default of 1 hour. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Specifies the task settings the Task scheduler will use to start task during Automatic maintenance. - - - Occurs when a property value changes. - - - - Gets or sets the amount of time after which the Task scheduler attempts to run the task during emergency Automatic maintenance, - if the task failed to complete during regular Automatic maintenance. The minimum value is one day. The value of the property should be greater than the value of the property. If the deadline is not - specified the task will not be started during emergency Automatic maintenance. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a value indicating whether the Task Scheduler must start the task during the Automatic maintenance in exclusive - mode. The exclusivity is guaranteed only between other maintenance tasks and doesn't grant any ordering priority of the task. If - exclusivity is not specified, the task is started in parallel with other maintenance tasks. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets the amount of time the task needs to be started during Automatic maintenance. The minimum value is one minute. - - Property set for a task on a Task Scheduler version prior to 2.2. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to obtain a network profile. - - - Occurs when a property value changes. - - - Gets or sets a GUID value that identifies a network profile. - Not supported under Task Scheduler 1.0. - - - Gets or sets the name of a network profile. The name is used for display purposes. - Not supported under Task Scheduler 1.0. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the methods to get information from and control a running task. - - - Gets the process ID for the engine (process) which is running the task. - Not supported under Task Scheduler 1.0. - - - Gets the name of the current action that the running task is performing. - - - Gets the GUID identifier for this instance of the task. - - - Gets the operational state of the running task. - - - Releases all resources used by this class. - - - Refreshes all of the local instance variables of the task. - Thrown if task is no longer running. - - - - Provides the methods that are used to run the task immediately, get any running instances of the task, get or set the credentials - that are used to register the task, and the properties that describe the task. - - - - Occurs when a property value changes. - - - Gets the definition of the task. - - - Gets or sets a Boolean value that indicates if the registered task is enabled. - - As of version 1.8.1, under V1 systems (prior to Vista), this property will immediately update the Disabled state and re-save the - current task. If changes have been made to the , then those changes will be saved. - - - - Gets an instance of the parent folder. - A object representing the parent folder of this task. - - - Gets a value indicating whether this task instance is active. - true if this task instance is active; otherwise, false. - - - Gets the time the registered task was last run. - Returns if there are no prior run times. - - - Gets the results that were returned the last time the registered task was run. - The value returned is the last exit code of the last program run via an . - - - - - - - - Gets the time when the registered task is next scheduled to run. - Returns if there are no future run times. - - Potentially breaking change in release 1.8.2. For Task Scheduler 2.0, the return value prior to 1.8.2 would be Dec 30, 1899 if - there were no future run times. For 1.0, that value would have been DateTime.MinValue. In release 1.8.2 and later, all - versions will return DateTime.MinValue if there are no future run times. While this is different from the native 2.0 - library, it was deemed more appropriate to have consistency between the two libraries and with other .NET libraries. - - - - - Gets a value indicating whether this task is read only. Only available if is true. - - true if read only; otherwise, false. - - - Gets or sets the security descriptor for the task. - The security descriptor. - - - Gets the operational state of the registered task. - - - Gets or sets the that manages this task. - The task service. - - - Gets the name of the registered task. - - - Gets the number of times the registered task has missed a scheduled run. - Not supported under Task Scheduler 1.0. - - - Gets the path to where the registered task is stored. - - - Gets the XML-formatted registration information for the registered task. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - Releases all resources used by this class. - - - Exports the task to the specified file in XML. - Name of the output file. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - A object that encapsulates the access control rules for the current task. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task - described by the current object. - - - One of the values that specifies which group of access control - entries to retrieve. - - A object that encapsulates the access control rules for the current task. - - - Gets all instances of the currently running registered task. - A with all instances of current task. - Not supported under Task Scheduler 1.0. - - - - Gets the last registration time, looking first at the value and then looking for the - most recent registration event in the Event Log. - - of the last registration or if no value can be found. - - - Gets the times that the registered task is scheduled to run during a specified time. - The starting time for the query. - The ending time for the query. - The requested number of runs. A value of 0 will return all times requested. - The scheduled times that the task will run. - - - Gets the security descriptor for the task. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the task. - Not supported under Task Scheduler 1.0. - - - - Updates the task with any changes made to the by calling from the currently registered folder using the currently - registered name. - - Thrown if task was previously registered with a password. - - - Runs the registered task immediately. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - Run() - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - - - - - - Runs the registered task immediately using specified flags and a session identifier. - Defines how the task is run. - - The terminal server session in which you want to start the task. - - If the value is not passed into the parameter, then the value - specified in this parameter is ignored.If the value is passed into the flags parameter - and the sessionID value is less than or equal to 0, then an invalid argument error will be returned. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if no value is specified for the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is logged on to the specified session. - - - If the value is passed into the parameter and the sessionID - value is a valid session ID greater than 0 and if a user is specified in the user parameter, then the Task Scheduler service - will try to start the task interactively as the user who is specified in the user parameter. - - - The user for which the task runs. - - - The parameters used as values in the task actions. A maximum of 32 parameters can be supplied. To run a task with no parameters, - call this method without any values (e.g. - RunEx(0, 0, "MyUserName") - ). - - - The string values that you specify are paired with names and stored as name-value pairs. If you specify a single string value, - then Arg0 will be the name assigned to the value. The value can be used in the task action where the $(Arg0) variable is used in - the action properties. - - - If you pass in values such as "0", "100", and "250" as an array of string values, then "0" will replace the $(Arg0) variables, - "100" will replace the $(Arg1) variables, and "250" will replace the $(Arg2) variables used in the action properties. - - - For more information and a list of action properties that can use $(Arg0), $(Arg1), ..., $(Arg32) variables in their values, see - Task Actions. - - - A instance that defines the new instance of the task. - - - This method will return without error, but the task will not run if the AllowDemandStart property of ITaskSettings is set to - false for the task. - - If RunEx is invoked from a disabled task, it will return null and the task will not be run. - - Not supported under Task Scheduler 1.0. - - - - - - - - - Applies access control list (ACL) entries described by a object to the file described by the current - object. - - - A object that describes an access control list (ACL) entry to apply to the current task. - - - Give read access to all authenticated users for a task. - - - - - - - Sets the security descriptor for the task. Not available to Task Scheduler 1.0. - The security descriptor for the task. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - Dynamically tries to load the assembly for the editor and displays it as editable for this task. - true if editor returns with OK response; false otherwise. - - The Microsoft.Win32.TaskSchedulerEditor.dll assembly must reside in the same directory as the Microsoft.Win32.TaskScheduler.dll - or in the GAC. - - - - Shows the property page for the task (v1.0 only). - - - Stops the registered task immediately. - - The Stop method stops all instances of the task. - - System account users can stop a task, users with Administrator group privileges can stop a task, and if a user has rights to - execute and read a task, then the user can stop the task. A user can stop the task instances that are running under the same - credentials as the user account. In all other cases, the user is denied access to stop the task. - - - - - Returns a that represents this instance. - A that represents this instance. - - - - Gets the ITaskDefinition for a V2 task and prevents the errors that come when connecting remotely to a higher version of the - Task Scheduler. - - The local task service. - The task instance. - if set to true this method will throw an exception if unable to get the task definition. - A valid ITaskDefinition that should not throw errors on the local instance. - Unable to get a compatible task definition for this version of the library. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Contains information about the compatibility of the current configuration with a specified version. - - - Gets the compatibility level. - The compatibility level. - - - Gets the property name with the incompatibility. - The property name. - - - Gets the reason for the incompatibility. - The reason. - - - Defines all the components of a task, such as the task settings, triggers, actions, and registration information. - - - Occurs when a property value changes. - - - Gets a collection of actions that are performed by the task. - - - - Gets or sets the data that is associated with the task. This data is ignored by the Task Scheduler service, but is used by - third-parties who wish to extend the task format. - - - For V1 tasks, this library makes special use of the SetWorkItemData and GetWorkItemData methods and does not expose that data - stream directly. Instead, it uses that data stream to hold a dictionary of properties that are not supported under V1, but can - have values under V2. An example of this is the value which is stored in the data stream. - - The library does not provide direct access to the V1 work item data. If using V2 properties with a V1 task, programmatic access - to the task using the native API will retrieve unreadable results from GetWorkItemData and will eliminate those property values - if SetWorkItemData is used. - - - - - Gets the lowest supported version that supports the settings for this . - - - Gets a collection of triggers that are used to start a task. - - - Gets or sets the XML-formatted definition of the task. - - - Gets the principal for the task that provides the security credentials for the task. - - - - Gets a class instance of registration information that is used to describe a task, such as the description of the task, the - author of the task, and the date the task is registered. - - - - Gets the settings that define how the Task Scheduler service performs the task. - - - Gets the XML Schema file for V1 tasks. - The for V1 tasks. - An object containing the XML Schema for V1 tasks. - - - - Determines whether this can use the Unified Scheduling Engine or if it contains unsupported properties. - - - if set to true throws an with details about unsupported properties in the Data - property of the exception. - - - true if this can use the Unified Scheduling Engine; otherwise, false. - - - Releases all resources used by this class. - - - Validates the current . - - if set to true throw a with details about invalid properties. - - true if current is valid; false if not. - - - Gets the lowest supported version. - The output list. - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Provides the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - - - Occurs when a property value changes. - - - - Gets the account associated with this principal. This value is pulled from the TaskDefinition's XMLText property if set. - - The account. - - - Gets or sets the name of the principal that is displayed in the Task Scheduler UI. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the identifier of the user group that is required to run the tasks that are associated with the principal. Setting - this property to something other than a null or empty string, will set the property to NULL and will set - the property to TaskLogonType.Group; - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier of the principal. - Not supported under Task Scheduler 1.0. - - - Gets or sets the security logon method that is required to run the tasks that are associated with the principal. - - TaskLogonType values of Group, None, or S4UNot are not supported under Task Scheduler 1.0. - - - - Gets or sets the task process security identifier (SID) type. - One of the enumeration constants. - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - Not supported under Task Scheduler versions prior to 2.1. - - - - Gets the security credentials for a principal. These security credentials define the security context for the tasks that are - associated with the principal. - - Setting this value appears to break the Task Scheduler MMC and does not output in XML. Removed to prevent problems. - - - - Gets or sets the identifier that is used to specify the privilege level that is required to run the tasks that are associated - with the principal. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets the user identifier that is required to run the tasks that are associated with the principal. Setting this property - to something other than a null or empty string, will set the property to NULL; - - - - Validates the supplied account against the supplied . - The user or group account name. - The SID type for the process. - true if supplied account can be used for the supplied SID type. - - - Releases all resources used by this class. - - - Gets a value indicating whether current Principal settings require a password to be provided. - true if settings requires a password to be provided; otherwise, false. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - List of security credentials for a principal under version 1.3 of the Task Scheduler. These security credentials define the security - context for the tasks that are associated with the principal. - - - - Gets the number of elements contained in the . - The number of elements contained in the . - - - Gets a value indicating whether the is read-only. - true if the is read-only; otherwise, false. - - - Gets or sets the element at the specified index. - The element at the specified index. - is not a valid index in the . - - The property is set and the is read-only. - - - - Adds an item to the . - The object to add to the . - The is read-only. - - - Determines whether the contains a specific value. - The object to locate in the . - - true if is found in the ; otherwise, false. - - - - Copies to. - The array. - Index of the array. - - - Returns an enumerator that iterates through the collection. - A that can be used to iterate through the collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Removes all items from the . - The is read-only. - - - Inserts an item to the at the specified index. - The zero-based index at which should be inserted. - The object to insert into the . - is not a valid index in the . - The is read-only. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; - otherwise, false. This method also returns false if is not found in the original . - - The is read-only. - - - Removes the item at the specified index. - The zero-based index of the item to remove. - is not a valid index in the . - The is read-only. - - - Enumerates the privileges set for a principal under version 1.3 of the Task Scheduler. - - - Gets the element in the collection at the current position of the enumerator. - The element in the collection at the current position of the enumerator. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Advances the enumerator to the next element of the collection. - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - The collection was modified after the enumerator was created. - - - Sets the enumerator to its initial position, which is before the first element in the collection. - The collection was modified after the enumerator was created. - - - - Provides the administrative information that can be used to describe the task. This information includes details such as a - description of the task, the author of the task, the date the task is registered, and the security descriptor of the task. - - - - Occurs when a property value changes. - - - Gets or sets the author of the task. - - - Gets or sets the date and time when the task is registered. - - - Gets or sets the description of the task. - - - Gets or sets any additional documentation for the task. - - - Gets or sets the security descriptor of the task. - The security descriptor. - - - Gets or sets the security descriptor of the task. - Not supported under Task Scheduler 1.0. - - - - Gets or sets where the task originated from. For example, a task may originate from a component, service, application, or user. - - - - Gets or sets the URI of the task. - - Note: Breaking change in version 2.0. This property was previously of type . It was found that in - Windows 8, many of the native tasks use this property in a string format rather than in a URI format. - - - - Gets or sets the version number of the task. - - - Gets or sets an XML-formatted version of the registration information for the task. - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Provides the settings that the Task Scheduler service uses to perform the task. - - - Occurs when a property value changes. - - - - Gets or sets a Boolean value that indicates that the task can be started by using either the Run command or the Context menu. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task may be terminated by using TerminateProcess. - Not supported under Task Scheduler 1.0. - - - Gets or sets an integer value that indicates which version of Task Scheduler a task is compatible with. - Not supported under Task Scheduler 1.0. - - - - Gets or sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. If no value is - specified for this property, then the Task Scheduler service will not delete the task. - - - Gets and sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. A TimeSpan value - of 1 second indicates the task is set to delete when done. A value of TimeSpan.Zero indicates that the task should not be deleted. - - - A task expires after the end boundary has been exceeded for all triggers associated with the task. The end boundary for a - trigger is specified by the EndBoundary property of all trigger types. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the computer is running on battery power. - - - - - Gets or sets a Boolean value that indicates that the task will not be started if the task is triggered to run in a Remote - Applications Integrated Locally (RAIL) session. - - Property set for a task on a Task Scheduler version prior to 2.1. - - - - Gets or sets a Boolean value that indicates that the task is enabled. The task can be performed only when this setting is TRUE. - - - - - Gets or sets the amount of time that is allowed to complete the task. By default, a task will be stopped 72 hours after it - starts to run. - - - The amount of time that is allowed to complete the task. When this parameter is set to , the - execution time limit is infinite. - - - If a task is started on demand, the ExecutionTimeLimit setting is bypassed. Therefore, a task that is started on demand will not - be terminated if it exceeds the ExecutionTimeLimit. - - - - Gets or sets a Boolean value that indicates that the task will not be visible in the UI by default. - - - Gets or sets the information that the Task Scheduler uses during Automatic maintenance. - - - Gets or sets the policy that defines how the Task Scheduler handles multiple instances of the task. - Not supported under Task Scheduler 1.0. - - - Gets or sets the priority level of the task. - The priority. - Value set to AboveNormal or BelowNormal on Task Scheduler 1.0. - - - Gets or sets the number of times that the Task Scheduler will attempt to restart the task. - - The number of times that the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that specifies how long the Task Scheduler will attempt to restart the task. - - A value that specifies how long the Task Scheduler will attempt to restart the task. If this property is set, the property must also be set. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - Not supported under Task Scheduler 1.0. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only if the user is logged on (v1.0 only) - - Property set for a task on a Task Scheduler version other than 1.0. - - - Gets or sets a Boolean value that indicates that the Task Scheduler will run the task only when a network is available. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task will be stopped if the computer switches to battery power. - - - Gets or sets a Boolean value that indicates that the Unified Scheduling Engine will be utilized to run this task. - Property set for a task on a Task Scheduler version prior to 2.1. - - - Gets or sets a boolean value that indicates whether the task is automatically disabled every time Windows starts. - Property set for a task on a Task Scheduler version prior to 2.2. - - - - Gets or sets a Boolean value that indicates that the Task Scheduler will wake the computer when it is time to run the task. - - - - Gets or sets an XML-formatted definition of the task settings. - - - - Gets or sets the information that specifies how the Task Scheduler performs tasks when the computer is in an idle state. - - - - - Gets or sets the network settings object that contains a network profile identifier and name. If the RunOnlyIfNetworkAvailable - property of ITaskSettings is true and a network profile is specified in the NetworkSettings property, then the task will run - only if the specified network profile is available. - - - - Releases all resources used by this class. - - - Returns a that represents this instance. - A that represents this instance. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Collection of running tasks in a . This class has no public constructor and can only be accessed via the - properties and functions within . - - - - Gets the number of registered tasks in the collection. - - - Gets the specified running task from the collection. - The index of the running task to be retrieved. - A instance. - - - Releases all resources used by this class. - - - Gets an IEnumerator instance for this collection. - An enumerator. - - - Returns a that represents this instance. - A that represents this instance. - - - Releases all resources used by this class. - - - - Contains all the tasks that are registered within a . This class has no public constructor and can only be - accessed via the properties and functions within . - - - Potentially breaking change in 1.6.2 and later where under V1 the list previously included the '.job' extension on the task name. - This has been removed so that it is consistent with V2. - - - public class Program - { - bool RootFolderHasTask(string taskName) - { - if (TaskService.Instance.RootFolder.Tasks.Count > 0) - { - return TaskService.Instance.RootFolder.Tasks.Exists(taskName); - } - return false; - } - - TaskCollection GetRootTasksStartingWith(string value) - { - var pattern = $"^{Regex.Escape(value)}.*$"; - return TaskService.Instance.RootFolder.GetTasks(new Regex(pattern)); - } - - public static void Main() - { - foreach (var task in GetRootTasksStartingWith("MyCo")) - if (RootFolderHasTask(task.Name)) - Console.WriteLine(task.Name); - } - } - - - - Gets the number of registered tasks in the collection. - - - Gets or sets the regular expression filter for task names. - The regular expression filter. - - - Gets the specified registered task from the collection. - The index of the registered task to be retrieved. - A instance that contains the requested context. - - - Gets the named registered task from the collection. - The name of the registered task to be retrieved. - A instance that contains the requested context. - - - Releases all resources used by this class. - - - Determines whether the specified task exists. - The name of the task. - true if task exists; otherwise, false. - - - Gets the collection enumerator for the register task collection. - An for this collection. - - - Returns a that represents this instance. - A that represents this instance. - - - Internal constructor - TaskService instance - The filter. - - - Retrieves the current task. See for more information. - - - Releases all resources used by this class. - - - Moves to the next task. See MoveNext for more information. - true if next task found, false if no more tasks. - - - Reset task enumeration. See Reset for more information. - - - - Changes to tasks and the engine that cause events. - - - - Task Scheduler started an instance of a task for a user. - For detailed information, see the documentation for Event ID 100 on TechNet. - - - Task Scheduler failed to start a task for a user. - For detailed information, see the documentation for Event ID 101 on TechNet. - - - Task Scheduler successfully finished an instance of a task for a user. - For detailed information, see the documentation for Event ID 102 on TechNet. - - - Task Scheduler failed to start an instance of a task for a user. - For detailed information, see the documentation for Event ID 103 on TechNet. - - - Task Scheduler failed to log on the user. - For detailed information, see the documentation for Event ID 104 on TechNet. - - - Task Scheduler failed to impersonate a user. - For detailed information, see the documentation for Event ID 105 on TechNet. - - - The a user registered the Task Scheduler a task. - For detailed information, see the documentation for Event ID 106 on TechNet. - - - Task Scheduler launched an instance of a task due to a time trigger. - For detailed information, see the documentation for Event ID 107 on TechNet. - - - Task Scheduler launched an instance of a task due to an event trigger. - For detailed information, see the documentation for Event ID 108 on TechNet. - - - Task Scheduler launched an instance of a task due to a registration trigger. - For detailed information, see the documentation for Event ID 109 on TechNet. - - - Task Scheduler launched an instance of a task for a user. - For detailed information, see the documentation for Event ID 110 on TechNet. - - - Task Scheduler terminated an instance of a task due to exceeding the time allocated for execution, as configured in the task definition. - For detailed information, see the documentation for Event ID 111 on TechNet. - - - Task Scheduler could not start a task because the network was unavailable. Ensure the computer is connected to the required network as specified in the task. - For detailed information, see the documentation for Event ID 112 on TechNet. - - - The Task Scheduler registered the a task, but not all the specified triggers will start the task. Ensure all the task triggers are valid. - For detailed information, see the documentation for Event ID 113 on TechNet. - - - Task Scheduler could not launch a task as scheduled. Instance is started now as required by the configuration option to start the task when available, if the scheduled time is missed. - For detailed information, see the documentation for Event ID 114 on TechNet. - - - Task Scheduler failed to roll back a transaction when updating or deleting a task. - For detailed information, see the documentation for Event ID 115 on TechNet. - - - Task Scheduler saved the configuration for a task, but the credentials used to run the task could not be stored. - For detailed information, see the documentation for Event ID 116 on TechNet. - - - Task Scheduler launched an instance of a task due to an idle condition. - For detailed information, see the documentation for Event ID 117 on TechNet. - - - Task Scheduler launched an instance of a task due to system startup. - For detailed information, see the documentation for Event ID 118 on TechNet. - - - Task Scheduler launched an instance of a task due to a user logon. - For detailed information, see the documentation for Event ID 119 on TechNet. - - - Task Scheduler launched an instance of a task due to a user connecting to the console. - For detailed information, see the documentation for Event ID 120 on TechNet. - - - Task Scheduler launched an instance of a task due to a user disconnecting from the console. - For detailed information, see the documentation for Event ID 121 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely connecting. - For detailed information, see the documentation for Event ID 122 on TechNet. - - - Task Scheduler launched an instance of a task due to a user remotely disconnecting. - For detailed information, see the documentation for Event ID 123 on TechNet. - - - Task Scheduler launched an instance of a task due to a user locking the computer. - For detailed information, see the documentation for Event ID 124 on TechNet. - - - Task Scheduler launched an instance of a task due to a user unlocking the computer. - For detailed information, see the documentation for Event ID 125 on TechNet. - - - Task Scheduler failed to execute a task. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 126 on TechNet. - - - Task Scheduler failed to execute a task due to a shutdown race condition. Task Scheduler is attempting to restart the task. - For detailed information, see the documentation for Event ID 127 on TechNet. - - - Task Scheduler did not launch a task because the current time exceeds the configured task end time. - For detailed information, see the documentation for Event ID 128 on TechNet. - - - Task Scheduler launched an instance of a task in a new process. - For detailed information, see the documentation for Event ID 129 on TechNet. - - - The Task Scheduler service failed to start a task due to the service being busy. - For detailed information, see the documentation for Event ID 130 on TechNet. - - - Task Scheduler failed to start a task because the number of tasks in the task queue exceeds the quota currently configured. - For detailed information, see the documentation for Event ID 131 on TechNet. - - - The Task Scheduler task launching queue quota is approaching its preset limit of tasks currently configured. - For detailed information, see the documentation for Event ID 132 on TechNet. - - - Task Scheduler failed to start a task in the task engine for a user. - For detailed information, see the documentation for Event ID 133 on TechNet. - - - Task Engine for a user is approaching its preset limit of tasks. - For detailed information, see the documentation for Event ID 134 on TechNet. - - - Task Scheduler did not launch a task because launch condition not met, machine not idle. - For detailed information, see the documentation for Event ID 135 on TechNet. - - - A user updated Task Scheduler a task - For detailed information, see the documentation for Event ID 140 on TechNet. - - - A user deleted Task Scheduler a task - For detailed information, see the documentation for Event ID 141 on TechNet. - - - A user disabled Task Scheduler a task - For detailed information, see the documentation for Event ID 142 on TechNet. - - - Task Scheduler woke up the computer to run a task. - For detailed information, see the documentation for Event ID 145 on TechNet. - - - Task Scheduler failed to subscribe the event trigger for a task. - For detailed information, see the documentation for Event ID 150 on TechNet. - - - Task Scheduler launched an action in an instance of a task. - For detailed information, see the documentation for Event ID 200 on TechNet. - - - Task Scheduler successfully completed a task instance and action. - For detailed information, see the documentation for Event ID 201 on TechNet. - - - Task Scheduler failed to complete an instance of a task with an action. - For detailed information, see the documentation for Event ID 202 on TechNet. - - - Task Scheduler failed to launch an action in a task instance. - For detailed information, see the documentation for Event ID 203 on TechNet. - - - Task Scheduler failed to retrieve the event triggering values for a task . The event will be ignored. - For detailed information, see the documentation for Event ID 204 on TechNet. - - - Task Scheduler failed to match the pattern of events for a task. The events will be ignored. - For detailed information, see the documentation for Event ID 205 on TechNet. - - - Task Scheduler is shutting down the a task engine. - For detailed information, see the documentation for Event ID 301 on TechNet. - - - Task Scheduler is shutting down the a task engine due to an error. - For detailed information, see the documentation for Event ID 303 on TechNet. - - - Task Scheduler sent a task to a task engine. - For detailed information, see the documentation for Event ID 304 on TechNet. - - - Task Scheduler did not send a task to a task engine. - For detailed information, see the documentation for Event ID 305 on TechNet. - - - For a Task Scheduler task engine, the thread pool failed to process the message. - For detailed information, see the documentation for Event ID 306 on TechNet. - - - The Task Scheduler service failed to connect to a task engine process. - For detailed information, see the documentation for Event ID 307 on TechNet. - - - Task Scheduler connected to a task engine process. - For detailed information, see the documentation for Event ID 308 on TechNet. - - - There are Task Scheduler tasks orphaned during a task engine shutdown. - For detailed information, see the documentation for Event ID 309 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 310 on TechNet. - - - Task Scheduler failed to start a task engine process due to an error. - For detailed information, see the documentation for Event ID 311 on TechNet. - - - Task Scheduler created the Win32 job object for a task engine. - For detailed information, see the documentation for Event ID 312 on TechNet. - - - The Task Scheduler channel is ready to send and receive messages. - For detailed information, see the documentation for Event ID 313 on TechNet. - - - Task Scheduler has no tasks running for a task engine, and the idle timer has started. - For detailed information, see the documentation for Event ID 314 on TechNet. - - - A task engine process failed to connect to the Task Scheduler service. - For detailed information, see the documentation for Event ID 315 on TechNet. - - - A task engine failed to send a message to the Task Scheduler service. - For detailed information, see the documentation for Event ID 316 on TechNet. - - - Task Scheduler started a task engine process. - For detailed information, see the documentation for Event ID 317 on TechNet. - - - Task Scheduler shut down a task engine process. - For detailed information, see the documentation for Event ID 318 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to launch a task. - For detailed information, see the documentation for Event ID 319 on TechNet. - - - A task engine received a message from the Task Scheduler service requesting to stop a task instance. - For detailed information, see the documentation for Event ID 320 on TechNet. - - - Task Scheduler did not launch a task because an instance of the same task is already running. - For detailed information, see the documentation for Event ID 322 on TechNet. - - - Task Scheduler stopped an instance of a task in order to launch a new instance. - For detailed information, see the documentation for Event ID 323 on TechNet. - - - Task Scheduler queued an instance of a task and will launch it as soon as another instance completes. - For detailed information, see the documentation for Event ID 324 on TechNet. - - - Task Scheduler queued an instance of a task that will launch immediately. - For detailed information, see the documentation for Event ID 325 on TechNet. - - - Task Scheduler did not launch a task because the computer is running on batteries. If launching the task on batteries is required, change the respective flag in the task configuration. - For detailed information, see the documentation for Event ID 326 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is switching to battery power. - For detailed information, see the documentation for Event ID 327 on TechNet. - - - Task Scheduler stopped an instance of a task because the computer is no longer idle. - For detailed information, see the documentation for Event ID 328 on TechNet. - - - Task Scheduler stopped an instance of a task because the task timed out. - For detailed information, see the documentation for Event ID 329 on TechNet. - - - Task Scheduler stopped an instance of a task as request by a user . - For detailed information, see the documentation for Event ID 330 on TechNet. - - - Task Scheduler will continue to execute an instance of a task even after the designated timeout, due to a failure to create the timeout mechanism. - For detailed information, see the documentation for Event ID 331 on TechNet. - - - Task Scheduler did not launch a task because a user was not logged on when the launching conditions were met. Ensure the user is logged on or change the task definition to allow the task to launch when the user is logged off. - For detailed information, see the documentation for Event ID 332 on TechNet. - - - The Task Scheduler service has started. - For detailed information, see the documentation for Event ID 400 on TechNet. - - - The Task Scheduler service failed to start due to an error. - For detailed information, see the documentation for Event ID 401 on TechNet. - - - Task Scheduler service is shutting down. - For detailed information, see the documentation for Event ID 402 on TechNet. - - - The Task Scheduler service has encountered an error. - For detailed information, see the documentation for Event ID 403 on TechNet. - - - The Task Scheduler service has encountered an RPC initialization error. - For detailed information, see the documentation for Event ID 404 on TechNet. - - - The Task Scheduler service has failed to initialize COM. - For detailed information, see the documentation for Event ID 405 on TechNet. - - - The Task Scheduler service failed to initialize the credentials store. - For detailed information, see the documentation for Event ID 406 on TechNet. - - - Task Scheduler service failed to initialize LSA. - For detailed information, see the documentation for Event ID 407 on TechNet. - - - Task Scheduler service failed to initialize idle state detection module. Idle tasks may not be started as required. - For detailed information, see the documentation for Event ID 408 on TechNet. - - - The Task Scheduler service failed to initialize a time change notification. System time updates may not be picked by the service and task schedules may not be updated. - For detailed information, see the documentation for Event ID 409 on TechNet. - - - Task Scheduler service received a time system change notification. - For detailed information, see the documentation for Event ID 411 on TechNet. - - - Task Scheduler service failed to launch tasks triggered by computer startup. Restart the Task Scheduler service. - For detailed information, see the documentation for Event ID 412 on TechNet. - - - Task Scheduler service started Task Compatibility module. - For detailed information, see the documentation for Event ID 700 on TechNet. - - - Task Scheduler service failed to start Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 701 on TechNet. - - - Task Scheduler failed to initialize the RPC server for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 702 on TechNet. - - - Task Scheduler failed to initialize Net Schedule API for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 703 on TechNet. - - - Task Scheduler failed to initialize LSA for starting the Task Compatibility module. Tasks may not be able to register on previous Window versions. - For detailed information, see the documentation for Event ID 704 on TechNet. - - - Task Scheduler failed to start directory monitoring for the Task Compatibility module. - For detailed information, see the documentation for Event ID 705 on TechNet. - - - Task Compatibility module failed to update a task to the required status. - For detailed information, see the documentation for Event ID 706 on TechNet. - - - Task Compatibility module failed to delete a task. - For detailed information, see the documentation for Event ID 707 on TechNet. - - - Task Compatibility module failed to set a security descriptor for a task. - For detailed information, see the documentation for Event ID 708 on TechNet. - - - Task Compatibility module failed to update a task. - For detailed information, see the documentation for Event ID 709 on TechNet. - - - Task Compatibility module failed to upgrade existing tasks. Upgrade will be attempted again next time 'Task Scheduler' service starts. - For detailed information, see the documentation for Event ID 710 on TechNet. - - - Task Compatibility module failed to upgrade NetSchedule account. - For detailed information, see the documentation for Event ID 711 on TechNet. - - - Task Compatibility module failed to read existing store to upgrade tasks. - For detailed information, see the documentation for Event ID 712 on TechNet. - - - Task Compatibility module failed to load a task for upgrade. - For detailed information, see the documentation for Event ID 713 on TechNet. - - - Task Compatibility module failed to register a task for upgrade. - For detailed information, see the documentation for Event ID 714 on TechNet. - - - Task Compatibility module failed to delete LSA store for upgrade. - For detailed information, see the documentation for Event ID 715 on TechNet. - - - Task Compatibility module failed to upgrade existing scheduled tasks. - For detailed information, see the documentation for Event ID 716 on TechNet. - - - Task Compatibility module failed to determine if upgrade is needed. - For detailed information, see the documentation for Event ID 717 on TechNet. - - - Task scheduler was unable to upgrade the credential store from the Beta 2 version. You may need to re-register any tasks that require passwords. - For detailed information, see the documentation for Event ID 718 on TechNet. - - - A unknown value. - - - - Historical event information for a task. This class wraps and extends the class. - - - For events on systems prior to Windows Vista, this class will only have information for the TaskPath, TimeCreated and EventId properties. - - - - - Gets the activity id. This value is null for V1 events. - - - - - An indexer that gets the value of each of the data item values. This value is null for V1 events. - - - The data values. - - - - - Gets the event id. - - - - - Gets the underlying . This value is null for V1 events. - - - - - Gets the from the . - - - The . If not found, returns . - - - - - Gets the level. This value is null for V1 events. - - - - - Gets the op code. This value is null for V1 events. - - - - - Gets the process id. This value is null for V1 events. - - - - - Gets the record id. This value is null for V1 events. - - - - - Gets the task category. This value is null for V1 events. - - - - - Gets the task path. - - - - - Gets the time created. - - - - - Gets the user id. This value is null for V1 events. - - - - - Gets the version. This value is null for V1 events. - - - - - Gets the data value from the task specific event data item list. - - The name of the data element. - Contents of the requested data element if found. null if no value found. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the other parameter.Zero This object is equal to other. Greater than zero This object is greater than other. - - - - - Get indexer class for data values. - - - - - Gets the value of the specified property name. - - - The value. - - Name of the property. - Value of the specified property name. null if property does not exist. - - - - An enumerator over a task's history of events. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Gets the element in the collection at the current position of the enumerator. - - - The element in the collection at the current position of the enumerator. - - - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - - - Advances the enumerator to the next element of the collection. - - - true if the enumerator was successfully advanced to the next element; false if the enumerator has passed the end of the collection. - - - The collection was modified after the enumerator was created. - - - - - Sets the enumerator to its initial position, which is before the first element in the collection. - - - The collection was modified after the enumerator was created. - - - - - Seeks the specified bookmark. - - The bookmark. - The offset. - - - - Seeks the specified origin. - - The origin. - The offset. - - - - Historical event log for a task. Only available for Windows Vista and Windows Server 2008 and later systems. - - Many applications have the need to audit the execution of the tasks they supply. To enable this, the library provides the TaskEventLog class that allows for TaskEvent instances to be enumerated. This can be done for single tasks or the entire system. It can also be filtered by specific events or criticality. - - - - - Initializes a new instance of the class. - - The task path. This can be retrieved using the property. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class. - - Name of the machine. - The task path. This can be retrieved using the property. - The domain. - The user. - The password. - Thrown when instantiated on an OS prior to Windows Vista. - - - - Initializes a new instance of the class that looks at all task events from a specified time. - - The start time. - Name of the task. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Initializes a new instance of the class. - - Name of the task. - The event ids. - The levels. - The start time. - Name of the machine (optional). - The domain. - The user. - The password. - - - - Gets the total number of events for this task. - - - - - Gets or sets a value indicating whether this is enabled. - - - true if enabled; otherwise, false. - - - - - Gets or sets a value indicating whether to enumerate in reverse when calling the default enumerator (typically with foreach statement). - - - true if enumerates in reverse (newest to oldest) by default; otherwise, false to enumerate oldest to newest. - - - - - Returns an enumerator that iterates through the collection. - - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through the collection. - - if set to true reverse. - - A that can be used to iterate through the collection. - - - - - Returns an enumerator that iterates through a collection. - - - An object that can be used to iterate through the collection. - - - - - Information about the task event. - - - - - If possible, gets the task associated with this event. - - - The task or null if unable to retrieve. - - - - - Gets the . - - - The TaskEvent. - - - - - Gets the task name. - - - The task name. - - - - - Gets the task path. - - - The task path. - - - - - Watches system events related to tasks and issues a event when the filtered conditions are met. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - Sometimes, a developer will need to know about events as they occur. In this case, they can use the TaskEventWatcher component that enables the developer to watch a task, a folder, or the entire system for filtered events. - - Below is information on how to watch a folder for all task events. For a complete example, look at this sample project: TestTaskWatcher.zip - - - - - Initializes a new instance of the class. If other - properties are not set, this will watch for all events for all tasks on the local machine. - - - - - Initializes a new instance of the class watching only - those events for the task with the provided path on the local machine. - - The full path (folders and name) of the task to watch. - The task service. - $Invalid task name: {taskPath} - - - - Initializes a new instance of the class watching only - those events for the specified task. - - The task to watch. - Occurs if the is null. - - - - Initializes a new instance of the class watching only those events for - the tasks whose name matches the in the specified - and optionally all subfolders. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - Occurs if the is null. - - - - Initializes a new instance of the class. - - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The task service. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task path. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Initializes a new instance of the class on a remote machine. - - Name of the remote machine. - The task folder to watch. - The filter for task names using standard file system wildcards. Use "*" to include all tasks. - if set to true include events from tasks subfolders. - The domain of the user account. - The user name with permissions on the remote machine. - The password for the user. - - - - Occurs when a task or the task engine records an event. - - - - - Gets or sets a value indicating whether the component is enabled. - - - true if enabled; otherwise, false. - - - - - Gets the filter for this . - - - The filter. - - - - - Gets or sets the folder to watch. - - - The folder path to watch. This value should include the leading "\" to indicate the root folder. - - Thrown if the folder specified does not exist or contains invalid characters. - - - - Gets or sets a value indicating whether to include events from subfolders when the - property is set. If the property is set, - this property is ignored. - - true if include events from subfolders; otherwise, false. - - - - Gets or sets the synchronizing object. - - - The synchronizing object. - - - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - - - Gets or sets the instance associated with this event watcher. Setting this value - will override any values set for , , - , and and set them to those values in the supplied - instance. - - The TaskService. - - - - Gets or sets the user account domain to be used when connecting to the . - - The user account domain. - - - - Gets or sets the user name to be used when connecting to the . - - The user name. - - - - Gets or sets the user password to be used when connecting to the . - - The user password. - - - - Gets a value indicating if watching is available. - - - - - Signals the object that initialization is starting. - - - - - Signals the object that initialization is complete. - - - - - Releases the unmanaged resources used by the FileSystemWatcher and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Fires the event. - - The sender. - The instance containing the event data. - - - - Holds filter information for a . - - - - - Gets or sets an optional array of event identifiers to use when filtering those events that will fire a event. - - - The array of event identifier filters. All know task event identifiers are declared in the enumeration. - - - - - Gets or sets an optional array of event levels to use when filtering those events that will fire a event. - - - The array of event levels. While event providers can define custom levels, most will use integers defined in the System.Diagnostics.Eventing.Reader.StandardEventLevel enumeration. - - - - - Gets or sets the task name, which can utilize wildcards, to look for when watching a folder. - - A task name or wildcard. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Provides the methods that are used to register (create) tasks in the folder, remove tasks from the folder, and create or remove subfolders from the folder. - - - - - Releases all resources used by this class. - - - - - Gets a which enumerates all the tasks in this and all subfolders. - - - A for all instances. - - - - - Gets the name that is used to identify the folder that contains a task. - - - - - Gets the parent folder of this folder. - - - The parent folder, or null if this folder is the root folder. - - - - - Gets the path to where the folder is stored. - - - - - Gets or sets the security descriptor of the task. - - The security descriptor. - - - - Gets all the subfolders in the folder. - - - - - Gets a collection of all the tasks in the folder. - - - - - Gets or sets the that manages this task. - - The task service. - - - - Compares the current object with another object of the same type. - - An object to compare with this object. - - A value that indicates the relative order of the objects being compared. The return value has the following meanings: Value Meaning Less than zero This object is less than the parameter.Zero This object is equal to . Greater than zero This object is greater than . - - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The task security associated with the folder. - A instance that represents the new subfolder. - - - - Creates a folder for related tasks. Not available to Task Scheduler 1.0. - - The name used to identify the folder. If "FolderName\SubFolder1\SubFolder2" is specified, the entire folder tree will be created if the folders do not exist. This parameter can be a relative path to the current instance. The root task folder is specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The security descriptor associated with the folder. - Set this value to false to avoid having an exception called if the folder already exists. - A instance that represents the new subfolder. - Security descriptor mismatch between specified credentials and credentials on existing folder by same name. - Invalid SDDL form. - Not supported under Task Scheduler 1.0. - - - - Deletes a subfolder from the parent folder. Not available to Task Scheduler 1.0. - - The name of the subfolder to be removed. The root task folder is specified with a backslash (\). This parameter can be a relative path to the folder you want to delete. An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - Set this value to false to avoid having an exception called if the folder does not exist. - Not supported under Task Scheduler 1.0. - - - Deletes a task from the folder. - - The name of the task that is specified when the task was registered. The '.' character cannot be used to specify the current task folder and the '..' - characters cannot be used to specify the parent task folder in the path. - - Set this value to false to avoid having an exception called if the task does not exist. - - - Returns an enumerable collection of folders that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - An enumerable collection of folders that matches . - - - Returns an enumerable collection of tasks that matches a specified filter and recursion option. - An optional predicate used to filter the returned instances. - Specifies whether the enumeration should include tasks in any subfolders. - An enumerable collection of directories that matches and . - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task described by the - current object. - - A object that encapsulates the access control rules for the current folder. - - - - Gets a object that encapsulates the specified type of access control list (ACL) entries for the task folder described by - the current object. - - - One of the values that specifies which group of access control entries to retrieve. - - A object that encapsulates the access control rules for the current folder. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - Section(s) of the security descriptor to return. - The security descriptor for the folder. - - - - Gets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - Section(s) of the security descriptor to return. - The security descriptor for the folder. - Not supported under Task Scheduler 1.0. - - - - Gets a collection of all the tasks in the folder whose name matches the optional . - - The optional name filter expression. - Collection of all matching tasks. - - - Imports a from an XML file. - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The file containing the XML-formatted definition of the task. - If set to , overwrites any existing task with the same name. - A instance that represents the new task. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - - Registers (creates) a new task in the folder using XML to define the task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - An XML-formatted definition of the task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - A instance that represents the new task. - " + - "" + - " " + - " " + - " S-1-5-18" + - " " + - " " + - " " + - " " + - " 2017-09-04T14:04:03" + - " " + - " " + - " " + - " " + - " " + - " cmd" + - " " + - " " + - ""; - // Register the task in the root folder of the local machine using the SYSTEM account defined in XML - TaskService.Instance.RootFolder.RegisterTaskDefinition("Test", xml); - ]]> - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A instance that represents the new task. - - - - - - Registers (creates) a task in a specified location using a instance to define a task. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - The of the registered task. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - The security descriptor associated with the registered task. You can specify the access control list (ACL) in the security descriptor for a task in order to allow or deny certain users and groups access to a task. - - A instance that represents the new task. This will return null if is set to ValidateOnly and there are no validation errors. - - - Task names may not include any characters which are invalid for file names. - or - Task names ending with a period followed by three or fewer characters cannot be retrieved due to a bug in the native library. - - This LogonType is not supported on Task Scheduler 1.0. - or - Security settings are not available on Task Scheduler 1.0. - or - Registration triggers are not available on Task Scheduler 1.0. - or - XML validation not available on Task Scheduler 1.0. - This method is effectively the "Save" method for tasks. It takes a modified TaskDefinition instance and registers it in the folder defined by this TaskFolder instance. Optionally, you can use this method to override the user, password and logon type defined in the definition and supply security against the task. - - This first example registers a simple task with a single trigger and action using the default security. - - This example registers that same task using the SYSTEM account. - - This example registers that same task using a specific username and password along with a security definition. - - - - - Applies access control list (ACL) entries described by a object to the file described by the current object. - - A object that describes an access control list (ACL) entry to apply to the current folder. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Section(s) of the security descriptor to set. - - - - Sets the security descriptor for the folder. Not available to Task Scheduler 1.0. - - The security descriptor for the folder. - Flags that specify how to set the security descriptor. - Not supported under Task Scheduler 1.0. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Enumerates the tasks in the specified folder and its child folders. - - The folder in which to start enumeration. - An optional filter to apply to the task list. - true if subfolders are to be queried recursively. - A that can be used to iterate through the tasks. - - - Provides information and control for a collection of folders that contain tasks. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of items in the collection. - - - Gets a value indicating whether the is read-only. - - - Gets the specified folder from the collection. - The index of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Gets the specified folder from the collection. - The path of the folder to be retrieved. - A TaskFolder instance that represents the requested folder. - - - Adds an item to the . - The object to add to the . - - This action is technically unfeasible due to limitations of the underlying library. Use the instead. - - - - Removes all items from the . - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Copies the elements of the ICollection to an Array, starting at a particular Array index. - - The one-dimensional Array that is the destination of the elements copied from . The Array must have - zero-based indexing. - - The zero-based index in array at which copying begins. - - - Releases all resources used by this class. - - - Determines whether the specified folder exists. - The path of the folder. - true if folder exists; otherwise, false. - - - Gets a list of items in a collection. - Enumerated list of items in the collection. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Defines the methods that are called by the Task Scheduler service to manage a COM handler. - - - This interface must be implemented for a task to perform a COM handler action. When the Task Scheduler performs a COM handler action, it creates and activates the handler and calls the methods of this interface as needed. For information on specifying a COM handler action, see the class. - - - - - Called to start the COM handler. This method must be implemented by the handler. - - An IUnkown interface that is used to communicate back with the Task Scheduler. - The arguments that are required by the handler. These arguments are defined in the property of the COM handler action. - - - - Called to stop the COM handler. This method must be implemented by the handler. - - The return code that the Task Schedule will raise as an event when the COM handler action is completed. - - - - Called to pause the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to pause and restart the handler. - - - - - Called to resume the COM handler. This method is optional and should only be implemented to give the Task Scheduler the ability to resume the handler. - - - - - Provides the methods that are used by COM handlers to notify the Task Scheduler about the status of the handler. - - - - - Tells the Task Scheduler about the percentage of completion of the COM handler. - - A value that indicates the percentage of completion for the COM handler. - The message that is displayed in the Task Scheduler UI. - - - - Tells the Task Scheduler that the COM handler is completed. - - The error code that the Task Scheduler will raise as an event. - - - - Specifies the access control rights that can be applied to Task Scheduler tasks. - - - - Specifies the right to exert full control over a task folder or task, and to modify access control and audit rules. This value represents the right to do anything with a task and is the combination of all rights in this enumeration. - - - Specifies the right to create tasks and folders, and to add or remove data from tasks. This right includes the following rights: . - - - Specifies the right to open and copy folders or tasks as read-only. This right includes the following rights: . - - - Specifies the right run tasks. This right includes the following rights: . - - - The right to wait on a task. - - - The right to change the owner of a task. - - - Specifies the right to change the security and audit rules associated with a task or folder. - - - The right to open and copy the access rules and audit rules for a task. - - - The right to delete a folder or task. - - - Specifies the right to open and write file system attributes to a folder or file. This does not include the ability to write data, extended attributes, or access and audit rules. - - - Specifies the right to open and copy file system attributes from a folder or task. For example, this value specifies the right to view the file creation or modified date. This does not include the right to read data, extended file system attributes, or access and audit rules. - - - Specifies the right to delete a folder and any tasks contained within that folder. - - - Specifies the right to run a task. - - - Specifies the right to open and write extended file system attributes to a folder or file. This does not include the ability to write data, attributes, or access and audit rules. - - - Specifies the right to open and copy extended system attributes from a folder or task. For example, this value specifies the right to view author and content information. This does not include the right to read data, system attributes, or access and audit rules. - - - Specifies the right to append data to the end of a file. - - - Specifies the right to open and write to a file or folder. This does not include the right to open and write file system attributes, extended file system attributes, or access and audit rules. - - - Specifies the right to open and copy a task or folder. This does not include the right to read file system attributes, extended file system attributes, or access and audit rules. - - - - Represents a set of access rights allowed or denied for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Initializes a new instance of the class, specifying the name of the user or group the rule applies to, the access rights, and whether the specified access rights are allowed or denied. - - The name of the user or group the rule applies to. - A bitwise combination of values specifying the rights allowed or denied. - One of the values specifying whether the rights are allowed or denied. - - - - Gets the rights allowed or denied by the access rule. - - - A bitwise combination of values indicating the rights allowed or denied by the access rule. - - - - - Represents a set of access rights to be audited for a user or group. This class cannot be inherited. - - - - - Initializes a new instance of the class, specifying the user or group to audit, the rights to audit, and whether to audit success, failure, or both. - - The user or group the rule applies to. Must be of type or a type such as that can be converted to type . - A bitwise combination of values specifying the kinds of access to audit. - The audit flags. - - - - Gets the access rights affected by the audit rule. - - - A bitwise combination of values that indicates the rights affected by the audit rule. - - objects are immutable. You can create a new audit rule representing a different user, different rights, or a different combination of AuditFlags values, but you cannot modify an existing audit rule. - - - - Represents the Windows access control security for a Task Scheduler task. This class cannot be inherited. - - - A TaskSecurity object specifies access rights for a Task Scheduler task, and also specifies how access attempts are audited. Access rights to the task are expressed as rules, with each access rule represented by a object. Each auditing rule is represented by a object. - This mirrors the underlying Windows security system, in which each securable object has at most one discretionary access control list (DACL) that controls access to the secured object, and at most one system access control list (SACL) that specifies which access attempts are audited. The DACL and SACL are ordered lists of access control entries (ACE) that specify access and auditing for users and groups. A or object might represent more than one ACE. - Note - A object can represent a local task or a Task Scheduler task. Windows access control security is meaningful only for Task Scheduler tasks. - The TaskSecurity, , and classes hide the implementation details of ACLs and ACEs. They allow you to ignore the seventeen different ACE types and the complexity of correctly maintaining inheritance and propagation of access rights. These objects are also designed to prevent the following common access control errors: - - Creating a security descriptor with a null DACL. A null reference to a DACL allows any user to add access rules to an object, potentially creating a denial-of-service attack. A new TaskSecurity object always starts with an empty DACL, which denies all access for all users. - Violating the canonical ordering of ACEs. If the ACE list in the DACL is not kept in the canonical order, users might inadvertently be given access to the secured object. For example, denied access rights must always appear before allowed access rights. TaskSecurity objects maintain the correct order internally. - Manipulating security descriptor flags, which should be under resource manager control only. - Creating invalid combinations of ACE flags. - Manipulating inherited ACEs. Inheritance and propagation are handled by the resource manager, in response to changes you make to access and audit rules. - Inserting meaningless ACEs into ACLs. - - The only capabilities not supported by the .NET security objects are dangerous activities that should be avoided by the majority of application developers, such as the following: - - Low-level tasks that are normally performed by the resource manager. - Adding or removing access control entries in ways that do not maintain the canonical ordering. - - To modify Windows access control security for a task, use the method to get the TaskSecurity object. Modify the security object by adding and removing rules, and then use the method to reattach it. - Important: Changes you make to a TaskSecurity object do not affect the access levels of the task until you call the method to assign the altered security object to the task. - To copy access control security from one task to another, use the method to get a TaskSecurity object representing the access and audit rules for the first task, then use the method, or a constructor that accepts a TaskSecurity object, to assign those rules to the second task. - Users with an investment in the security descriptor definition language (SDDL) can use the method to set access rules for a task, and the method to obtain a string that represents the access rules in SDDL format. This is not recommended for new development. - - - - - Initializes a new instance of the class with default values. - - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The task. - The sections of the ACL to retrieve. - - - - Initializes a new instance of the class with the specified sections of the access control security rules from the specified task. - - The folder. - The sections of the ACL to retrieve. - - - - Gets the enumeration that the class uses to represent access rights. - - A object representing the enumeration. - - - - Gets the type that the TaskSecurity class uses to represent access rules. - - A object representing the class. - - - - Gets the type that the TaskSecurity class uses to represent audit rules. - - A object representing the class. - - - - Gets a object that represent the default access rights. - - The default task security. - - - - Creates a new access control rule for the specified user, with the specified access rights, access control, and flags. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to allow or deny, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether the rights are allowed or denied. - - The object that this method creates. - - - - - Searches for a matching rule with which the new rule can be merged. If none are found, adds the new rule. - - The access control rule to add. - - - - Searches for an audit rule with which the new rule can be merged. If none are found, adds the new rule. - - The audit rule to add. The user specified by this rule determines the search. - - - - Creates a new audit rule, specifying the user the rule applies to, the access rights to audit, and the outcome that triggers the audit rule. - - An that identifies the user or group the rule applies to. - A bitwise combination of values specifying the access rights to audit, cast to an integer. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - Meaningless for tasks, because they have no hierarchy. - One of the values specifying whether to audit successful access, failed access, or both. - - A object representing the specified audit rule for the specified user. The return type of the method is the base class, , but the return value can be cast safely to the derived class. - - - - - Searches for an access control rule with the same user and (allow or deny) as the specified rule, and with compatible inheritance and propagation flags; if such a rule is found, the rights contained in the specified access rule are removed from it. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all access control rules with the same user and (allow or deny) as the specified rule and, if found, removes them. - - A that specifies the user and to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Any rights specified by this rule are ignored. - - - - Searches for an access control rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Searches for an audit control rule with the same user as the specified rule, and with compatible inheritance and propagation flags; if a compatible rule is found, the rights contained in the specified rule are removed from it. - - A that specifies the user to search for, and a set of inheritance and propagation flags that a matching rule, if found, must be compatible with. Specifies the rights to remove from the compatible rule, if found. - true if a compatible rule is found; otherwise false. - - - - Searches for all audit rules with the same user as the specified rule and, if found, removes them. - - A that specifies the user to search for. Any rights specified by this rule are ignored. - - - - Searches for an audit rule that exactly matches the specified rule and, if found, removes it. - - The to remove. - - - - Removes all access control rules with the same user as the specified rule, regardless of , and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Removes all access control rules with the same user and (allow or deny) as the specified rule, and then adds the specified rule. - - The to add. The user and of this rule determine the rules to remove before this rule is added. - - - - Removes all audit rules with the same user as the specified rule, regardless of the value, and then adds the specified rule. - - The to add. The user specified by this rule determines the rules to remove before this rule is added. - - - - Returns a that represents this instance. - - - A that represents this instance. - - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. - - The task folder used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Saves the specified sections of the security descriptor associated with this object to permanent storage. We recommend that the values of the parameters passed to the constructor and persist methods be identical. For more information, see Remarks. - - The name used to retrieve the persisted information. - One of the enumeration values that specifies the sections of the security descriptor (access rules, audit rules, owner, primary group) of the securable object to save. - - - - Quick simple trigger types for the - method. - - - - At boot. - - - On system idle. - - - At logon of any user. - - - When the task is registered. - - - Hourly, starting now. - - - Daily, starting now. - - - Weekly, starting now. - - - Monthly, starting now. - - - - Known versions of the native Task Scheduler library. This can be used as a decoder for the - and values. - - - - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016 post build 1703). - - - Provides access to the Task Scheduler service for managing registered tasks. - - - Creates a new instance of a TaskService connecting to the local machine as the current user. - - - Initializes a new instance of the class. - - The name of the computer that you want to connect to. If the this parameter is empty, then this will connect to the local computer. - - - The user name that is used during the connection to the computer. If the user is not specified, then the current token is used. - - The domain of the user specified in the parameter. - - The password that is used to connect to the computer. If the user name and password are not specified, then the current token is used. - - If set to true force Task Scheduler 1.0 compatibility. - - - Delegate for methods that support update calls during COM handler execution. - The percentage of completion (0 to 100). - An optional message. - - - Occurs when the Task Scheduler is connected to the local or remote target. - - - Occurs when the Task Scheduler is disconnected from the local or remote target. - - - Gets a local instance of the using the current user's credentials. - Local user instance. - - - - Gets the library version. This is the highest version supported by the local library. Tasks cannot be created using any - compatibility level higher than this version. - - The library version. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - - Gets or sets a value indicating whether to allow tasks from later OS versions with new properties to be retrieved as read only tasks. - - true if allow read only tasks; otherwise, false. - - - Gets the name of the domain to which the computer is connected. - - - Gets the name of the user that is connected to the Task Scheduler service. - - - Gets the highest version of Task Scheduler that a computer supports. - - The following table list the various versions and their host operating system: - - - Version - Operating System - - - 1.1 - Task Scheduler 1.0 (Windows Server™ 2003, Windows® XP, or Windows® 2000). - - - 1.2 - Task Scheduler 2.0 (Windows Vista™, Windows Server™ 2008). - - - 1.3 - Task Scheduler 2.1 (Windows® 7, Windows Server™ 2008 R2). - - - 1.4 - Task Scheduler 2.2 (Windows® 8.x, Windows Server™ 2012). - - - 1.5 - Task Scheduler 2.3 (Windows® 10, Windows Server™ 2016). - - - 1.6 - Task Scheduler 2.4 (Windows® 10 Version 1703, Windows Server™ 2016 Version 1703). - - - - - - Gets the root ("\") folder. For Task Scheduler 1.0, this is the only folder. - - - Gets or sets the name of the computer that is running the Task Scheduler service that the user is connected to. - - - Gets or sets the user account domain to be used when connecting to the . - The user account domain. - - - Gets or sets the user name to be used when connecting to the . - The user name. - - - Gets or sets the user password to be used when connecting to the . - The user password. - - - Gets a which enumerates all the tasks in all folders. - A for all instances. - - - Gets a Boolean value that indicates if you are connected to the Task Scheduler service. - - - - Gets the connection token for this instance. This token is thread safe and can be used to create new - instances on other threads using the static method. - - The connection token. - - - Gets a value indicating whether the component can raise an event. - - - - Creates a new instance from a token. Given that a TaskService instance is thread specific, this is the - preferred method for multi-thread creation or asynchronous method parameters. - - The token. - A instance valid for the thread calling this method. - - - Gets a formatted string that tells the Task Scheduler to retrieve a string from a resource .dll file. - The path to the .dll file that contains the resource. - The identifier for the resource text (typically a negative number). - A string in the format of $(@ [dllPath], [resourceId]). - - For example, the setting this property value to $(@ %SystemRoot%\System32\ResourceName.dll, -101) will set the property to the - value of the resource text with an identifier equal to -101 in the %SystemRoot%\System32\ResourceName.dll file. - - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - The value set by the COM object via a call to the method. - - - - Runs an action that is defined via a COM handler. COM CLSID must be registered to an object that implements the - interface. - - The CLSID of the COM object. - The action to run on thread completion. - An optional string passed to the COM object at startup. - The number of milliseconds to wait or -1 for indefinitely. - - An optional delegate that is called when the COM object calls the - method. - - - - Adds or updates an Automatic Maintenance Task on the connected machine. - Name of the task with full path. - The amount of time the task needs once executed during regular Automatic maintenance. - - The amount of time after which the Task Scheduler attempts to run the task during emergency Automatic maintenance, if the task - failed to complete during regular Automatic Maintenance. - - The path to an executable file. - The arguments associated with the command-line operation. - - The directory that contains either the executable file or the files that are used by the executable file. - - A instance of the Automatic Maintenance Task. - - Automatic Maintenance tasks are only supported on Windows 8/Server 2012 and later. - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The to determine what happens when the task is triggered. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - This method is shorthand for creating a new TaskDescription, adding a trigger and action, and then registering it in the root folder. - - - - - - - - - Creates a new task, registers the task, and returns the instance. - - The task name. If this value is NULL, the task will be registered in the root task folder and the task name will be a GUID value - that is created by the Task Scheduler service. A task name cannot begin or end with a space character. The '.' character cannot - be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - The to determine when to run the task. - The executable path. - The arguments (optional). Value can be NULL. - The user credentials used to register the task. - The password for the userId used to register the task. - - A value that defines what logon technique is used to run the registered task. - - The task description. - A instance of the registered task. - - - - - - - - Signals the object that initialization is starting. - - - Signals the object that initialization is complete. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Finds all tasks matching a name or standard wildcards. - Name of the task in regular expression form. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds all tasks matching a name or standard wildcards. - The filter used to determine tasks to select. - if set to true search all sub folders. - An array of containing all tasks matching . - - - Finds a task given a name and standard wildcards. - The task name. This can include the wildcards * or ?. - if set to true search all sub folders. - A if one matches , otherwise NULL. - - - Gets the event log for this instance. - (Optional) The task path if only the events for a single task are desired. - A instance. - - - Gets the path to a folder of registered tasks. - - The path to the folder to retrieve. Do not use a backslash following the last folder name in the path. The root task folder is - specified with a backslash (\). An example of a task folder path, under the root task folder, is \MyTaskFolder. The '.' character - cannot be used to specify the current task folder and the '..' characters cannot be used to specify the parent task folder in the path. - - instance for the requested folder or null if was unrecognized. - - Folder other than the root (\) was requested on a system not supporting Task Scheduler 2.0. - - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Gets a collection of running tasks. - True to include hidden tasks. - instance with the list of running tasks. - - - Gets the task with the specified path. - The task path. - - The instance matching the , if found. If not found, this method returns null. - - - - - Returns an empty task definition object to be filled in with settings and properties and then registered using the - method. - - A instance for setting properties. - - - Returns a populated with the properties defined in an XML file. - The XML file to use as input. - A instance. - Importing from an XML file is only supported under Task Scheduler 2.0. - - - Starts the Task Scheduler UI for the OS hosting the assembly if the session is running in interactive mode. - - - - Releases the unmanaged resources used by the and optionally releases the managed resources. - - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - Connects this instance of the class to a running Task Scheduler. - - - Finds the task in folder. - The folder. - The wildcard expression to compare task names with. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - Finds the task in folder. - The folder. - The filter to use when looking for tasks. - The results. - if set to true recurse folders. - True if any tasks are found, False if not. - - - - Represents a valid, connected session to a Task Scheduler instance. This token is thread-safe and should be the means of passing - information about a between threads. - - - - Initial call for a Fluent model of creating a task. - The path of the program to run. - An instance. - - - - Abstract base class which provides the common properties that are inherited by all trigger classes. A trigger can be created using - the or the method. - - - - Creates a trigger using a cron string. - String using cron defined syntax for specifying a time interval. See remarks for syntax. - Array of representing the specified cron string. - Unsupported cron string. - - This method does not support all combinations of cron strings. Please test extensively before use. Please post an issue with any - syntax that should work, but doesn't. - The following combinations are known not to work: - - Intervals on months (e.g. "* * * */5 *") - Intervals on DOW (e.g. "* * * * MON/3") - - - This section borrows liberally from the site http://www.nncron.ru/help/EN/working/cron-format.htm. The cron format consists of five fields separated - by white spaces: - - - <Minute> <Hour> <Day_of_the_Month> <Month_of_the_Year> <Day_of_the_Week> - - Each item has bounds as defined by the following: - - * * * * * - | | | | | - | | | | +---- Day of the Week (range: 1-7, 1 standing for Monday) - | | | +------ Month of the Year (range: 1-12) - | | +-------- Day of the Month (range: 1-31) - | +---------- Hour (range: 0-23) - +------------ Minute (range: 0-59) - - Any of these 5 fields may be an asterisk (*). This would mean the entire range of possible values, i.e. each minute, each hour, etc. - - Any of the first 4 fields can be a question mark ("?"). It stands for the current time, i.e. when a field is processed, the current time will be - substituted for the question mark: minutes for Minute field, hour for Hour field, day of the month for Day of month field and month for Month field. - - Any field may contain a list of values separated by commas, (e.g. 1,3,7) or a range of values (two integers separated by a hyphen, e.g. 1-5). - - After an asterisk (*) or a range of values, you can use character / to specify that values are repeated over and over with a certain interval between - them. For example, you can write "0-23/2" in Hour field to specify that some action should be performed every two hours (it will have the same effect - as "0,2,4,6,8,10,12,14,16,18,20,22"); value "*/4" in Minute field means that the action should be performed every 4 minutes, "1-30/3" means the same - as "1,4,7,10,13,16,19,22,25,28". - - - - - In testing and may change. Do not use until officially introduced into library. - - - Occurs when a property value changes. - - - Gets or sets a Boolean value that indicates whether the trigger is enabled. - - - - Gets or sets the date and time when the trigger is deactivated. The trigger cannot start the task after it is deactivated. - While the maximum value for this property is , the Windows Task Scheduler management - application that is part of the OS will fail if this value is greater than December 31, 9998. - - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for the Day, Month and Year values of the structure. - - - Version 2 (1.2 or higher) of the native library only allows for both date and time and all values. - However, the user interface and methods will always show the time translated to local time. The - library makes every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, - the "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the - user selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - - - - Gets or sets the maximum amount of time that the task launched by this trigger is allowed to run. Not available with Task - Scheduler 1.0. - - Not supported under Task Scheduler 1.0. - - - Gets or sets the identifier for the trigger. Cannot set with Task Scheduler 1.0. - Not supported under Task Scheduler 1.0. - - - - Gets a instance that indicates how often the task is run and how long the repetition pattern is - repeated after the task is started. - - - - Gets or sets the date and time when the trigger is activated. - - - Version 1 (1.1 on all systems prior to Vista) of the native library only allows for values where the is unspecified. If the DateTime value Kind is then it will be used as - is. If the DateTime value Kind is then it will be converted to the local time and then used. - - - Version 2 (1.2 or higher) of the native library only allows for all values. However, the user - interface and methods will always show the time translated to local time. The library makes - every attempt to maintain the Kind value. When using the UI elements provided in the TaskSchedulerEditor library, the - "Synchronize across time zones" checkbox will be checked if the Kind is Local or Utc. If the Kind is Unspecified and the user - selects the checkbox, the Kind will be changed to Utc and the time adjusted from the value displayed as the local time. - - - Under Version 2, when converting the string used in the native library for this value (ITrigger.Startboundary) this library will - behave as follows: - - - YYYY-MM-DDTHH:MM:SS format uses DateTimeKind.Unspecified and the time specified. - - - YYYY-MM-DDTHH:MM:SSZ format uses DateTimeKind.Utc and the time specified as the GMT time. - - - YYYY-MM-DDTHH:MM:SS±HH:MM format uses DateTimeKind.Local and the time specified in that time zone. - - - - - - - Gets the type of the trigger. - The of the trigger. - - - Creates the specified trigger. - Type of the trigger to instantiate. - of specified type. - - - Creates a new that is an unbound copy of this instance. - A new that is an unbound copy of this instance. - - - - Compares the current instance with another object of the same type and returns an integer that indicates whether the current - instance precedes, follows, or occurs in the same position in the sort order as the other object. - - An object to compare with this instance. - A value that indicates the relative order of the objects being compared. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Sets the repetition. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - if set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Returns a string representing this trigger. - String value of trigger. - - - Returns a that represents this trigger in a specific language. - The language of the resulting string. - String value of trigger. - - - Gets the best time span string. - The to display. - Either the full string representation created by TimeSpan2 or the default TimeSpan representation. - - - Assigns the unbound TriggerData structure to the V1 trigger instance. - - - Checks the bind value for any conversion. - The key (property) name. - The value. - - - Gets the unbound value or a default. - Return type. - The property name. - The default value if not found in unbound value list. - The unbound value, if set, or the default value. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Fluent helper class. Not intended for use. - - - Adds a trigger that executes at logon of all users. - instance. - - - Adds a trigger that executes at logon of a specific user. - The user id. - instance. - - - Adds a trigger that executes at task registration. - instance. - - - Adds a trigger that executes every day or week. - The interval of days or weeks. - instance. - - - Adds a trigger that executes monthly on specific days. - The months of the year in which to run. - instance. - - - Adds a working directory to the . - The directory. - instance. - - - Adds a trigger that executes monthly on certain days of the week. - The days of the week on which to run. - instance. - - - Adds a trigger that executes at system startup. - instance. - - - Adds a trigger that executes once at a specific time. - instance. - - - Adds a trigger that executes when system is idle. - instance. - - - Adds a trigger that executes once at specified state change. - Type of the change. - instance. - - - Adds arguments to the . - The arguments. - instance. - - - Fluent helper class. Not intended for use. - - - Transitions to settings syntax. - - - Assigns the name of the task and registers it. - The name. - A registered instance. - - - Assigns the name of the task and registers it. - The name. - A union of flags. - The user credentials used to register the task. - The password for the userId used to register the task. - A value that defines what logon technique is used to run the registered task. - A registered instance. - - - Fluent helper class. Not intended for use. - - - Specifies that an Every target uses days as the interval. - instance. - - - Specifies that an Every target uses weeks as the interval. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify in which weeks of the month it will run. - The week. - instance. - - - Updates a monthly trigger to specify the months of the year in which it will run. - The month of the year. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a monthly trigger to specify the days of the month on which it will run. - The days. - instance. - - - Fluent helper class. Not intended for use. - - - Indicates that the task will be started even if the computer is running on battery power. - instance. - - - - Indicates that the task will be started even if the task is triggered to run in a Remote Applications Integrated Locally - (RAIL) session. - - instance. - - - Sets the task data to a string. - instance. - - - Sets the amount of time that the Task Scheduler will wait before deleting the task after it expires. - instance. - - - Indicates that the task cannot be started with the Run command or the Context menu. - instance. - - - Indicates that the task may not be terminated by using TerminateProcess. - instance. - - - Sets the amount of time that is allowed to complete the task. - instance. - - - Sets the policy that defines how the Task Scheduler handles multiple instances of the task. - instance. - - - Indicates that the task will not be stopped if the computer switches to battery power. - instance. - - - Indicates that the Task Scheduler will run the task only if the computer is in an idle condition. - instance. - - - Indicates that the Task Scheduler will run the task only when a network is available. - instance. - - - Sets the priority level of the task. - instance. - - - Sets a value that specifies how long the Task Scheduler will attempt to restart the task. - instance. - - - Indicates that the Task Scheduler can start the task at any time after its scheduled time has passed. - instance. - - - Indicates that the Task Scheduler will wake the computer when it is time to run the task. - instance. - - - Fluent helper class. Not intended for use. - - - Specifies a date on which a trigger will no longer run. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will no longer run. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will no longer run. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will no longer run. - The DateTime value. - instance. - - - Determines whether this trigger is disabled. - instance. - - - Specifies a repetition interval for the trigger. - The interval span. - instance. - - - Specifies a repetition interval for the trigger. - The interval span string. Must be parsable by . - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span. - instance. - - - Specifies the maximum amount of time to repeat the execution of a trigger. - The duration span string. Must be parsable by . - instance. - - - Specifies a date on which a trigger will start. - The year. - The month. - The day. - instance. - - - Specifies a date and time on which a trigger will start. - The year. - The month. - The day. - The hour. - The min. - The sec. - instance. - - - Specifies a date and time on which a trigger will start. - A string representing a DateTime and parsable via . - instance. - - - Specifies a date and time on which a trigger will start. - The DateTime value. - instance. - - - Fluent helper class. Not intended for use. - - - Updates a weekly trigger to specify the days of the week on which it will run. - The days of the week. - instance. - - - Fluent helper class. Not intended for use. - - - Values for days of the week (Monday, Tuesday, etc.) - - - Sunday - - - Monday - - - Tuesday - - - Wednesday - - - Thursday - - - Friday - - - Saturday - - - All days - - - Values for months of the year (January, February, etc.) - - - January - - - February - - - March - - - April - - - May - - - June - - - July - - - August - - - September - - - October - - - November - - - December - - - All months - - - Defines the type of triggers that can be used by tasks. - - - Triggers the task when a specific event occurs. Version 1.2 only. - - - Triggers the task at a specific time of day. - - - Triggers the task on a daily schedule. - - - Triggers the task on a weekly schedule. - - - Triggers the task on a monthly schedule. - - - Triggers the task on a monthly day-of-week schedule. - - - Triggers the task when the computer goes into an idle state. - - - Triggers the task when the task is registered. Version 1.2 only. - - - Triggers the task when the computer boots. - - - Triggers the task when a specific user logs on. - - - Triggers the task when a specific user session state changes. Version 1.2 only. - - - Triggers the custom trigger. Version 1.3 only. - - - Values for week of month (first, second, ..., last) - - - First week of the month - - - Second week of the month - - - Third week of the month - - - Fourth week of the month - - - Last week of the month - - - Every week of the month - - - Interface that categorizes the trigger as a calendar trigger. - - - Interface for triggers that support a delay. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Interface for triggers that support a user identifier. - - - Gets or sets the user for the . - - - Represents a trigger that starts a task when the system is booted. - - A BootTrigger will fire when the system starts. It can only be delayed. All triggers that support a delay implement the - ITriggerDelay interface. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a custom trigger. This class is based on undocumented features and may change. This type of trigger is only - available for reading custom triggers. It cannot be used to create custom triggers. - - - - Gets a value that indicates the amount of time between the trigger events and when the task is started. - This value cannot be set. - - - Gets the name of the custom trigger type. - The name of the XML element representing this custom trigger. - - - Gets the properties from the XML definition if possible. - - - Clones this instance. - This method will always throw an exception. - CustomTrigger cannot be cloned due to OS restrictions. - - - Updates custom properties from XML provided by definition. - The XML from the TaskDefinition. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a daily schedule. For example, the task starts at a specific time every day, every - other day, every third day, and so on. - - A DailyTrigger will fire at a specified time every day or interval of days. - - - - - - - - Creates an unbound instance of a . - Interval between the days in the schedule. - - - Sets or retrieves the interval between the days in the schedule. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a system event occurs. Only available for Task Scheduler 2.0 on Windows Vista or - Windows Server 2003 and later. - - The EventTrigger runs when a system event fires. - - - "; - eTrigger.ValueQueries.Add("Name", "Value"); - ]]> - - - - - Creates an unbound instance of a . - - - Initializes an unbound instance of the class and sets a basic event. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the XPath query string that identifies the event that fires the trigger. - - - - Gets a collection of named XPath queries. Each query in the collection is applied to the last matching event XML returned from - the subscription query specified in the Subscription property. The name of the query can be used as a variable in the message of - a action. - - - - Builds an event log XML query string based on the input parameters. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - XML query string. - log - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets basic event information. - The event's log. - The event's source. Can be null. - The event's id. Can be null. - true if subscription represents a basic event, false if not. - - - - Sets the subscription for a basic event. This will replace the contents of the property and clear all - entries in the property. - - The event's log. - The event's source. Can be null. - The event's id. Can be null. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when the computer goes into an idle state. For information about idle conditions, see Task - Idle Conditions. - - - An IdleTrigger will fire when the system becomes idle. It is generally a good practice to set a limit on how long it can run using - the ExecutionTimeLimit property. - - - - - - - - - Creates an unbound instance of a . - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task when a user logs on. When the Task Scheduler service starts, all logged-on users are - enumerated and any tasks registered with logon triggers that match the logged on user are run. Not available on Task Scheduler 1.0. - - - A LogonTrigger will fire after a user logs on. It can only be delayed. Under V2, you can specify which user it applies to. - - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - - Gets or sets The identifier of the user. For example, "MyDomain\MyName" or for a local account, "Administrator". - This property can be in one of the following formats: - • User name or SID: The task is started when the user logs on to the computer. - • NULL: The task is started when any user logs on to the computer. - - - If you want a task to be triggered when any member of a group logs on to the computer rather than when a specific user logs on, - then do not assign a value to the LogonTrigger.UserId property. Instead, create a logon trigger with an empty - LogonTrigger.UserId property and assign a value to the principal for the task using the Principal.GroupId property. - - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task on a monthly day-of-week schedule. For example, the task starts on every first Thursday, May - through October. - - - - Creates an unbound instance of a . - The days of the week. - The months of the year. - The weeks of the month. - - - Gets or sets the days of the week during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last week of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets the weeks of the month during which the task runs. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - - Represents a trigger that starts a job based on a monthly schedule. For example, the task starts on specific days of specific months. - - - - Creates an unbound instance of a . - - The day of the month. This must be a value between 1 and 32. If this value is set to 32, then the value will be set and no days will be added regardless of the month. - - The months of the year. - - - Gets or sets the days of the month during which the task runs. - - - Gets or sets the months of the year during which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a Boolean value that indicates that the task runs on the last day of the month. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Converts an array of bit indices into a mask with bits turned ON at every index contained in the array. Indices must be from 1 - to 32 and bits are numbered the same. - - An array with an element for each bit of the mask which is ON. - An integer to be interpreted as a mask. - - - Compares two collections. - Item type of collections. - The first collection. - The second collection - true if the collections values are equal; false otherwise. - - - - Convert an integer representing a mask to an array where each element contains the index of a bit that is ON in the mask. Bits - are considered to number from 1 to 32. - - An integer to be interpreted as a mask. - An array with an element for each bit of the mask which is ON. - - - Reads the subclass XML for V1 streams. - The reader. - - - - Represents a trigger that starts a task when the task is registered or updated. Not available on Task Scheduler 1.0. Only - available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - The RegistrationTrigger will fire after the task is registered (saved). It is advisable to put in a delay. - - - - - - - - Creates an unbound instance of a . - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - Not supported under Task Scheduler 1.0. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Defines how often the task is run and how long the repetition pattern is repeated after the task is started. - This can be used directly or by assignment for a . - - - - - - - - Initializes a new instance of the class. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - The duration of how long the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, - the pattern is repeated indefinitely. - - - If set to true the running instance of the task is stopped at the end of repetition pattern duration. - - - - Occurs when a property value changes. - - - Gets or sets how long the pattern is repeated. - - The duration that the pattern is repeated. The minimum time allowed is one minute. If TimeSpan.Zero is specified, the - pattern is repeated indefinitely. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - - Gets or sets the amount of time between each restart of the task. - - The amount of time between each restart of the task. The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - If you specify a repetition duration for a task, you must also specify the repetition interval. - - The maximum time allowed is 31 days, and the minimum time allowed is 1 minute. - - - - - Gets or sets a Boolean value that indicates if a running instance of the task is stopped at the end of repetition pattern duration. - - - - Releases all resources used by this class. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - Determines whether any properties for this have been set. - true if properties have been set; otherwise, false. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - - Triggers tasks for console connect or disconnect, remote connect or disconnect, or workstation lock or unlock notifications. - Only available for Task Scheduler 2.0 on Windows Vista or Windows Server 2003 and later. - - - The SessionStateChangeTrigger will fire after six different system events: connecting or disconnecting locally or remotely, or - locking or unlocking the session. - - - - - - - - - Creates an unbound instance of a . - - - Initializes a new instance of the class. - The state change. - The user identifier. - - - Gets or sets a value that indicates the amount of time between when the system is booted and when the task is started. - - - Gets or sets the kind of Terminal Server session change that would trigger a task launch. - - - - Gets or sets the user for the Terminal Server session. When a session state change is detected for this user, a task is started. - - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Returns a value indicating if the StateChange property has been set. - StateChange property has been set. - - - Represents a trigger that starts a task at a specific date and time. - A TimeTrigger runs at a specified date and time. - - - - - - - - Creates an unbound instance of a . - - - Creates an unbound instance of a and assigns the execution time. - Date and time for the trigger to fire. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - - Represents a trigger that starts a task based on a weekly schedule. For example, the task starts at 8:00 A.M. on a specific day of - the week every week or every other week. - - A WeeklyTrigger runs at a specified time on specified days of the week every week or interval of weeks. - - - - - - - - Creates an unbound instance of a . - The days of the week. - The interval between the weeks in the schedule. - - - Gets or sets the days of the week on which the task runs. - - - Gets or sets a delay time that is randomly added to the start time of the trigger. - Not supported under Task Scheduler 1.0. - - - Gets or sets the interval between the weeks in the schedule. - - - Gets or sets a value that indicates the amount of time before the task is started. - The delay duration. - - - - Copies the properties from another the current instance. This will not copy any properties associated with - any derived triggers except those supporting the interface. - - The source . - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Gets the non-localized trigger string for V2 triggers. - String describing the trigger. - - - Reads the subclass XML for V1 streams. - The reader. - - - Writes the subclass XML for V1 streams. - The writer. - - - Provides the methods that are used to add to, remove from, and get the triggers of a task. - - - Occurs when a collection changes. - - - Occurs when a property value changes. - - - Gets the number of triggers in the collection. - - - Gets or sets a specified trigger from the collection. - The . - The id ( ) of the trigger to be retrieved. - Specialized instance. - - - - Mismatching Id for trigger and lookup. - - - Gets a specified trigger from the collection. - The index of the trigger to be retrieved. - Specialized instance. - - - Add an unbound to the task. - A type derived from . - derivative to add to the task. - Bound trigger. - unboundTrigger is null. - - - Add a new trigger to the collections of triggers for the task. - The type of trigger to create. - A instance of the specified type. - - - Adds a collection of unbound triggers to the end of the . - - The triggers to be added to the end of the . The collection itself cannot be null and - cannot contain null elements. - - is null. - - - Clears all triggers from the task. - - - Determines whether the contains a specific value. - The object to locate in the . - true if is found in the ; otherwise, false. - - - Determines whether the specified trigger type is contained in this collection. - Type of the trigger. - true if the specified trigger type is contained in this collection; otherwise, false. - - - - Copies the elements of the to an , starting at a particular index. - - - The one-dimensional that is the destination of the elements copied from . The - must have zero-based indexing. - - The zero-based index in at which copying begins. - - - - Copies the elements of the to a array, starting at a particular array index. - - The zero-based index in the source at which copying begins. - - The array that is the destination of the elements copied from . The array must have zero-based indexing. - - The zero-based index in array at which copying begins. - The number of elements to copy. - is null. - is less than 0. - - The number of elements in the source is greater than the available space from to the end of the destination . - - - - Releases all resources used by this class. - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the first - occurrence within the entire collection. - - - The delegate that defines the conditions of the to search for. - - - The first that matches the conditions defined by the specified predicate, if found; otherwise, null. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection that starts at the specified index and contains the specified number of elements. - - The zero-based starting index of the search. - The number of elements in the collection to search. - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - - Searches for an that matches the conditions defined by the specified predicate, and returns the zero-based - index of the first occurrence within the collection. - - The delegate that defines the conditions of the element to search for. - - The zero-based index of the first occurrence of an element that matches the conditions defined by match, if found; otherwise, –1. - - - - Gets the collection enumerator for this collection. - The for this collection. - - - Determines the index of a specific item in the . - The object to locate in the . - The index of if found in the list; otherwise, -1. - - - Determines the index of a specific item in the . - The id ( ) of the trigger to be retrieved. - The index of if found in the list; otherwise, -1. - - - Inserts an trigger at the specified index. - The zero-based index at which trigger should be inserted. - The trigger to insert into the list. - - - Removes the first occurrence of a specific object from the . - The object to remove from the . - - true if was successfully removed from the ; otherwise, false. This method - also returns false if is not found in the original . - - - - Removes the trigger at a specified index. - Index of trigger to remove. - Index out of range. - - - Copies the elements of the to a new array. - An array containing copies of the elements of the . - - - Returns a that represents the triggers in this collection. - A that represents the triggers in this collection. - - - Called when a property has changed to notify any attached elements. - Name of the property. - - - Releases all resources used by this class. - - - Represents a system account. - - - Initializes a new instance of the class. - - Name of the user. This can be in the format DOMAIN\username or username@domain.com or username or - null (for current user). - - - - Initializes a new instance of the class. - The . - - - Gets the current user. - The current user. - - - Gets the identity. - The identity. - - - Gets a value indicating whether this instance is in an administrator role. - true if this instance is an admin; otherwise, false. - - - Gets a value indicating whether this instance is the interactive user. - true if this instance is the current user; otherwise, false. - - - Gets a value indicating whether this instance is a service account. - true if this instance is a service account; otherwise, false. - - - Gets a value indicating whether this instance is the SYSTEM account. - true if this instance is the SYSTEM account; otherwise, false. - - - Gets the SID string. - The SID string. - - - Gets the NT name (DOMAIN\username). - The name of the user. - - - Create a instance from a SID string. - The SID string. - A instance. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Determines whether the specified , is equal to this instance. - The to compare with this instance. - true if the specified is equal to this instance; otherwise, false. - - - Indicates whether the current object is equal to another object of the same type. - An object to compare with this object. - true if the current object is equal to the parameter; otherwise, false. - - - Returns a hash code for this instance. - A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. - - - - Options for a task, used for the Flags property of a Task. Uses the - "Flags" attribute, so these values are combined with |. - Some flags are documented as Windows 95 only, but they have a - user interface in Windows XP so that may not be true. - - - - - The interactive flag is set if the task is intended to be displayed to the user. - If the flag is not set, no user interface associated with the task is presented - to the user when the task is executed. - - - - - The task will be deleted when there are no more scheduled run times. - - - - - The task is disabled. This is useful to temporarily prevent a task from running - at the scheduled time(s). - - - - - The task begins only if the computer is not in use at the scheduled start time. Windows 95 only. - - - - - The task terminates if the computer makes an idle to non-idle transition while the task is running. - The computer is not considered idle until the IdleWait triggers' time elapses with no user input. - Windows 95 only. For information regarding idle triggers, see . - - - - - The task does not start if its target computer is running on battery power. Windows 95 only. - - - - - The task ends, and the associated application quits if the task's target computer switches - to battery power. Windows 95 only. - - - - - The task runs only if the system is docked. Windows 95 only. - - - - - The work item created will be hidden. - - - - - The task runs only if there is currently a valid Internet connection. - This feature is currently not implemented. - - - - - The task starts again if the computer makes a non-idle to idle transition before all the - task's task_triggers elapse. (Use this flag in conjunction with KillOnIdleEnd.) Windows 95 only. - - - - - The task runs only if the SYSTEM account is available. - - - - - The task runs only if the user specified in SetAccountInformation is logged on interactively. - This flag has no effect on work items set to run in the local account. - - - - - Status values returned for a task. Some values have been determined to occur although - they do no appear in the Task Scheduler system documentation. - - - - The task is ready to run at its next scheduled time. - - - The task is currently running. - - - One or more of the properties that are needed to run this task on a schedule have not been set. - - - The task has not yet run. - - - The task will not run at the scheduled times because it has been disabled. - - - There are no more runs scheduled for this task. - - - The last run of the task was terminated by the user. - - - Either the task has no triggers or the existing triggers are disabled or not set. - - - Event triggers don't have set run times. - - - Valid types of triggers - - - Trigger is set to run the task a single time. - - - Trigger is set to run the task on a daily interval. - - - Trigger is set to run the work item on specific days of a specific week of a specific month. - - - Trigger is set to run the task on a specific day(s) of the month. - - - Trigger is set to run the task on specific days, weeks, and months. - - - Trigger is set to run the task if the system remains idle for the amount of time specified by the idle wait time of the task. - - - Trigger is set to run the task at system startup. - - - Trigger is set to run the task when a user logs on. - - - - Represents a wildcard running on the - engine. - - - - - Initializes a wildcard with the given search pattern and options. - - The wildcard pattern to match. - A combination of one or more . - - - - Converts a wildcard to a regular expression. - - The wildcard pattern to convert. - A regular expression equivalent of the given wildcard. - - - - The GlobalLock function locks a global memory object and returns a pointer to the first byte of the object's memory block. - GlobalLock function increments the lock count by one. - Needed for the clipboard functions when getting the data from IDataObject - - - - - - - The GlobalUnlock function decrements the lock count associated with a memory object. - - - - - - - Defines the errors returned by the status member of the DS_NAME_RESULT_ITEM structure. These are potential errors that may be encountered while a name is converted by the DsCrackNames function. - - - - The conversion was successful. - - - Generic processing error occurred. - - - The name cannot be found or the caller does not have permission to access the name. - - - The input name is mapped to more than one output name or the desired format did not have a single, unique value for the object found. - - - The input name was found, but the associated output format cannot be found. This can occur if the object does not have all the required attributes. - - - Unable to resolve entire name, but was able to determine in which domain object resides. The caller is expected to retry the call at a domain controller for the specified domain. The entire name cannot be resolved, but the domain that the object resides in could be determined. The pDomain member of the DS_NAME_RESULT_ITEM contains valid data when this error is specified. - - - A syntactical mapping cannot be performed on the client without transmitting over the network. - - - The name is from an external trusted forest. - - - - Used to define how the name syntax will be cracked. These flags are used by the DsCrackNames function. - - - - Indicate that there are no associated flags. - - - Perform a syntactical mapping at the client without transferring over the network. The only syntactic mapping supported is from DS_FQDN_1779_NAME to DS_CANONICAL_NAME or DS_CANONICAL_NAME_EX. - - - Force a trip to the DC for evaluation, even if this could be locally cracked syntactically. - - - The call fails if the domain controller is not a global catalog server. - - - Enable cross forest trust referral. - - - - Provides formats to use for input and output names for the DsCrackNames function. - - - - Indicates the name is using an unknown name type. This format can impact performance because it forces the server to attempt to match all possible formats. Only use this value if the input format is unknown. - - - Indicates that the fully qualified distinguished name is used. For example: "CN = someone, OU = Users, DC = Engineering, DC = Fabrikam, DC = Com" - - - Indicates a Windows NT 4.0 account name. For example: "Engineering\someone" The domain-only version includes two trailing backslashes (\\). - - - Indicates a user-friendly display name, for example, Jeff Smith. The display name is not necessarily the same as relative distinguished name (RDN). - - - Indicates a GUID string that the IIDFromString function returns. For example: "{4fa050f0-f561-11cf-bdd9-00aa003a77b6}" - - - Indicates a complete canonical name. For example: "engineering.fabrikam.com/software/someone" The domain-only version includes a trailing forward slash (/). - - - Indicates that it is using the user principal name (UPN). For example: "someone@engineering.fabrikam.com" - - - This element is the same as DS_CANONICAL_NAME except that the rightmost forward slash (/) is replaced with a newline character (\n), even in a domain-only case. For example: "engineering.fabrikam.com/software\nsomeone" - - - Indicates it is using a generalized service principal name. For example: "www/www.fabrikam.com@fabrikam.com" - - - Indicates a Security Identifier (SID) for the object. This can be either the current SID or a SID from the object SID history. The SID string can use either the standard string representation of a SID, or one of the string constants defined in Sddl.h. For more information about converting a binary SID into a SID string, see SID Strings. The following is an example of a SID string: "S-1-5-21-397955417-626881126-188441444-501" - - - - Class that provides methods against a AD domain service. - - - - - - Initializes a new instance of the class. - - Name of the domain controller. - Name of the DNS domain. - - - - - Converts a directory service object name from any format to the UPN. - - The name to convert. - The corresponding UPN. - Unable to resolve user name. - - - - Converts an array of directory service object names from one format to another. Name conversion enables client applications to map between the multiple names used to identify various directory service objects. - - The names to convert. - Values used to determine how the name syntax will be cracked. - Format of the input names. - Desired format for the output names. - An array of DS_NAME_RESULT_ITEM structures. Each element of this array represents a single converted name. - - - - Impersonation of a user. Allows to execute code under another - user context. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - - - - Constructor. Starts the impersonation with the given credentials. - Please note that the account that instantiates the Impersonator class - needs to have the 'Act as part of operating system' privilege set. - - The name of the user to act as. - The domain name of the user to act as. - The password of the user to act as. - - - - Indicates that the value of the marked element could be null sometimes, - so the check for null is necessary before its usage. - - - [CanBeNull] object Test() => null; - - void UseTest() { - var p = Test(); - var s = p.ToString(); // Warning: Possible 'System.NullReferenceException' - } - - - - - Indicates that the value of the marked element could never be null. - - - [NotNull] object Foo() { - return null; // Warning: Possible 'null' assignment - } - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can never be null. - - - - - Can be appplied to symbols of types derived from IEnumerable as well as to symbols of Task - and Lazy classes to indicate that the value of a collection item, of the Task.Result property - or of the Lazy.Value property can be null. - - - - - Indicates that the marked method builds string by format pattern and (optional) arguments. - Parameter, which contains format string, should be given in constructor. The format string - should be in -like form. - - - [StringFormatMethod("message")] - void ShowError(string message, params object[] args) { /* do something */ } - - void Foo() { - ShowError("Failed: {0}"); // Warning: Non-existing argument in format string - } - - - - - Specifies which parameter of an annotated method should be treated as format-string - - - - - For a parameter that is expected to be one of the limited set of values. - Specify fields of which type should be used as values for this parameter. - - - - - Indicates that the function argument should be string literal and match one - of the parameters of the caller function. For example, ReSharper annotates - the parameter of . - - - void Foo(string param) { - if (param == null) - throw new ArgumentNullException("par"); // Warning: Cannot resolve symbol - } - - - - - Indicates that the method is contained in a type that implements - System.ComponentModel.INotifyPropertyChanged interface and this method - is used to notify that some property value changed. - - - The method should be non-static and conform to one of the supported signatures: - - NotifyChanged(string) - NotifyChanged(params string[]) - NotifyChanged{T}(Expression{Func{T}}) - NotifyChanged{T,U}(Expression{Func{T,U}}) - SetProperty{T}(ref T, T, string) - - - - public class Foo : INotifyPropertyChanged { - public event PropertyChangedEventHandler PropertyChanged; - - [NotifyPropertyChangedInvocator] - protected virtual void NotifyChanged(string propertyName) { ... } - - string _name; - - public string Name { - get { return _name; } - set { _name = value; NotifyChanged("LastName"); /* Warning */ } - } - } - - Examples of generated notifications: - - NotifyChanged("Property") - NotifyChanged(() => Property) - NotifyChanged((VM x) => x.Property) - SetProperty(ref myField, value, "Property") - - - - - - Describes dependency between method input and output. - - -

Function Definition Table syntax:

- - FDT ::= FDTRow [;FDTRow]* - FDTRow ::= Input => Output | Output <= Input - Input ::= ParameterName: Value [, Input]* - Output ::= [ParameterName: Value]* {halt|stop|void|nothing|Value} - Value ::= true | false | null | notnull | canbenull - - If method has single input parameter, it's name could be omitted.
- Using halt (or void/nothing, which is the same) for method output - means that the methos doesn't return normally (throws or terminates the process).
- Value canbenull is only applicable for output parameters.
- You can use multiple [ContractAnnotation] for each FDT row, or use single attribute - with rows separated by semicolon. There is no notion of order rows, all rows are checked - for applicability and applied per each program state tracked by R# analysis.
-
- - - [ContractAnnotation("=> halt")] - public void TerminationMethod() - - - [ContractAnnotation("halt <= condition: false")] - public void Assert(bool condition, string text) // regular assertion method - - - [ContractAnnotation("s:null => true")] - public bool IsNullOrEmpty(string s) // string.IsNullOrEmpty() - - - // A method that returns null if the parameter is null, - // and not null if the parameter is not null - [ContractAnnotation("null => null; notnull => notnull")] - public object Transform(object data) - - - [ContractAnnotation("=> true, result: notnull; => false, result: null")] - public bool TryParse(string s, out Person result) - - -
- - - Indicates that marked element should be localized or not. - - - [LocalizationRequiredAttribute(true)] - class Foo { - string str = "my string"; // Warning: Localizable string - } - - - - - Indicates that the value of the marked type (or its derivatives) - cannot be compared using '==' or '!=' operators and Equals() - should be used instead. However, using '==' or '!=' for comparison - with null is always permitted. - - - [CannotApplyEqualityOperator] - class NoEquality { } - - class UsesNoEquality { - void Test() { - var ca1 = new NoEquality(); - var ca2 = new NoEquality(); - if (ca1 != null) { // OK - bool condition = ca1 == ca2; // Warning - } - } - } - - - - - When applied to a target attribute, specifies a requirement for any type marked - with the target attribute to implement or inherit specific type or types. - - - [BaseTypeRequired(typeof(IComponent)] // Specify requirement - class ComponentAttribute : Attribute { } - - [Component] // ComponentAttribute requires implementing IComponent interface - class MyComponent : IComponent { } - - - - - Indicates that the marked symbol is used implicitly (e.g. via reflection, in external library), - so this symbol will not be marked as unused (as well as by other usage inspections). - - - - - Should be used on attributes and causes ReSharper to not mark symbols marked with such attributes - as unused (as well as by other usage inspections) - - - - Only entity marked with attribute considered used. - - - Indicates implicit assignment to a member. - - - - Indicates implicit instantiation of a type with fixed constructor signature. - That means any unused constructor parameters won't be reported as such. - - - - Indicates implicit instantiation of a type. - - - - Specify what is considered used implicitly when marked - with or . - - - - Members of entity marked with attribute are considered used. - - - Entity marked with attribute and all its members considered used. - - - - This attribute is intended to mark publicly available API - which should not be removed and so is treated as used. - - - - - Tells code analysis engine if the parameter is completely handled when the invoked method is on stack. - If the parameter is a delegate, indicates that delegate is executed while the method is executed. - If the parameter is an enumerable, indicates that it is enumerated while the method is executed. - - - - - Indicates that a method does not make any observable state changes. - The same as System.Diagnostics.Contracts.PureAttribute. - - - [Pure] int Multiply(int x, int y) => x * y; - - void M() { - Multiply(123, 42); // Waring: Return value of pure method is not used - } - - - - - Indicates that the return value of method invocation must be used. - - - - - Indicates the type member or parameter of some type, that should be used instead of all other ways - to get the value that type. This annotation is useful when you have some "context" value evaluated - and stored somewhere, meaning that all other ways to get this value must be consolidated with existing one. - - - class Foo { - [ProvidesContext] IBarService _barService = ...; - - void ProcessNode(INode node) { - DoSomething(node, node.GetGlobalServices().Bar); - // ^ Warning: use value of '_barService' field - } - } - - - - - Indicates that a parameter is a path to a file or a folder within a web project. - Path can be relative or absolute, starting from web root (~). - - - - - An extension method marked with this attribute is processed by ReSharper code completion - as a 'Source Template'. When extension method is completed over some expression, it's source code - is automatically expanded like a template at call site. - - - Template method body can contain valid source code and/or special comments starting with '$'. - Text inside these comments is added as source code when the template is applied. Template parameters - can be used either as additional method parameters or as identifiers wrapped in two '$' signs. - Use the attribute to specify macros for parameters. - - - In this example, the 'forEach' method is a source template available over all values - of enumerable types, producing ordinary C# 'foreach' statement and placing caret inside block: - - [SourceTemplate] - public static void forEach<T>(this IEnumerable<T> xs) { - foreach (var x in xs) { - //$ $END$ - } - } - - - - - - Allows specifying a macro for a parameter of a source template. - - - You can apply the attribute on the whole method or on any of its additional parameters. The macro expression - is defined in the property. When applied on a method, the target - template parameter is defined in the property. To apply the macro silently - for the parameter, set the property value = -1. - - - Applying the attribute on a source template method: - - [SourceTemplate, Macro(Target = "item", Expression = "suggestVariableName()")] - public static void forEach<T>(this IEnumerable<T> collection) { - foreach (var item in collection) { - //$ $END$ - } - } - - Applying the attribute on a template method parameter: - - [SourceTemplate] - public static void something(this Entity x, [Macro(Expression = "guid()", Editable = -1)] string newguid) { - /*$ var $x$Id = "$newguid$" + x.ToString(); - x.DoSomething($x$Id); */ - } - - - - - - Allows specifying a macro that will be executed for a source template - parameter when the template is expanded. - - - - - Allows specifying which occurrence of the target parameter becomes editable when the template is deployed. - - - If the target parameter is used several times in the template, only one occurrence becomes editable; - other occurrences are changed synchronously. To specify the zero-based index of the editable occurrence, - use values >= 0. To make the parameter non-editable when the template is expanded, use -1. - > - - - - Identifies the target parameter of a source template if the - is applied on a template method. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC action. If applied to a method, the MVC action name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC area. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is - an MVC controller. If applied to a method, the MVC controller name is calculated - implicitly from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.ChildActionExtensions.RenderAction(HtmlHelper, String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC Master. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC model type. Use this attribute - for custom wrappers similar to System.Web.Mvc.Controller.View(String, Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter is an MVC - partial view. If applied to a method, the MVC partial view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.RenderPartialExtensions.RenderPartial(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Allows disabling inspections for MVC views within a class or a method. - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC display template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.DisplayExtensions.DisplayForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC editor template. - Use this attribute for custom wrappers similar to - System.Web.Mvc.Html.EditorExtensions.EditorForModel(HtmlHelper, String). - - - - - ASP.NET MVC attribute. Indicates that a parameter is an MVC template. - Use this attribute for custom wrappers similar to - System.ComponentModel.DataAnnotations.UIHintAttribute(System.String). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component. If applied to a method, the MVC view name is calculated implicitly - from the context. Use this attribute for custom wrappers similar to - System.Web.Mvc.Controller.View(Object). - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component name. - - - - - ASP.NET MVC attribute. If applied to a parameter, indicates that the parameter - is an MVC view component view. If applied to a method, the MVC view component view name is default. - - - - - ASP.NET MVC attribute. When applied to a parameter of an attribute, - indicates that this parameter is an MVC action name. - - - [ActionName("Foo")] - public ActionResult Login(string returnUrl) { - ViewBag.ReturnUrl = Url.Action("Foo"); // OK - return RedirectToAction("Bar"); // Error: Cannot resolve action - } - - - - - Razor attribute. Indicates that a parameter or a method is a Razor section. - Use this attribute for custom wrappers similar to - System.Web.WebPages.WebPageBase.RenderSection(String). - - - - - Indicates how method, constructor invocation or property access - over collection type affects content of the collection. - - - - Method does not use or modify content of the collection. - - - Method only reads content of the collection but does not modify it. - - - Method can change content of the collection but does not add new elements. - - - Method can add new elements to the collection. - - - - Indicates that the marked method is assertion method, i.e. it halts control flow if - one of the conditions is satisfied. To set the condition, mark one of the parameters with - attribute. - - - - - Indicates the condition parameter of the assertion method. The method itself should be - marked by attribute. The mandatory argument of - the attribute is the assertion type. - - - - - Specifies assertion type. If the assertion method argument satisfies the condition, - then the execution continues. Otherwise, execution is assumed to be halted. - - - - Marked parameter should be evaluated to true. - - - Marked parameter should be evaluated to false. - - - Marked parameter should be evaluated to null value. - - - Marked parameter should be evaluated to not null value. - - - - Indicates that the marked method unconditionally terminates control flow execution. - For example, it could unconditionally throw exception. - - - - - Indicates that method is pure LINQ method, with postponed enumeration (like Enumerable.Select, - .Where). This annotation allows inference of [InstantHandle] annotation for parameters - of delegate type by analyzing LINQ method chains. - - - - - Indicates that IEnumerable, passed as parameter, is not enumerated. - - - - - Indicates that parameter is regular expression pattern. - - - - - Prevents the Member Reordering feature from tossing members of the marked class. - - - The attribute must be mentioned in your member reordering patterns - - - - - XAML attribute. Indicates the type that has ItemsSource property and should be treated - as ItemsControl-derived type, to enable inner items DataContext type resolve. - - - - - XAML attribute. Indicates the property of some BindingBase-derived type, that - is used to bind some item of ItemsControl-derived type. This annotation will - enable the DataContext type resolve for XAML bindings for such properties. - - - Property should have the tree ancestor of the ItemsControl type or - marked with the attribute. - - - - Extensions for classes in the System.Security.AccessControl namespace. - - - Canonicalizes the specified Access Control List. - The Access Control List. - - - Sort ACEs according to canonical form for this . - The object security whose DiscretionaryAcl will be made canonical. - - - Returns an array of byte values that represents the information contained in this object. - The object. - The byte array into which the contents of the is marshaled. - - - - Converts the string representation of the name or numeric value of one or more enumerated constants to an equivalent enumerated object or returns the value of . If is undefined, it returns the first declared item in the enumerated type. - - The enumeration type to which to convert . - The string representation of the enumeration name or underlying value to convert. - true to ignore case; false to consider case. - The default value. - An object of type whose value is represented by value. - - - - - - The application - - - The system - - - The custom - - - - - - The circular - - - The automatic backup - - - The retain - - - - - - The administrative - - - The operational - - - The analytical - - - The debug - - - PathType - - - The file path - - - The log name - - - SessionAuthentication - - - The default - - - The negotiate - - - The kerberos - - - The NTLM - - - Defines the standard keywords that are attached to events by the event provider. For more information about keywords, see . - - - The audit failure - - - The audit success - - - The correlation hint - - - The correlation hint2 - - - The event log classic - - - The none - - - The response time - - - The SQM - - - The wdi context - - - The wdi diagnostic - - - - Represents a placeholder (bookmark) within an event stream. You can use the placeholder to mark a position and return to this position in a stream of - events. An instance of this object can be obtained from an EventRecord object, in which case it corresponds to the position of that event record. - - - - Initializes a new instance of the class. - The information. - The context. - - - Gets the object data. - The information. - The context. - - - - Represents a keyword for an event. Keywords are defined in an event provider and are used to group the event with other similar events (based on the - usage of the events). - - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - Contains an event level that is defined in an event provider. The level signifies the severity of the event. - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - EventLogConfiguration - - - Initializes a new instance of the class. - Name of the log. - - - Initializes a new instance of the class. - Name of the log. - The session. - - - Gets a value indicating whether this instance is classic log. - true if this instance is classic log; otherwise, false. - - - Gets or sets a value indicating whether this instance is enabled. - true if this instance is enabled; otherwise, false. - - - Gets or sets the log file path. - The log file path. - - - Gets the log isolation. - The log isolation. - - - Gets or sets the log mode. - The log mode. - - - Gets the name of the log. - The name of the log. - - - Gets the type of the log. - The type of the log. - - - Gets or sets the maximum size in bytes. - The maximum size in bytes. - - - Gets the name of the owning provider. - The name of the owning provider. - - - Gets the size of the provider buffer. - The size of the provider buffer. - - - Gets the provider control unique identifier. - The provider control unique identifier. - - - Gets or sets the provider keywords. - The provider keywords. - - - Gets the provider latency. - The provider latency. - - - Gets or sets the provider level. - The provider level. - - - Gets the provider maximum number of buffers. - The provider maximum number of buffers. - - - Gets the provider minimum number of buffers. - The provider minimum number of buffers. - - - Gets the provider names. - The provider names. - - - Gets or sets the security descriptor. - The security descriptor. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Saves the changes. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Allows you to access the run-time properties of active event logs and event log files. These properties include the number of events in the log, the size of the log, a value that determines whether the log is full, and the last time the log was written to or accessed. - - - - Gets the attributes. - The attributes. - - - Gets the creation time. - The creation time. - - - Gets the size of the file. - The size of the file. - - - Gets the is log full. - The is log full. - - - Gets the last access time. - The last access time. - - - Gets the last write time. - The last write time. - - - Gets the oldest record number. - The oldest record number. - - - Gets the record count. - The record count. - - - - Represents a link between an event provider and an event log that the provider publishes events into. This object cannot be instantiated. - - - - Gets the display name. - The display name. - - - Gets a value indicating whether this instance is imported. - true if this instance is imported; otherwise, false. - - - Gets the name of the log. - The name of the log. - - - - Contains an array of strings that represent XPath queries for elements in the XML representation of an event, which is based on the Event Schema. The queries in this object are used to extract values from the event. - - - - - Initializes a new instance of the class. - The property queries. - - - Releases unmanaged and - optionally - managed resources. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Contains the properties of an event instance for an event that is received from an EventLogReader object. The event properties provide information about the event such as the name of the computer where the event was logged and the time that the event was created. - - - - - Gets the activity identifier. - The activity identifier. - - - Gets the bookmark. - The bookmark. - - - Gets the container log. - The container log. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the keywords display names. - The keywords display names. - - - Gets the level. - The level. - - - Gets the display name of the level. - The display name of the level. - - - Gets the name of the log. - The name of the log. - - - Gets the name of the machine. - The name of the machine. - - - Gets the matched query ids. - The matched query ids. - - - Gets the opcode. - The opcode. - - - Gets the display name of the opcode. - The display name of the opcode. - - - Gets the process identifier. - The process identifier. - - - Gets the properties. - The properties. - - - Gets the provider identifier. - The provider identifier. - - - Gets the name of the provider. - The name of the provider. - - - Gets the qualifiers. - The qualifiers. - - - Gets the record identifier. - The record identifier. - - - Gets the related activity identifier. - The related activity identifier. - - - Gets the task. - The task. - - - Gets the display name of the task. - The display name of the task. - - - Gets the thread identifier. - The thread identifier. - - - Gets the time created. - The time created. - - - Gets the user identifier. - The user identifier. - - - Gets the version. - The version. - - - Formats the description. - - - - Formats the description. - The values. - - - - Gets the property values. - The property selector. - - - - To the XML. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Enables you to read events from an event log based on an event query. The events that are read by this object are returned as EventRecord objects. - - - - - Initializes a new instance of the class. - - - Initializes a new instance of the class. - The server. - - - Initializes a new instance of the class. - The server. - The domain. - The user. - The password. - Type of the log on. - - - Gets the global session. - The global session. - - - Cancels the current operations. - - - Clears the log. - Name of the log. - - - Clears the log. - Name of the log. - The backup path. - logName - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Exports the log. - The path. - Type of the path. - The query. - The target file path. - - - Exports the log. - The path. - Type of the path. - The query. - The target file path. - if set to true [tolerate query errors]. - path or targetFilePath - pathType - - - Exports the log and messages. - The path. - Type of the path. - The query. - The target file path. - - - Exports the log and messages. - The path. - Type of the path. - The query. - The target file path. - if set to true [tolerate query errors]. - The target culture information. - - - Gets the log information. - Name of the log. - Type of the path. - - logName - - - Gets the log names. - - - - Gets the provider names. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - Contains the metadata (properties and settings) for an event that is defined in an event provider. - - - Gets the description. - The description. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the level. - The level. - - - Gets the log link. - The log link. - - - Gets the opcode. - The opcode. - - - Gets the task. - The task. - - - Gets the template. - The template. - - - Gets the version. - The version. - - - - Contains an event opcode that is defined in an event provider. An opcode defines a numeric value that identifies the activity or a point within an activity that the application was performing when it raised the event. - - - - Gets the display name. - The display name. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - - Contains the value of an event property that is specified by the event provider when the event is published. - - - - Gets the value. - The value. - - - - Contains the value of an event property that is specified by the event provider when the event is published. - - Contains the properties of an event instance for an event that is received from an EventLogReader object. The event properties provide information about - the event such as the name of the computer where the event was logged and the time that the event was created. - - - - Initializes a new instance of the class. - - - Gets the activity identifier. - The activity identifier. - - - Gets the bookmark. - The bookmark. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the keywords display names. - The keywords display names. - - - Gets the level. - The level. - - - Gets the display name of the level. - The display name of the level. - - - Gets the name of the log. - The name of the log. - - - Gets the name of the machine. - The name of the machine. - - - Gets the opcode. - The opcode. - - - Gets the display name of the opcode. - The display name of the opcode. - - - Gets the process identifier. - The process identifier. - - - Gets the properties. - The properties. - - - Gets the provider identifier. - The provider identifier. - - - Gets the name of the provider. - The name of the provider. - - - Gets the qualifiers. - The qualifiers. - - - Gets the record identifier. - The record identifier. - - - Gets the related activity identifier. - The related activity identifier. - - - Gets the task. - The task. - - - Gets the display name of the task. - The display name of the task. - - - Gets the thread identifier. - The thread identifier. - - - Gets the time created. - The time created. - - - Gets the user identifier. - The user identifier. - - - Gets the version. - The version. - - - Releases unmanaged and - optionally - managed resources. - - - Formats the description. - - - - Formats the description. - The values. - - - - To the XML. - - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - the custom event handler args. - - - - If any error occurred during subscription, this will be non-null. After a notification containing an exception, no more notifications will be made - for this subscription. - - - - - The EventRecord being notified. - NOTE: If non null, then caller is required to call Dispose(). - - - - - Contains an event task that is defined in an event provider. The task identifies a portion of an application or a component that publishes an event. A task is a 16-bit value with 16 top values reserved. - - - - Gets the display name. - The display name. - - - Gets the event unique identifier. - The event unique identifier. - - - Gets the name. - The name. - - - Gets the value. - The value. - - - - Contains static information about an event provider, such as the name and id of the provider, and the collection of events defined in the provider. - - - - - Initializes a new instance of the class. - Name of the provider. - - - Initializes a new instance of the class. - Name of the provider. - The session. - The target culture information. - - - Gets the display name. - The display name. - - - Gets the events. - The events. - - - Gets the help link. - The help link. - - - Gets the identifier. - The identifier. - - - Gets the keywords. - The keywords. - - - Gets the levels. - The levels. - - - Gets the log links. - The log links. - - - Gets the message file path. - The message file path. - - - Gets the name. - The name. - - - Gets the opcodes. - The opcodes. - - - Gets the parameter file path. - The parameter file path. - - - Gets the resource file path. - The resource file path. - - - Gets the tasks. - The tasks. - - - Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. - - - Releases unmanaged and - optionally - managed resources. - true to release both managed and unmanaged resources; false to release only unmanaged resources. - - - - - - - - Allows you to access the run-time properties of active event logs and event log files. These properties include the number of events in the log, the size - of the log, a value that determines whether the log is full, and the last time the log was written to or accessed. - - - - Represents a link between an event provider and an event log that the provider publishes events into. This object cannot be instantiated. - - - - Contains an array of strings that represent XPath queries for elements in the XML representation of an event, which is based on the Event Schema. The - queries in this object are used to extract values from the event. - - - - - Contains the status code or error code for a specific event log. This status can be used to determine if the event log is available for an operation. - - - - Gets the name of the log. - The name of the log. - - - Gets the status code. - The status code. - - - Used for subscribing to event record notifications from event log. - - - Maintains cached display / metadata information returned from EventRecords that were obtained from this reader. - - - Initializes a new instance of the class. - The path. - - - Initializes a new instance of the class. - The event query. - - - Initializes a new instance of the class. - The event query. - The bookmark. - - - Initializes a new instance of the class. - The event query. - The bookmark. - if set to true [read existing events]. - eventQuery - - - - Occurs when [event record written]. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - Output type for the CLI array. must be able to convert to . - The pointing to the native array. - The number of items in the native array. - An array of type containing the converted elements of the native array. - - - - Converts an that points to a C-style array into a CLI array. - - Type of native structure used by the C-style array. - The pointing to the native array. - The number of items in the native array. - An array of type containing the elements of the native array. - - - Extensions related to System.Reflection - - - Loads a type from a named assembly. - Name of the type. - The name or path of the file that contains the manifest of the assembly. - The reference, or null if type or assembly not found. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly reference name from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Tries the retrieve a reference from an assembly. - Name of the type. - The assembly from which to load the type. - The reference, if found. - true if the type was found in the assembly; otherwise, false. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. This method assumes the type has a default public constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on a created instance of a type with parameters. - The expected type of the method's return value. - The type to be instantiated and then used to invoke the method. - The arguments to supply to the constructor. - Name of the method. - The arguments to provide to the method invocation. - The value returned from the method. - - - Invokes a named method on an object with parameters and no return value. - The object on which to invoke the method. - Name of the method. - The arguments to provide to the method invocation. - - - Invokes a named method on an object with parameters and no return value. - The expected type of the method's return value. - The object on which to invoke the method. - Name of the method. - The types of the . - The arguments to provide to the method invocation. - The value returned from the method. - - - Gets a named property value from an object. - The expected type of the property to be returned. - The object from which to retrieve the property. - Name of the property. - The default value to return in the instance that the property is not found. - The property value, if found, or the if not. - - - Sets a named property on an object. - The type of the property to be set. - The object on which to set the property. - Name of the property. - The property value to set on the object. - -
-
diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/de/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/de/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 9e3b12d..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/de/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/es/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/es/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 317d84b..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/es/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index e537502..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/fr/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/it/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/it/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 4914d9e..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/it/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index caaf53a..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/pl/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 44fd158..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/ru/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll b/packages/TaskScheduler.2.9.0/lib/netstandard2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll deleted file mode 100644 index 9c6ca96..0000000 Binary files a/packages/TaskScheduler.2.9.0/lib/netstandard2.0/zh-CN/Microsoft.Win32.TaskScheduler.resources.dll and /dev/null differ diff --git a/packages/TaskScheduler.2.9.0/tsnew48.png b/packages/TaskScheduler.2.9.0/tsnew48.png deleted file mode 100644 index 32ae11c..0000000 Binary files a/packages/TaskScheduler.2.9.0/tsnew48.png and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/.signature.p7s b/packages/Vestris.ResourceLib.2.1.0/.signature.p7s deleted file mode 100644 index b7e511b..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/.signature.p7s and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/Vestris.ResourceLib.2.1.0.nupkg b/packages/Vestris.ResourceLib.2.1.0/Vestris.ResourceLib.2.1.0.nupkg deleted file mode 100644 index 2e27b1b..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/Vestris.ResourceLib.2.1.0.nupkg and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.dll b/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.dll deleted file mode 100644 index d4327eb..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.dll and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.xml b/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.xml deleted file mode 100644 index ca74d41..0000000 --- a/packages/Vestris.ResourceLib.2.1.0/lib/net20/Vestris.ResourceLib.xml +++ /dev/null @@ -1,6603 +0,0 @@ - - - - Vestris.ResourceLib - - - - - Standard accelerator. - - - - - Read the accelerator. - - Address in memory. - - - - Write accelerator to a binary stream. - - Binary stream. - - - - String representation of the accelerator key. - - - - - An unsigned integer value that identifies the accelerator. - - - - - String representation of the accelerator. - - String representation of the accelerator. - - - - An accelerator, RT_ACCELERATOR resource. - An accelerator provides the user with access to an application's command set. - - - - - Accelerator keys. - - - - - A new accelerator resource. - - - - - An existing accelerator resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the accelerators table. - - Handle to a module. - Pointer to the beginning of the accelerator table. - Address of the end of the accelerator table. - - - - String representation of the accelerators resource. - - - - - - Creates an 8 bit aligned copy of the buffer if it is not already aligned - - - - - A bitmap file in a .bmp format. - - - - - Device independent bitmap. - - - - - An existing bitmap file. - - A file in a .bmp format. - - - - An embedded bitmap resource. - - - - - An existing bitmap resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new bitmap resource. - - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the bitmap resource to a binary stream. - - Binary stream. - - - - A device independent bitmap. - - - - - This structure depicts the organization of data in a hardware-independent cursor resource. - - - - - A hardware-independent cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent cursor resource. - - - - - A new collection of cursors that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a cursor resource. - - - - - An existing cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new cursor resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Language. - An icon resource. - - - - Horizontal hotspot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Vertical hot spot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Write the cursor data to a file. - - Target executable file. - - - - Read DIB image. - - DIB bits. - DIB size. - - - - A device-independent image consists of a BITMAPINFOHEADER where - bmWidth is the width of the image andbmHeight is double the height - of the image, followed by the bitmap color table, followed by the image - pixels, followed by the mask pixels. - - - - - Raw image data. - - - - - Bitmap info header. - - - - - Bitmap size in bytes. - - - - - A new icon image. - - - - - A device-independent bitmap. - - Bitmap data. - - - - Create a copy of an image. - - Source image. - - - - Read icon data. - - Pointer to the beginning of icon data. - Icon data size. - - - - Size of the image mask. - - - - - Position of the DIB bitmap bits within a DIB bitmap array. - - - - - Number of colors in the palette. - - - - - Returns the width of a row in a DIB Bitmap given the number of bits. DIB Bitmap rows always align on a DWORD boundary. - - Number of bits. - Width of a row in bytes. - - - - Bitmap monochrome mask. - - - - - Bitmap color (XOR) part of the image. - - - - - Complete image. - - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - Indicates the character set to use. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Weight of the font. - - - - - Indicates whether the font is italic. - - - - - Number of dialog items. - - - - - An extended dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write dialog control to a binary stream. - - Binary stream. - - - - String representation of the dialog. - - String in the DIALOGEX [dialog] format. - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - An extended dialog control template structure. - - - - - Read the dialog control. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Return a string representation of the dialog control. - - A single line in the "CLASS name id, dimensions and styles' format. - - - - A dialog template resource. - - - - - A dialog template structure that describes the dialog. - - - - - A structured dialog resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A structured dialog resource embedded in an executable module. - - - - - Dialog resource in standard resource editor text format. - - Multi-line string. - - - - A container for the DIALOGTEMPLATE structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Number of dialog items. - - - - - A standard dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog template data to a binary stream. - - Binary stream. - - - - Returns a string representation of the dialog. - - String in the DIALOG ... format. - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Number of items in this structure. - - - - - The name of the typeface for the font. - - - - - Point size of the font to use for the text in the dialog box and its controls. - - - - - Dialog caption. - - - - - Menu resource Id. - - - - - Window class Id. - - - - - Controls within this dialog. - - - - - Dialog template representation in a standard text format. - - Multiline string. - - - - String represetnation of a control. - - - - - - Write the resource to a binary stream. - - Binary stream. - - - - A container for a control within a dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - A standard dialog control structure. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - String represetnation of a control. - - - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Dialog caption. - - - - - Window class Id. - - - - - Window class of the control. - - - - - Additional creation data. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Dialog template utility functions. - - - - - Read a dialog resource id. - - Address in memory. - Resource read. - - - - - String representation of the dialog or control style of two types. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control styles of two types. - - Dialog or control style. - Dialog or control extended style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control style of one type. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - Returns the type of the resource in this group. - - - - - Icons contained in this hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - Save a hardware-independent icon resource to an executable file. - - Name of an executable file (.exe or .dll). - - - - Read a hardware-independent icon resource from a loaded module. - - Loaded executable module. - Pointer to the beginning of a hardware-independent icon resource. - Pointer to the end of the hardware-independent icon resource. - - - - Write a hardware-independent icon resource to a binary stream. - - Binary stream. - - - - Fixed file information. - - - - - Default Windows fixed file information. - - - - - Fixed file info structure. - - - - - Read the fixed file information structure. - - Address in memory. - - - - String representation of the file version. - - - - - String representation of the protect version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - Write fixed file information to a binary stream. - - Binary stream. - - - - Size of the VS_FIXEDFILEINFO structure. - - - - - String representation of the fixed file info. - - String representation of the fixed file info. - - - - A font directory entry. - - - - - Font ordinal. - - - - - Typeface name of the font. - - - - - Specifies the name of the device if this font file is designated for a specific device. - - - - - Font information. - - - - - A new font directory entry. - - - - - Read the font directory entry. - - Pointer in memory. - Pointer to the end of the font directory entry. - - - - Write the font directory entry to a binary stream. - - Binary stream. - - - - A font directory, RT_FONTDIR resource. - - - - - Number of fonts in this directory. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font directory to a binary stream. - - Binary stream. - - - - A font, RT_FONT resource. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font resource to a binary writer. - - Binary writer. - - - - Gdi32.dll interop functions. - - - - - Bitmap compression options. - - - - - An uncompressed format. - - - - - A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression. - - - - - An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression. - - - - - Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image. - - - - - A bitmap info header. - See http://msdn.microsoft.com/en-us/library/ms532290.aspx for more information. - - - - - Bitmap information size. - - - - - Bitmap width. - - - - - Bitmap height. - - - - - Number of logical planes. - - - - - Bitmap bitrate. - - - - - Bitmap compression. - - - - - Image size. - - - - - Horizontal pixel resolution. - - - - - Vertical pixel resolution. - - - - - - - - - - - - - - - Returns the current bitmap compression. - - - - - Bitmap pixel format. - - - - - Bitmap pixel format English standard string. - - - - - Defines the dimensions and color information of a Windows-based device-independent bitmap (DIB). - http://msdn.microsoft.com/en-us/library/dd183375(VS.85).aspx. - - - - - Specifies a bitmap information header structure that contains information about the dimensions of color format. - - - - - An array of RGBQUAD. The elements of the array make up the color table. - - - - - Store colors in a paletised icon (2, 4 or 8 bit). - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Blue. - - - - - Green. - - - - - Red. - - - - - Reserved. - - - - - The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - http://msdn.microsoft.com/en-us/library/dd183374(VS.85).aspx - - - - - The file type; must be BM. - - - - - The size, in bytes, of the bitmap file. - - - - - Reserved; must be zero. - - - - - Reserved; must be zero. - - - - - The offset, in bytes, from the beginning of the BITMAPFILEHEADER structure to the bitmap bits. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Retrieves the bits of the specified compatible bitmap and copies them into a buffer as - a DIB using the specified format - - A handle to the device context. - A handle to the bitmap. This must be a compatible bitmap (DDB). - The first scan line to retrieve. - The number of scan lines to retrieve. - A pointer to a buffer to receive the bitmap data. - A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data. - The format of the bmiColors member of the BITMAPINFO structure. - - If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap. - If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is non-zero. - If the function fails, the return value is zero. - - - - - Create a DIB that applications can write to directly. The function gives you a pointer to the location - of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use - to create the bitmap, or you can let the system allocate the memory for the bitmap. - - Handle to a device context. - A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors. - The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal RGB values). - A pointer to a variable that receives a pointer to the location of the DIB bit values. - A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL. - The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. - - If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values. - If the function fails, the return value is NULL, and *ppvBits is NULL. - - - - - Defines how to interpret the values in the color table of a DIB. - - - - - The color table contains literal RGB values. - - - - - The color table consists of an array of 16-bit indexes into the LogPalette - object that is currently defined in the playback device context. - - - - - No color table exists. The pixels in the DIB are indices into the current logical - palette in the playback device context. - - - - - - - - - - Creates a memory device context (DC) compatible with the specified device. - - Handle to an existing device context. - - The handle to a memory device context indicates success. - NULL indicates failure. - - - - - - - Specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. - Specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). - This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows. - A pointer to a DEVMODE structure containing device-specific initialization data for the device driver. - - - - - Creates a bitmap compatible with the device that is associated with the specified device context. - - A handle to a device context. - The bitmap width, in pixels. - The bitmap height, in pixels. - - If the function succeeds, the return value is a handle to the compatible bitmap (DDB). - If the function fails, the return value is NULL. - - - - - Selects an object into a specified device context. The new object replaces the previous object of the same type. - - Handle to the device context. - Handle to the object to be selected. - - If the selected object is not a region, the handle of the object being replaced indicates success. - If the selected object is a region, one of the following values indicates success. - - - - - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. - - Handle to a logical pen, brush, font, bitmap, region, or palette. - - Nonzero indicates success. - Zero indicates that the specified handle is not valid or that the handle is currently selected into a device context. - - - - - Deletes the specified device context. - - A handle to the device context. - - If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. - - - - - A generic resource. - - - - - Raw resource data. - - - - - Raw resource data. - - - - - An unstructured generic resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A generic resource. - - Resource name. - Resource type. - Resource language. - - - - Read a generic resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - A new collection of icons that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a .ico file. - - - - - Resource type. - - - - - Icon. - - - - - Cursor. - - - - - Type of the group icon resource. - - - - - Collection of icons in an .ico file. - - - - - An existing .ico file. - - An existing icon (.ico) file. - - - - Load from a .ico file. - - An existing icon (.ico) file. - - - - Read icons. - - Pointer to the beginning of a FILEGRPICONDIR structure. - Pointer to the end of a FILEGRPICONDIR structure. - - - - This structure depicts the organization of icon data in a .ico file. - - - - - Icon header. - - - - - Icon bitmap. - - - - - New icon data. - - - - - Icon width. - - - - - Icon height. - - - - - Image size in bytes. - - - - - Read a single icon (.ico). - - Pointer to the beginning of this icon's data. - Pointer to the beginning of all icon data. - Pointer to the end of this icon's data. - - - - Icon size as a string. - - Icon size in the width x height format. - - - - This structure depicts the organization of data in an icon resource. - - - - - Directory header. - - - - - Actual image. - - - - - Hardware-independent icon directory header. - - - - - Embedded icon Id. - - - - - An icon image. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Create a new icon image resource from a file icon. - - File icon. - Resource type. - Resource id. - Resource language. - - - - Icon width in pixels. - - - - - Icon height in pixels. - - - - - Image size in bytes. - - - - - Read an icon resource from a previously loaded module. - - Module handle. - Pointer to a directory entry in the hardware-independent icon resource. - Pointer to the end of the icon resource. - - - - Read the bitmap image. - - DIB bits. - Size of image. - - - - Icon pixel format. - - - - - Icon pixel format English standard string. - - - - - String representation of the icon. - - A string in a format of width x height followed by the pixel format. - - - - Write icon resource data to a binary stream. - - Binary stream. - - - - Save icon to a file. - - Target executable file. - - - - This structure depicts the organization of data in an icon resource. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Resource language. - An icon resource. - - - - Kernel32.dll interop functions. - - - - - A resource header. - - - - - Header length. - - - - - Data length. - - - - - Resource type. - - - - - A new resource header of a given length. - - - - - - Resource header type. - - - - - Binary data. - - - - - String data. - - - - - Language and code page combinations. - The low-order word of each DWORD must contain a Microsoft language identifier, - and the high-order word must contain the IBM code page number. - Either high-order or low-order word can be zero, indicating that the file is language - or code page independent. - - - - - Microsoft language identifier. - - - - - IBM code page number. - - - - - This structure contains version information about a file. - This information is language- and code page–independent. - http://msdn.microsoft.com/en-us/library/ms647001.aspx - - - - - Contains the value 0xFEEF04BD. This is used with the szKey member of the VS_VERSIONINFO structure when searching a file for the VS_FIXEDFILEINFO structure. - - - - - Specifies the binary version number of this structure. The high-order word of this member contains the major version number, and the low-order word contains the minor version number. - - - - - Specifies the most significant 32 bits of the file's binary version number. This member is used with dwFileVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the file's binary version number. This member is used with dwFileVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the most significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Contains a bitmask that specifies the valid bits in dwFileFlags. A bit is valid only if it was defined when the file was created. - - - - - Contains a bitmask that specifies the Boolean attributes of the file. - - - - - Specifies the operating system for which this file was designed. - - - - - Specifies the general type of file. - - - - - Specifies the function of the file. - - - - - Specifies the most significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Specifies the least significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Creates a default Windows VS_FIXEDFILEINFO structure. - - A default Windows VS_FIXEDFILEINFO. - - - - A hardware-independent icon directory resource header. - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Reserved, must be zero. - - - - - Resource type, 1 for icons. - - - - - Number of images. - - - - - Hardware-independent icon directory entry. - See http://msdn.microsoft.com/en-us/library/ms997538.aspx for more information. - - - - - Width of the image. Starting with Windows 95 a value of 0 represents width of 256. - - - - - Height of the image. Starting with Windows 95 a value of 0 represents height of 256. - - - - - Number of colors in the image. - bColors = 1 << (wBitsPerPixel * wPlanes) - If wBitsPerPixel* wPlanes is greater orequal to 8, then bColors = 0. - - - - - Reserved. - - - - - Number of bitmap planes. - 1: monochrome bitmap - - - - - Bits per pixel. - 1: monochrome bitmap - - - - - Image size in bytes. - - - - - Icon ID. - - - - - Hardware-independent icon directory entry in an .ico file. - - - - - Icon width. - - - - - Icon height. - - - - - Colors; 0 means 256 or more. - - - - - Reserved. - - - - - Number of bitmap planes for icons. - Horizontal hotspot for cursors. - - - - - Bits per pixel for icons. - Vertical hostpot for cursors. - - - - - Image size in bytes. - - - - - Offset of bitmap data from the beginning of the file. - - - - - Hardware-independent icon structure in an .ico file. - - - - - Reserved, must be zero. - - - - - Resource Type (1 for icons). - - - - - Number of images. - - - - - If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. - - - - - If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. - - - - - If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy. - - - - - If this value is used, the system does not perform automatic trust comparisons on the DLL or its dependents when they are loaded. - - - - - Loads the specified module into the address space of the calling process. - The specified module may cause other modules to be loaded. - - The name of the module. - This parameter is reserved for future use. - The action to be taken when loading the module. - - - - - Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. - - A handle to the loaded library module. - If the function succeeds, the return value is nonzero. - - - - Predefined resource types. - - - - - Hardware-dependent cursor resource. - - - - - Bitmap resource. - - - - - Hardware-dependent icon resource. - - - - - Menu resource. - - - - - Dialog box. - - - - - String-table entry. - - - - - Font directory resource. - - - - - Font resource. - - - - - Accelerator table. - - - - - Application-defined resource (raw data). - - - - - Message-table entry. - - - - - Hardware-independent cursor resource. - - - - - Hardware-independent icon resource. - - - - - Version resource. - - - - - Allows a resource editing tool to associate a string with an .rc file. - - - - - Plug and Play resource. - - - - - VXD. - - - - - Animated cursor. - - - - - Animated icon. - - - - - HTML. - - - - - Microsoft Windows XP: Side-by-Side Assembly XML Manifest. - - - - - Enumerates resource types within a binary module. - - Handle to a module to search. - Pointer to the callback function to be called for each enumerated resource type. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful; otherwise, FALSE. - - - - An application-defined callback function used with the EnumResourceTypes and EnumResourceTypesEx functions. - - The handle to the module whose executable file contains the resources for which the types are to be enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the type is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceTypes or EnumResourceTypesEx function. - Returns TRUE if successful; otherwise, FALSE. - - - - Enumerates resources of a specified type within a binary module. - - Handle to a module to search. - Pointer to a null-terminated string specifying the type of the resource for which the name is being enumerated. - Pointer to the callback function to be called for each enumerated resource name or ID. - Specifies an application-defined value passed to the callback function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - An application-defined callback function used with the EnumResourceNames and EnumResourceNamesEx functions. - - The handle to the module whose executable file contains the resources that are being enumerated. - Pointer to a null-terminated string specifying the type of resource that is being enumerated. - Specifies the name of a resource of the type being enumerated. - Specifies the application-defined parameter passed to the EnumResourceNames or EnumResourceNamesEx function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - Enumerates language-specific resources, of the specified type and name, associated with a binary module. - - The handle to a module to search. - Pointer to a null-terminated string specifying the type of resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Pointer to the callback function to be called for each enumerated resource language. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful or FALSE otherwise. - - - - An application-defined callback function used with the EnumResourceLanguages and EnumResourceLanguagesEx functions. - - The handle to the module whose executable file contains the resources for which the languages are being enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Specifies the language identifier for the resource for which the language is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceLanguages or EnumResourceLanguagesEx function. - Returns TRUE if successful or FALSE otherwise. - - - - Determines the location of the resource with the specified type, name, and language in the specified module. - - Handle to the module whose executable file contains the resource. - Pointer to a null-terminated string specifying the type name of the resource. - Pointer to a null-terminated string specifying the name of the resource. - Specifies the language of the resource. - If the function succeeds, the return value is a handle to the specified resource's information block. - - - - Locks the specified resource in memory. - - Handle to the resource to be locked. - If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL. - - - - Loads the specified resource into global memory. - - Handle to the module whose executable file contains the resource. - Handle to the resource to be loaded. - If the function succeeds, the return value is a handle to the data associated with the resource. - - - - Returns the size, in bytes, of the specified resource. - - Handle to the module whose executable file contains the resource. - Handle to the resource. This handle must be created by using the FindResource or FindResourceEx function. - If the function succeeds, the return value is the number of bytes in the resource. - - - - Closes an open object handle. - - A valid handle to an open object. - If the function succeeds, the return value is nonzero. - - - - Returns a handle to either a language-neutral portable executable file (LN file) or a - language-specific resource file (.mui file) that can be used by the UpdateResource function - to add, delete, or replace resources in a binary module. - - Pointer to a null-terminated string that specifies the binary file in which to update resources. - Specifies whether to delete the pFileName parameter's existing resources. - If the function succeeds, the return value is a handle that can be used by the UpdateResource and EndUpdateResource functions. - - - - Adds, deletes, or replaces a resource in a portable executable (PE) file. - There are some restrictions on resource updates in files that contain Resource Configuration (RC Config) data: - language-neutral (LN) files and language-specific resource (.mui) files. - - A module handle returned by the BeginUpdateResource function, referencing the file to be updated. - Pointer to a null-terminated string specifying the resource type to be updated. - Pointer to a null-terminated string specifying the name of the resource to be updated. - Specifies the language identifier of the resource to be updated. - Pointer to the resource data to be inserted into the file indicated by hUpdate. - Specifies the size, in bytes, of the resource data at lpData. - Returns TRUE if successful or FALSE otherwise. - - - - Commits or discards changes made prior to a call to UpdateResource. - - A module handle returned by the BeginUpdateResource function, and used by UpdateResource, referencing the file to be updated. - Specifies whether to write the resource updates to the file. If this parameter is TRUE, no changes are made. If it is FALSE, the changes are made: the resource updates will take effect. - Returns TRUE if the function succeeds; FALSE otherwise. - - - - Neutral primary language ID. - - - - - US-English primary language ID. - - - - - Neutral sublanguage ID. - - - - - US-English sublanguage ID. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID is used primarily for EXEs. If an executable has a resource of type RT_MANIFEST, - ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will create a process default activation context for the process. - The process default activation context will be used by all components running in the process. - CREATEPROCESS_MANIFEST_RESOURCE_ID can also used by DLLs. When Windows probe for dependencies, if the dll has - a resource of type RT_MANIFEST, ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will use that manifest as the - dependency. - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID is used primarily for DLLs. It should be used if the dll wants private - dependencies other than the process default. For example, if an dll depends on comctl32.dll version 6.0.0.0. - It should have a resource of type RT_MANIFEST, ID ISOLATIONAWARE_MANIFEST_RESOURCE_ID to depend on comctl32.dll - version 6.0.0.0, so that even if the process executable wants comctl32.dll version 5.1, the dll itself will still - use the right version of comctl32.dll. - - - - - When ISOLATION_AWARE_ENABLED is defined, Windows re-defines certain APIs. For example LoadLibraryExW - is redefined to IsolationAwareLoadLibraryExW. - - - - - Resource manifest type. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_NOSTATICIMPORT_MANIFEST_RESOURCE_ID - - - - - Copies the contents of a source memory block to a destination memory block, and supports overlapping source and destination memory blocks. - - A pointer to the starting address of the copied block's destination. - A pointer to the starting address of the block of memory to copy. - The size of the block of memory to copy, in bytes. - - - - A resource load exception. - - - - - The Win32 exception from a resource enumeration function. - - - - - A new resource load exception. - - Error message. - The inner exception thrown within a single resource. - The outer exception from the Win32 API. - - - - A combined message of the inner and outer exception. - - - - - An embedded SxS manifest. - - - - - Embedded XML manifest. - - - - - Manifest type. - - - - - An existing embedded manifest resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new executable CreateProcess manifest. - - - - - A new executable manifest. - - Manifest type. - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - Load a manifest resource from an executable file. - - Name of an executable file (.exe or .dll). - Manifest resource type. - - - - Extended menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write the menu template. - - Binary stream. - - - - String representation of the menu in the MENUEX format. - - String representation of the menu. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of extended menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - A command menu item. - - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - An extended popup menu item. - - - - - Sub menu items. - - - - - An extended popup menu item. - - - - - Read an extended popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENUEX format. - - String representation. - - - - A generic resource. - - - - - Menu template. - - - - - A structured menu resource. - - - - - A structured menu resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - Read a menu resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the menu resource to a binary stream. - - Binary stream. - - - - String representation of the menu resource in the MENU format. - - String representation of the menu resource. - - - - Standard menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write menu template to a binary stream. - - Binary stream. - - - - String representation of the menu in the MENU format. - - String representation of the menu. - - - - A menu template header. - - - - - Read the menu template header. - - Address in memory. - - - - Write the menu to a binary stream. - - Binary stream. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - Command menu id. - - - - - A command menu item. - - - - - Read a command menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A popup menu item. - - - - - Sub menu items. - - - - - A popup menu item. - - - - - Read a popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - A version resource. - - - - - Resource type. - - - - - Resource name. - - - - - Resource language. - - - - - Loaded binary nodule. - - - - - Pointer to the resource. - - - - - Resource size. - - - - - Version resource size in bytes. - - - - - Language ID. - - - - - Resource type. - - - - - String representation of the resource type. - - - - - Resource name. - - - - - A new resource. - - - - - A structured resource embedded in an executable module. - - Module handle. - Resource handle. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Lock and read the resource. - - Module handle. - Resource handle. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - Resource name. - Resource type. - Resource language. - - - - Load a resource from an executable (.exe or .dll) module. - - An executable (.exe or .dll) module. - Resource type. - Resource name. - Resource language. - - - - Read a resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - Write the resource to a memory stream. - - Binary stream. - - - - Return resource data. - - Resource data. - - - - Save a resource. - - Name of an executable file (.exe or .dll). - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Language id. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - Resource data. - - - - Save a batch of resources to a given file. - - Path to an executable file. - The resources to write. - - - - A resource Id. - There're two types of resource Ids, reserved integer numbers (eg. RT_ICON) and custom string names (eg. "CUSTOM"). - - - - - A resource identifier. - - A integer or string resource id. - - - - A resource identifier. - - A integer resource id. - - - - A well-known resource-type identifier. - - A well known resource type. - - - - A custom resource identifier. - - - - - - Resource Id. - - - If the resource Id is a string, it will be copied. - - - - - String representation of a resource type name. - - - - - An enumerated resource type for built-in resource types only. - - - - - Returns true if the resource is an integer resource. - - - - - Returns true if the resource is an integer resource. - - Resource pointer. - - - - Resource Id in a string format. - - - - - String representation of the resource Id. - - Resource name. - - - - Resource Id hash code. - Resource Ids of the same type have the same hash code. - - Resource Id. - - - - Compares two resource Ids by value. - - Resource Id. - True if both resource Ids represent the same resource. - - - - Resource info manager. - - - - - A dictionary of resources, the key is the resource type, eg. "REGISTRY" or "16" (version). - - - - - A shortcut for available resource types. - - - - - A new resource info. - - - - - Unload the previously loaded module. - - - - - Load an executable or a DLL and read its resources. - - Source filename. - - - - Enumerate resource types. - - Module handle. - Resource type. - Additional parameter. - TRUE if successful. - - - - Enumerate resource names within a resource by type - - Module handle. - Resource type. - Resource name. - Additional parameter. - TRUE if successful. - - - - Create a resource of a given type. - - Module handle. - Pointer to the resource in memory. - Resource type. - Resource name. - Language ID. - Size of resource. - A specialized or a generic resource. - - - - Enumerate resource languages within a resource by name - - Module handle. - Resource type. - Resource name. - Language ID. - Additional parameter. - TRUE if successful. - - - - Save resource to a file. - - Target filename. - - - - Dispose resource info object. - - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - A resource table header. - - - - - Resource table header. - - - - - Resource table key. - - - - - Resource table key. - - - - - Resource header. - - - - - A new resource table header. - - - - - An resource table header with a specific key. - - resource key - - - - An existing resource table. - - Pointer to resource table data. - - - - Read the resource header, return a pointer to the end of it. - - Top of header. - End of header, after the key, aligned at a 32 bit boundary. - - - - Write the resource table. - - Binary stream. - - - - String representation. - - String representation. - - - - String representation. - - Indent. - String representation. - - - - Resource utilities. - - - - - Align an address to a 4-byte boundary. - - Address in memory. - 4-byte aligned pointer. - - - - Align a pointer to a 4-byte boundary. - - Pointer to an address in memory. - 4-byte aligned pointer. - - - - Pad data to a WORD. - - Binary stream. - New position within the binary stream. - - - - Pad data to a DWORD. - - Binary stream. - New position within the binary stream. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Write a value at a given position. - Used to write a size of data in an earlier located header. - - Binary stream. - Value to write. - Address to write the value at. - - - - Pad bytes. - - Binary stream. - Number of bytes to write. - New position within the stream. - - - - Neutral language ID. - - - - - US-English language ID. - - - - - Make a language ID from a primary language ID (low-order 10 bits) and a sublanguage (high-order 6 bits). - - Primary language ID. - Sublanguage ID. - Microsoft language ID. - - - - Return the primary language ID from a Microsoft language ID. - - Microsoft language ID - primary language ID (low-order 10 bits) - - - - Return the sublanguage ID from a Microsoft language ID. - - Microsoft language ID. - Sublanguage ID (high-order 6 bits). - - - - Returns the memory representation of an object. - - Object type. - Data. - Object's representation in memory. - - - - Get a collection of flags from a flag value. - - Flag collection type. - Flag value. - Collection of flags. - - - - Get a string representation of flags. - - Flag collection type. - Flag vlaue - String representation of flags in the f1 | ... | fn format. - - - - This structure depicts the organization of data in a file-version resource. - It contains version information that can be displayed for a particular language and code page. - http://msdn.microsoft.com/en-us/library/aa908808.aspx - - - - - Resource strings. - - - - - A new string file-version resource. - - - - - An existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - - - - Read an existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - Pointer to the end of the string file-version resource. - - - - Write the string file-version resource to a binary stream. - - Binary stream. - - - - Default (first) string table. - - - - - Indexed string table. - - Key. - A string table at a given index. - - - - String representation of StringFileInfo. - - Indent. - String in the StringFileInfo format. - - - - A string, RT_STRING resource. - Each string resource block has 16 strings, each represented as an ordered pair - (length, text). Length is a WORD that specifies the size, in terms of the number of characters, - in the text that follows. Text follows length and contains the string in Unicode without the - NULL terminating character. There may be no characters in text, in which case length is zero. - - - - - String collection in this resource. - - - - - Returns a string of a given Id. - - String Id. - A string of a given Id. - - - - A new string resource. - - - - - A new string resource of a given block id. - - Block id. - - - - A new string resource of a given block id. - - Block id. - - - - An existing string resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A string with ID, stringId, is located in the block with ID given by the following formula. - http://support.microsoft.com/kb/q196774/ - - - - - String table block id. - - - - - Read the strings. - - Handle to a module. - Pointer to the beginning of the string table. - Address of the end of the string table. - - - - String representation of the strings resource. - - - - - - This structure depicts the organization of data in a file-version resource. It contains language - and code page formatting information for the strings. A code page is an ordered character set. - See http://msdn.microsoft.com/en-us/library/aa909192.aspx for more information. - - - - - Resource strings. - - - - - A new string table. - - - - - A new string table. - - String table key. - - - - An existing string table. - - Pointer to the beginning of the table. - - - - Read a string table. - - Pointer to the beginning of the string table. - Pointer to the end of the string table. - - - - Write the string table to a binary stream. - - Binary stream. - Last unpadded position. - - - - The four most significant digits of the key represent the language identifier. - Each Microsoft Standard Language identifier contains two parts: the low-order 10 bits - specify the major language, and the high-order 6 bits specify the sublanguage. - - - - - The four least significant digits of the key represent the code page for which the data is formatted. - - - - - Returns an entry within the string table. - - Key. - An entry within the string table. - - - - String representation of the string table. - - Indent. - String representation of the strings table. - - - - This structure depicts the organization of data in a file-version resource. It contains a string - that describes a specific aspect of a file, such as a file's version, its copyright notices, - or its trademarks. - http://msdn.microsoft.com/en-us/library/aa909025.aspx - - - - - The value is always stored double-null-terminated. - - - - - When set to true the length in the header will also contain the padding bytes when writing to a stream. - The MSDN reference (http://www.webcitation.org/6zBLYbvww) does not clarify which variant is 'right'. - - - - - String resource header. - - - - - Key. - - - - - String value (removing the double-null-terminator). - - - - - Value. - - - - - A new string resource. - - Key. - - - - An existing string resource. - - Pointer to the beginning of a string resource. - - - - Read a string resource. - - Pointer to the beginning of a string resource. - - - - Write a string resource to a binary stream. - - Binary stream. - - - - User32.dll functions. - - - - - Contains information about an icon or a cursor. - - - - - Specifies whether this structure defines an icon or a cursor. - A value of TRUE specifies an icon; FALSE specifies a cursor. - - - - - Specifies the x-coordinate of a cursor's hot spot. If this structure defines an icon, the hot spot is - always in the center of the icon, and this member is ignored. - - - - - Specifies the y-coordinate of the cursor's hot spot. If this structure defines an icon, the hot spot - is always in the center of the icon, and this member is ignored. - - - - - Specifies the icon bitmask bitmap. - - - - - Handle to the icon color bitmap. - - - - - Retrieve a handle to a device context (DC) for the client area of a specified window or for the entire screen. - - A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. - - If the function succeeds, the return value is a handle to the DC for the specified window's client area. - If the function fails, the return value is NULL. - - - - - Releases a device context (DC), freeing it for use by other applications. - - A handle to the window whose DC is to be released. - A handle to the DC to be released. - - The return value indicates whether the DC was released. If the DC was released, the return value is 1. - If the DC was not released, the return value is zero. - - - - - The DIALOGTEMPLATE structure defines the dimensions and style of a dialog box. - This structure, always the first in a standard template for a dialog box, - also specifies the number of controls in the dialog box and therefore specifies - the number of subsequent DIALOGITEMTEMPLATE structures in the template. - - - - - Specifies the style of the dialog box. - - - - - Extended styles for a window. - - - - - Specifies the number of items in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - The DIALOGITEMTEMPLATE structure defines the dimensions and style of a control in a dialog box. - - - - - Specifies the style of the control. - - - - - Extended styles for a window. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the width, in dialog box units, of the control. - - - - - Specifies the height, in dialog box units, of the control. - - - - - Specifies the control identifier. - - - - - An extended dialog box template begins with a DIALOGEXTEMPLATE header that describes - the dialog box and specifies the number of controls in the dialog box. For each - control in a dialog box, an extended dialog box template has a block of data that - uses the DIALOGEXITEMTEMPLATE format to describe the control. - - - - - Specifies the version number of the extended dialog box template. This member must be 1. - - - - - Indicates whether a template is an extended dialog box template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the number of controls in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - A control entry in an extended dialog template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - Specifies the control identifier. - - - - - Window styles. - http://msdn.microsoft.com/en-us/library/ms632600(VS.85).aspx - - - - - Creates an overlapped window. An overlapped window has a title bar and - a border. Same as the WS_TILED style. - - - - - Creates a pop-up window. This style cannot be used with the WS_CHILD style. - - - - - Creates a child window. A window with this style cannot have - a menu bar. This style cannot be used with the WS_POPUP style. - - - - - Creates a window that is initially minimized. Same as the WS_ICONIC style. - - - - - Creates a window that is initially visible. - - - - - Creates a window that is initially disabled. A disabled window cannot receive - input from the user. - - - - - Clips child windows relative to each other; that is, when a particular - child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips - all other overlapping child windows out of the region of the child window - to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, - it is possible, when drawing within the client area of a child window, to draw - within the client area of a neighboring child window. - - - - - Excludes the area occupied by child windows when drawing occurs - within the parent window. This style is used when creating the parent window. - - - - - Creates a window that is initially maximized. - - - - - Creates a window that has a title bar (includes the WS_BORDER style). - - - - - Creates a window that has a thin-line border. - - - - - Creates a window that has a border of a style typically used with dialog - boxes. A window with this style cannot have a title bar. - - - - - Creates a window that has a vertical scroll bar. - - - - - Creates a window that has a horizontal scroll bar. - - - - - Creates a window that has a window menu on its title bar. The WS_CAPTION - style must also be specified. - - - - - Creates a window that has a sizing border. Same as the WS_SIZEBOX style. - - - - - Specifies the first control of a group of controls. The group consists of this - first control and all controls defined after it, up to the next control with - the WS_GROUP style. The first control in each group usually has the WS_TABSTOP - style so that the user can move from group to group. The user can subsequently - change the keyboard focus from one control in the group to the next control in - the group by using the direction keys. - - - - - Specifies a control that can receive the keyboard focus when the user presses - the TAB key. Pressing the TAB key changes the keyboard focus to the next - control with the WS_TABSTOP style. - - - - - Dialog styles. - http://msdn.microsoft.com/en-us/library/ms644994(VS.85).aspx - - - - - Specifying this style in the dialog template tells Windows that the dtX and dtY values - of the DIALOGTEMPLATE struct are relative to the screen origin, not the owner of the - dialog box. - - - - - Create a dialog box with the WS_EX_TOPMOST flag. This flag cannot be combined with the - DS_CONTROL style. This flag is obsolete and is included for compatibility with 16-bit - versions of Windows. - - - - - Applies to 16-bit applications only. This style directs edit controls in the dialog - box to allocate memory from the application data segment. Otherwise, edit controls - allocate storage from a global memory object. - - - - - Indicates that the header of the dialog box template contains additional data specifying - the font to use for text in the client area and controls of the dialog box. - - - - - Creates a dialog box with a modal dialog-box frame that can be combined with a title - bar and window menu by specifying the WS_CAPTION and WS_SYSMENU styles. - - - - - Suppresses WM_ENTERIDLE messages that the system would otherwise send to the owner of the - dialog box while the dialog box is displayed. - - - - - Causes the system to use the SetForegroundWindow function to bring the dialog - box to the foreground. - - - - - Gives the dialog box a nonbold font and draws three-dimensional borders around - control windows in the dialog box. - - - - - Causes the dialog box to use the SYSTEM_FIXED_FONT instead of the default SYSTEM_FONT. - This is a monospace font compatible with the System font in 16-bit versions of Windows - earlier than 3.0. - - - - - Creates the dialog box even if errors occur — for example, if a child window cannot be - created or if the system cannot create a special data segment for an edit control. - - - - - Creates a dialog box that works well as a child window of another dialog box, - much like a page in a property sheet. This style allows the user to tab among - the control windows of a child dialog box, use its accelerator keys, and so on. - - - - - Centers the dialog box in the working area; that is, the area not obscured by the tray. - - - - - Centers the dialog box on the mouse cursor. - - - - - Includes a question mark in the title bar of the dialog box. When the user clicks the - question mark, the cursor changes to a question mark with a pointer. If the user then - clicks a control in the dialog box, the control receives a WM_HELP message. The control - should pass the message to the dialog box procedure, which should call the function - using the HELP_WM_HELP command. The help application displays a pop-up window that - typically contains help for the control. - - - - - Indicates that the dialog box should use the system font. - - - - - - - - - - Extended dialog styles. - - - - - Creates a window that has a double border; the window can, optionally, be created - with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY - message to its parent window when it is created or destroyed. - - - - - Specifies that a window created with this style should be placed above all non-topmost - windows and should stay above them, even when the window is deactivated. To add or remove - this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Specifies that a window created with this style should not be painted until siblings beneath - the window (that were created by the same thread) have been painted. The window appears - transparent because the bits of underlying sibling windows have already been painted. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. - A tool window has a title bar that is shorter than a normal title bar, and the - window title is drawn using a smaller font. A tool window does not appear in - the taskbar or in the dialog that appears when the user presses ALT+TAB. If a - tool window has a system menu, its icon is not displayed on the title bar. However, - you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window has a border with a raised edge. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, - the cursor changes to a question mark with a pointer. If the user then clicks a child window, - the child receives a WM_HELP message. The child window should pass the message to the parent - window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The - Help application displays a pop-up window that typically contains help for the child window. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has - an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls - has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with - button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment, the window text is displayed using right-to-left reading-order properties. - For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order - alignment, the vertical scroll bar (if present) is to the left of the client area. For other - languages, the style is ignored. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - The window itself contains child windows that should take part in dialog box navigation. - If this style is specified, the dialog manager recurses into children of this window when - performing navigation operations such as handling the TAB key, an arrow key, or a - keyboard mnemonic. - - - - - Creates a window with a three-dimensional border style intended to be used for items that - do not accept user input. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child - windows. Also, this cannot be used if the window has a class style of either CS_OWNDC - or CS_CLASSDC. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose - horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order - using double-buffering. For more information, see Remarks. This cannot be used - if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground - window when the user clicks it. The system does not bring this window to the foreground - when the user minimizes or closes the foreground window. - - - - - Possible DIALOGEXITEMTEMPLATE WindowClass ordinals. - - - - - A button. - - - - - An edit box. - - - - - A static control. - - - - - A list box. - - - - - A scroll bar. - - - - - A combo box. - - - - - Static control styles. - A static control specifies the STATIC class, appropriate window style constants, - and a combination of the following static control styles. - http://msdn.microsoft.com/en-us/library/bb760773(VS.85).aspx - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next left-aligned - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and centers the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next centered - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and right-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next - right-aligned line. Words that are longer than the width of the control - are truncated. - - - - - Specifies an icon to be displayed in the dialog box. If the control is created - as part of a dialog box, the text is the name of an icon (not a filename) defined - elsewhere in the resource file. If the control is created via CreateWindow or a - related function, the text is the name of an icon (not a filename) defined in the - resource file associated with the module specified by the hInstance parameter to - CreateWindow. The icon can be an animated cursor. - - - - - Specifies a rectangle filled with the current window frame color. - This color is black in the default color scheme. - - - - - Specifies a rectangle filled with the current screen background color. - This color is gray in the default color scheme. - - - - - Specifies a rectangle filled with the current window background color. This color is white - in the default color scheme. - - - - - Specifies a box with a frame drawn in the same color as the window frames. - This color is black in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the screen background (desktop). - This color is gray in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the window background. This color is - white in the default color scheme. - - - - - - - - - - Specifies a simple rectangle and displays a single line of left-aligned text in the rectangle. - The text line cannot be shortened or altered in any way. Also, if the control is disabled, - the control does not gray its text. - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - Tabs are expanded, but words are not wrapped. Text that extends past the - end of a line is clipped. - - - - - Specifies that the owner of the static control is responsible for drawing - the control. The owner window receives a WM_DRAWITEM message whenever the - control needs to be drawn. - - - - - Specifies that a bitmap is to be displayed in the static control. - The text is the name of a bitmap (not a filename) defined elsewhere in the - resource file. The style ignores the nWidth and nHeight parameters; the control - automatically sizes itself to accommodate the bitmap. - - - - - Specifies that an enhanced metafile is to be displayed in the static control. - The text is the name of a metafile. An enhanced metafile static control has a - fixed size; the metafile is scaled to fit the static control's client area. - - - - - Draws the top and bottom edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the left and right edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the frame of the static control using the EDGE_ETCHED edge style. - - - - - Windows 2000: A composite style bit that results from using the OR operator on - SS_* style bits. Can be used to mask out valid SS_* bits from a given bitmask. - Note that this is out of date and does not correctly include all valid styles. - Thus, you should not use this style. - - - - - Windows XP or later: Adjusts the bitmap to fit the size of the static control. - For example, changing the locale can change the system font, and thus controls - might be resized. If a static control had a bitmap, the bitmap would no longer - fit the control. This style bit dictates automatic redimensioning of bitmaps - to fit their controls. - - - - - Prevents interpretation of any ampersand characters in the control's text as - accelerator prefix characters. These are displayed with the ampersand removed and - the next character in the string underlined. This static control style may be - included with any of the defined static controls. You can combine SS_NOPREFIX - with other styles. This can be useful when filenames or other strings that may - contain an ampersand must be displayed in a static control in a dialog box. - - - - - Sends the parent window STN_CLICKED, STN_DBLCLK, STN_DISABLE, and STN_ENABLE - notification messages when the user clicks or double-clicks the control. - - - - - Specifies that a bitmap is centered in the static control that contains it. - The control is not resized, so that a bitmap too large for the control will - be clipped. If the static control contains a single line of text, the text - is centered vertically in the client area of the control. - - - - - Specifies that the lower right corner of a static control with the SS_BITMAP - or SS_ICON style is to remain fixed when the control is resized. Only the top - and left sides are adjusted to accommodate a new bitmap or icon. - - - - - Specifies that the actual resource width is used and the icon is loaded using - LoadImage. SS_REALSIZEIMAGE is always used in conjunction with SS_ICON. - - - - - Draws a half-sunken border around a static control. - - - - - Microsoft Windows 2000: Specifies that the static control duplicates the - text-displaying characteristics of a multiline edit control. Specifically, the - average character width is calculated in the same manner as with an edit control, - and the function does not display a partially visible last line. - - - - - Microsoft Windows NT or later: If the end of a string does not fit in the rectangle, - it is truncated and ellipses are added. If a word that is not at the end of the string - goes beyond the limits of the rectangle, it is truncated without ellipses. Using this - style will force the control’s text to be on one line with no word wrap. Compare with - SS_PATHELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Replaces characters in the middle of the string with ellipses so - that the result fits in the specified rectangle. If the string contains backslash (\) - characters, SS_PATHELLIPSIS preserves as much as possible of the text after the last - backslash. Using this style will force the control’s text to be on one line with no - word wrap. Compare with SS_ENDELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Truncates any word that does not fit in the rectangle and adds ellipses. - Using this style will force the control’s text to be on one line with no word wrap. - - - - - - - - - - Push button styles. - http://msdn.microsoft.com/en-us/library/bb775951(VS.85).aspx - - - - - Creates a push button that posts a WM_COMMAND message to the owner window when the - user selects the button. - - - - - Creates a push button that behaves like a BS_PUSHBUTTON style button, but has a distinct - appearance. If the button is in a dialog box, the user can select the button by pressing - the ENTER key, even when the button does not have the input focus. This style is useful - for enabling the user to quickly select the most likely (default) option. - - - - - Creates a small, empty check box with text. By default, the text is displayed to - the right of the check box. To display the text to the left of the check box, - combine this flag with the BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). - - - - - Creates a button that is the same as a check box, except that the check state - automatically toggles between checked and cleared each time the user selects the - check box. - - - - - Creates a small circle with text. By default, the text is displayed to the right of the - circle. To display the text to the left of the circle, combine this flag with the - BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). Use radio buttons for - groups of related, but mutually exclusive choices. - - - - - Creates a button that is the same as a check box, except that the box can be grayed - as well as checked or cleared. Use the grayed state to show that the state of the - check box is not determined. - - - - - Creates a button that is the same as a three-state check box, except that the box - changes its state when the user selects it. The state cycles through checked, - indeterminate, and cleared. - - - - - Creates a rectangle in which other controls can be grouped. Any text associated with - this style is displayed in the rectangle's upper left corner. - - - - - Obsolete, but provided for compatibility with 16-bit versions of Windows. Applications - should use BS_OWNERDRAW instead. - - - - - Creates a button that is the same as a radio button, except that when the user selects it, - the system automatically sets the button's check state to checked and automatically sets - the check state for all other buttons in the same group to cleared. - - - - - - - - - - Creates an owner-drawn button. The owner window receives a WM_DRAWITEM message when a visual - aspect of the button has changed. Do not combine the BS_OWNERDRAW style with any other - button styles. - - - - - Microsoft Windows 2000: A composite style bit that results from using the OR operator on - BS_* style bits. It can be used to mask out valid BS_* bits from a given bitmask. - - - - - Places text on the left side of the radio button or check box when combined with a radio button - or check box style. Same as the BS_RIGHTBUTTON style. - - - - - Specifies that the button displays text. - - - - - Specifies that the button displays an icon. - - - - - Specifies that the button displays a bitmap. See the Remarks section for its interaction - with BS_ICON. - - - - - Left-justifies the text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is left justified on the right side - of the check box or radio button. - - - - - Right-justifies text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is right justified on the right - side of the check box or radio button. - - - - - Centers text horizontally in the button rectangle. - - - - - Places text at the top of the button rectangle. - - - - - Places text at the bottom of the button rectangle. - - - - - Places text in the middle (vertically) of the button rectangle. - - - - - Makes a button (such as a check box, three-state check box, or radio button) look and - act like a push button. The button looks raised when it isn't pushed or checked, and - sunken when it is pushed or checked. - - - - - Wraps the button text to multiple lines if the text string is too long to fit on a - single line in the button rectangle. - - - - - Enables a button to send BN_KILLFOCUS and BN_SETFOCUS notification messages to its - parent window. - - - - - Specifies that the button is two-dimensional; it does not use the default - shading to create a 3-D image. - - - - - Microsoft Windows Vista and Version 6.00. Creates a split button that behaves like a - BS_PUSHBUTTON style button, but also has a distinctive appearance. If the split button - is in a dialog box, the user can select the split button by pressing the ENTER key, even - when the split button does not have the input focus. This style is useful for enabling - the user to quickly select the most likely (default) option. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like a - BS_PUSHBUTTON style button, but the command link button has a green arrow on the left pointing - to the button text. A caption for the button text can be set by sending the BCM_SETNOTE - message to the button. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like - a BS_PUSHBUTTON style button. If the button is in a dialog box, the user can select the - command link button by pressing the ENTER key, even when the command link button does - not have the input focus. This style is useful for enabling the user to quickly select - the most likely (default) option. - - - - - Edit control styles. - http://msdn.microsoft.com/en-us/library/bb775464(VS.85).aspx - - - - - Aligns text with the left margin. - - - - - Windows 98/Me, Windows 2000/XP: Centers text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Centers text in a multiline edit control. - - - - - Windows 98/Me, Windows 2000/XP: Right-aligns text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Right aligns text in a multiline edit control. - - - - - Designates a multiline edit control. The default is single-line edit control. - - - - - Converts all characters to uppercase as they are typed into the edit control. - - - - - Converts all characters to lowercase as they are typed into the edit control. - - - - - Displays an asterisk (*) for each character typed into the edit control. - This style is valid only for single-line edit controls. - - - - - Automatically scrolls text up one page when the user presses the ENTER key on - the last line. - - - - - Automatically scrolls text to the right by 10 characters when the user types - a character at the end of the line. When the user presses the ENTER key, - the control scrolls all text back to position zero. - - - - - Negates the default behavior for an edit control. - - - - - Converts text entered in the edit control. - - - - - Prevents the user from typing or editing text in the edit control. - - - - - Specifies that a carriage return be inserted when the user presses the - ENTER key while entering text into a multiline edit control in a dialog box. - If you do not specify this style, pressing the ENTER key has the same effect - as pressing the dialog box's default push button. This style has no effect - on a single-line edit control. - - - - - Allows only digits to be entered into the edit control. - - - - - Defines the header for a menu template. - A complete menu template consists of a header and one or more menu item lists. - - - - - Specifies the version number. This member must be zero. - - - - - Specifies the offset, in bytes, from the end of the header. - The menu item list begins at this offset. Usually, this member is zero, and the menu - item list follows immediately after the header. - - - - - Defines a menu item in a menu template. - - - - - Specifies one or more of the following predefined menu options that control the appearance of the menu item. - TODO - - - - - Defines the header for an extended menu template. - - - - - Template version number. This member must be 1 for extended menu templates. - - - - - Offset of the first MENUEXITEMTEMPLATE structure, relative to the end of - this structure member. If the first item definition immediately follows the - dwHelpId member, this member should be 4. - - - - - Drop-down menu or submenu item. - - - - - Menu item type. This member can be a combination of the type (beginning with MFT) values - listed with the MENUITEMINFO structure. - - - - - Menu item state. This member can be a combination of the state (beginning with MFS) values - listed with the MENUITEMINFO structure. - - - - - Menu item identifier. This is an application-defined value that identifies the menu item. - - - - - Value specifying whether the menu item is the last item in the menu bar, drop-down menu, - submenu, or shortcut menu and whether it is an item that opens a drop-down menu or submenu. - - - - - Specifies one or more of the following predefined menu options that control the - appearance of the menu item. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item is initially inactive and drawn with a gray effect. - - - - - - - - - - - - - - - Indicates that the menu item has a check mark next to it. - - - - - - - - - - - - - - - - - - - - Indicates that the owner window of the menu is responsible for drawing all visual - aspects of the menu item, including highlighted, selected, and inactive states. - This option is not valid for an item in a menu bar. - - - - - Indicates that the item is one that opens a drop-down menu or submenu. - - - - - Indicates that the menu item is placed in a new column. The old and new columns - are separated by a bar. - - - - - Indicates that the menu item is placed in a new column. - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item has a vertical separator to its left. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Specifies whether the menu item is the last item in the menu bar, drop-down menu, submenu, or shortcut - menu and whether it is an item that opens a drop-down menu or submenu. This member can be zero or more - of these values. - - - - - Defines the last menu item in the menu bar, drop-down menu, submenu, or shortcut menu. - - - - - Defines a item that opens a drop-down menu or submenu. Subsequent structures define menu - items in the corresponding drop-down menu or submenu. - - - - - Defines an accelerator key used in an accelerator table. - http://msdn.microsoft.com/en-us/library/ms646340(VS.85).aspx - - - - - Accelerator flags. - - - - - Accelerator key. This member can be either a virtual-key code or an ASCII character code. - - - - - Accelerator identifier. - - - - - Flags, fVirt field of the Accelerator table structure. - - - - - Virtual key. - - - - - Specifies that no top-level menu item is highlighted when the accelerator is used. - This is useful when defining accelerators for actions such as scrolling that do not - correspond to a menu item. If NOINVERT is omitted, a top-level menu item will be - highlighted (if possible) when the accelerator is used. - - - - - Causes the accelerator to be activated only if the SHIFT key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the CONTROL key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the ALT key is down. - Applies only to virtual keys. - - - - - Virtual key definitions. - - - - - Standard virtual left mouse button. - - - - - Standard virtual right mouse button. - - - - - Ctrl-Break / Ctrl-C. - - - - - Standard virtual middle mouse button. - - - - - - - - - - - - - - - Backspace. - - - - - Tab. - - - - - Delete. - - - - - Return. - - - - - Shift. - - - - - Control. - - - - - Menu. - - - - - Pause. - - - - - Caps lock. - - - - - - - - - - - - - - - - - - - - - - - - - Escape. - - - - - - - - - - - - - - - - - - - - - - - - - Space. - - - - - - - - - - - - - - - End. - - - - - Home. - - - - - Left arrow. - - - - - Up arrow. - - - - - Right arrow. - - - - - Down arrow. - - - - - - - - - - Print Screen. - - - - - - - - - - - - - - - Insert. - - - - - Delete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NEC PC-9800 keyboard '=' key on numpad. - - - - - Fujitsu/OASYS keyboard 'Dictionary' key. - - - - - Fujitsu/OASYS keyboard 'Unregister word' key. - - - - - Fujitsu/OASYS keyboard 'Register word' key. - - - - - Fujitsu/OASYS keyboard 'Left OYAYUBI' key. - - - - - Fujitsu/OASYS keyboard 'Right OYAYUBI' key. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';:' for US - - - - - '+' any country - - - - - ',' any country - - - - - '-' any country - - - - - '.' any country - - - - - '/?' for US - - - - - '`~' for US - - - - - '[{' for US - - - - - '\|' for US - - - - - ']}' for US - - - - - ''"' for US - - - - - - - - - - 'AX' key on Japanese AX kbd - - - - - "<>" or "\|" on RT 102-key kbd. - - - - - Help key on ICO - - - - - 00 key on ICO - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contains information about an individual font in a font resource group. - - - - - Specifies a user-defined version number for the resource data that tools can - use to read and write resource files. - - - - - Specifies the size of the file, in bytes. - - - - - Contains a 60-character string with the font supplier's copyright information. - - - - - Specifies the type of font file. - - - - - Specifies the point size at which this character set looks best. - - - - - Specifies the vertical resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the horizontal resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the distance from the top of a character definition cell to the baseline of the - typographical font. - - - - - Specifies the amount of leading inside the bounds set by the dfPixHeight member. Accent marks and - other diacritical characters can occur in this area. - - - - - Specifies the amount of extra leading that the application adds between rows. - - - - - Specifies an italic font if not equal to zero. - - - - - Specifies an underlined font if not equal to zero. - - - - - Specifies a strikeout font if not equal to zero. - - - - - Specifies the weight of the font in the range 0 through 1000. For example, 400 is roman and - 700 is bold. If this value is zero, a default weight is used. - - - - - Specifies the character set of the font. - - - - - Specifies the width of the grid on which a vector font was digitized. For raster fonts, - if the member is not equal to zero, it represents the width for all the characters in the - bitmap. If the member is equal to zero, the font has variable-width characters. - - - - - Specifies the height of the character bitmap for raster fonts or the height of the grid - on which a vector font was digitized. - - - - - Specifies the pitch and the family of the font. - - - - - Specifies the average width of characters in the font (generally defined as the width of - the letter x). This value does not include the overhang required for bold or italic characters. - - - - - Specifies the width of the widest character in the font. - - - - - Specifies the first character code defined in the font. - - - - - Specifies the last character code defined in the font. - - - - - Specifies the character to substitute for characters not in the font. - - - - - Specifies the character that will be used to define word breaks for text justification. - - - - - Specifies the number of bytes in each row of the bitmap. This value is always even so - that the rows start on word boundaries. For vector fonts, this member has no meaning. - - - - - Specifies the offset in the file to a null-terminated string that specifies a device name. - For a generic font, this value is zero. - - - - - Specifies the offset in the file to a null-terminated string that names the typeface. - - - - - This member is reserved. - - - - - This structure depicts the organization of data in a file-version resource. - It contains version information not dependent on a particular language and code page combination. - http://msdn.microsoft.com/en-us/library/aa909193.aspx - - - - - A hardware independent dictionary of language and code page identifier tables. - - - - - A new hardware independent dictionary of language and code page identifier tables. - - - - - An existing hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - - - - Read a hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - Pointer to the end of data. - - - - Write the hardware independent dictionary of language and code page identifier tables to a binary stream. - - Binary stream. - - - - The default language and code page identifier table. - - - - - Returns a language and code page identifier table. - - Language ID. - A language and code page identifier table. - - - - String representation of VarFileInfo. - - Indent. - String in the VarFileInfo format. - - - - This structure depicts the organization of data in a file-version resource. It typically contains a - list of language and code page identifier pairs that the version of the application or DLL supports. - http://msdn.microsoft.com/en-us/library/bb202818.aspx - - - - - A dictionary of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - Table key. - - - - An existing table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - Read a table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - - Write the table of language and code page identifier pairs to a binary stream. - - Binary stream. - Last unpadded position. - - - - Returns a code page identifier for a given language. - - Language ID. - Code page identifier. - - - - String representation of the var table. - - Indent. - String representation of the var table. - - - - VS_VERSIONINFO - This structure depicts the organization of data in a file-version resource. It is the root structure - that contains all other file-version information structures. - http://msdn.microsoft.com/en-us/library/aa914916.aspx - - - - - The resource header. - - - - - A dictionary of resource tables. - - - - - An existing version resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new language-netural version resource. - - - - - Read a version resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - String representation of the file version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - String representation of the protect version. - - - - - Write this version resource to a binary stream. - - Binary stream. - - - - Returns an entry within this resource table. - - Entry key. - A resource table. - - - - Returns an entry within this resource table. - - Entry index. - A resource table. - - - - Return string representation of the version resource. - - - - - - winver.h, version management functions, types and definitions - - - - - VS_VERSION signature. - - - - - VS_VERSION structure version. - - - - - VS_VERSION file flags mask. - - - - - VS_VERSION file flags. - - - - - The file contains debugging information. - - - - - The file is a prerelease development version, not a final commercial release. - - - - - PThe file has been modified somehow and is not identical to the original file - that shipped with the product. - - - - - The file was not built using standard release procedures. There should be data - in the file's "PrivateBuild" version information string. - - - - - The version information in this structure was not found inside the file, - but instead was created when needed based on the best information available. - Therefore, this structure's information may differ slightly from what the "real" - values are. - - - - - The file was built using standard release procedures, but is somehow different - from the normal file having the same version number. There should be data in the - file's "SpecialBuild" version information string. - - - - - VS_VERSION file OSs. - - - - - The operating system under which the file was designed to run could not be determined. - - - - - The file was designed to run under MS-DOS. - - - - - The file was designed to run under a 16-bit version of OS/2. - - - - - The file was designed to run under a 32-bit version of OS/2. - - - - - The file was designed to run under Windows NT/2000. - - - - - - - - - - The file was designed to run under the 16-bit Windows API. - - - - - The file was designed to be run under a 16-bit version of Presentation Manager. - - - - - The file was designed to be run under a 32-bit version of Presentation Manager. - - - - - The file was designed to run under the 32-bit Windows API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VS_VERSION file types. - - - - - The type of file could not be determined. - - - - - The file is an application. - - - - - The file is a Dynamic Link Library (DLL). - - - - - The file is a device driver. dwFileSubtype contains more information. - - - - - The file is a font. dwFileSubtype contains more information. - - - - - The file is a virtual device. - - - - - The file is a static link library. - - - - - File sub-type. - - - - - The type of driver could not be determined. - - - - - The file is a printer driver. - - - - - The file is a keyboard driver. - - - - - The file is a language driver. - - - - - The file is a display driver. - - - - - The file is a mouse driver. - - - - - The file is a network driver. - - - - - The file is a system driver. - - - - - The file is an installable driver. - - - - - The file is a sound driver. - - - - - The file is a communications driver. - - - - - The file is an input method driver. - - - - - The file is a versioned printer driver. - - - - - The file is a raster font. - - - - - The file is a vector font. - - - - - The file is a TrueType font. - - - - diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.dll b/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.dll deleted file mode 100644 index 4b8e8eb..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.dll and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.xml b/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.xml deleted file mode 100644 index ca74d41..0000000 --- a/packages/Vestris.ResourceLib.2.1.0/lib/net35/Vestris.ResourceLib.xml +++ /dev/null @@ -1,6603 +0,0 @@ - - - - Vestris.ResourceLib - - - - - Standard accelerator. - - - - - Read the accelerator. - - Address in memory. - - - - Write accelerator to a binary stream. - - Binary stream. - - - - String representation of the accelerator key. - - - - - An unsigned integer value that identifies the accelerator. - - - - - String representation of the accelerator. - - String representation of the accelerator. - - - - An accelerator, RT_ACCELERATOR resource. - An accelerator provides the user with access to an application's command set. - - - - - Accelerator keys. - - - - - A new accelerator resource. - - - - - An existing accelerator resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the accelerators table. - - Handle to a module. - Pointer to the beginning of the accelerator table. - Address of the end of the accelerator table. - - - - String representation of the accelerators resource. - - - - - - Creates an 8 bit aligned copy of the buffer if it is not already aligned - - - - - A bitmap file in a .bmp format. - - - - - Device independent bitmap. - - - - - An existing bitmap file. - - A file in a .bmp format. - - - - An embedded bitmap resource. - - - - - An existing bitmap resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new bitmap resource. - - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the bitmap resource to a binary stream. - - Binary stream. - - - - A device independent bitmap. - - - - - This structure depicts the organization of data in a hardware-independent cursor resource. - - - - - A hardware-independent cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent cursor resource. - - - - - A new collection of cursors that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a cursor resource. - - - - - An existing cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new cursor resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Language. - An icon resource. - - - - Horizontal hotspot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Vertical hot spot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Write the cursor data to a file. - - Target executable file. - - - - Read DIB image. - - DIB bits. - DIB size. - - - - A device-independent image consists of a BITMAPINFOHEADER where - bmWidth is the width of the image andbmHeight is double the height - of the image, followed by the bitmap color table, followed by the image - pixels, followed by the mask pixels. - - - - - Raw image data. - - - - - Bitmap info header. - - - - - Bitmap size in bytes. - - - - - A new icon image. - - - - - A device-independent bitmap. - - Bitmap data. - - - - Create a copy of an image. - - Source image. - - - - Read icon data. - - Pointer to the beginning of icon data. - Icon data size. - - - - Size of the image mask. - - - - - Position of the DIB bitmap bits within a DIB bitmap array. - - - - - Number of colors in the palette. - - - - - Returns the width of a row in a DIB Bitmap given the number of bits. DIB Bitmap rows always align on a DWORD boundary. - - Number of bits. - Width of a row in bytes. - - - - Bitmap monochrome mask. - - - - - Bitmap color (XOR) part of the image. - - - - - Complete image. - - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - Indicates the character set to use. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Weight of the font. - - - - - Indicates whether the font is italic. - - - - - Number of dialog items. - - - - - An extended dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write dialog control to a binary stream. - - Binary stream. - - - - String representation of the dialog. - - String in the DIALOGEX [dialog] format. - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - An extended dialog control template structure. - - - - - Read the dialog control. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Return a string representation of the dialog control. - - A single line in the "CLASS name id, dimensions and styles' format. - - - - A dialog template resource. - - - - - A dialog template structure that describes the dialog. - - - - - A structured dialog resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A structured dialog resource embedded in an executable module. - - - - - Dialog resource in standard resource editor text format. - - Multi-line string. - - - - A container for the DIALOGTEMPLATE structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Number of dialog items. - - - - - A standard dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog template data to a binary stream. - - Binary stream. - - - - Returns a string representation of the dialog. - - String in the DIALOG ... format. - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Number of items in this structure. - - - - - The name of the typeface for the font. - - - - - Point size of the font to use for the text in the dialog box and its controls. - - - - - Dialog caption. - - - - - Menu resource Id. - - - - - Window class Id. - - - - - Controls within this dialog. - - - - - Dialog template representation in a standard text format. - - Multiline string. - - - - String represetnation of a control. - - - - - - Write the resource to a binary stream. - - Binary stream. - - - - A container for a control within a dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - A standard dialog control structure. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - String represetnation of a control. - - - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Dialog caption. - - - - - Window class Id. - - - - - Window class of the control. - - - - - Additional creation data. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Dialog template utility functions. - - - - - Read a dialog resource id. - - Address in memory. - Resource read. - - - - - String representation of the dialog or control style of two types. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control styles of two types. - - Dialog or control style. - Dialog or control extended style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control style of one type. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - Returns the type of the resource in this group. - - - - - Icons contained in this hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - Save a hardware-independent icon resource to an executable file. - - Name of an executable file (.exe or .dll). - - - - Read a hardware-independent icon resource from a loaded module. - - Loaded executable module. - Pointer to the beginning of a hardware-independent icon resource. - Pointer to the end of the hardware-independent icon resource. - - - - Write a hardware-independent icon resource to a binary stream. - - Binary stream. - - - - Fixed file information. - - - - - Default Windows fixed file information. - - - - - Fixed file info structure. - - - - - Read the fixed file information structure. - - Address in memory. - - - - String representation of the file version. - - - - - String representation of the protect version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - Write fixed file information to a binary stream. - - Binary stream. - - - - Size of the VS_FIXEDFILEINFO structure. - - - - - String representation of the fixed file info. - - String representation of the fixed file info. - - - - A font directory entry. - - - - - Font ordinal. - - - - - Typeface name of the font. - - - - - Specifies the name of the device if this font file is designated for a specific device. - - - - - Font information. - - - - - A new font directory entry. - - - - - Read the font directory entry. - - Pointer in memory. - Pointer to the end of the font directory entry. - - - - Write the font directory entry to a binary stream. - - Binary stream. - - - - A font directory, RT_FONTDIR resource. - - - - - Number of fonts in this directory. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font directory to a binary stream. - - Binary stream. - - - - A font, RT_FONT resource. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font resource to a binary writer. - - Binary writer. - - - - Gdi32.dll interop functions. - - - - - Bitmap compression options. - - - - - An uncompressed format. - - - - - A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression. - - - - - An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression. - - - - - Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image. - - - - - A bitmap info header. - See http://msdn.microsoft.com/en-us/library/ms532290.aspx for more information. - - - - - Bitmap information size. - - - - - Bitmap width. - - - - - Bitmap height. - - - - - Number of logical planes. - - - - - Bitmap bitrate. - - - - - Bitmap compression. - - - - - Image size. - - - - - Horizontal pixel resolution. - - - - - Vertical pixel resolution. - - - - - - - - - - - - - - - Returns the current bitmap compression. - - - - - Bitmap pixel format. - - - - - Bitmap pixel format English standard string. - - - - - Defines the dimensions and color information of a Windows-based device-independent bitmap (DIB). - http://msdn.microsoft.com/en-us/library/dd183375(VS.85).aspx. - - - - - Specifies a bitmap information header structure that contains information about the dimensions of color format. - - - - - An array of RGBQUAD. The elements of the array make up the color table. - - - - - Store colors in a paletised icon (2, 4 or 8 bit). - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Blue. - - - - - Green. - - - - - Red. - - - - - Reserved. - - - - - The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - http://msdn.microsoft.com/en-us/library/dd183374(VS.85).aspx - - - - - The file type; must be BM. - - - - - The size, in bytes, of the bitmap file. - - - - - Reserved; must be zero. - - - - - Reserved; must be zero. - - - - - The offset, in bytes, from the beginning of the BITMAPFILEHEADER structure to the bitmap bits. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Retrieves the bits of the specified compatible bitmap and copies them into a buffer as - a DIB using the specified format - - A handle to the device context. - A handle to the bitmap. This must be a compatible bitmap (DDB). - The first scan line to retrieve. - The number of scan lines to retrieve. - A pointer to a buffer to receive the bitmap data. - A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data. - The format of the bmiColors member of the BITMAPINFO structure. - - If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap. - If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is non-zero. - If the function fails, the return value is zero. - - - - - Create a DIB that applications can write to directly. The function gives you a pointer to the location - of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use - to create the bitmap, or you can let the system allocate the memory for the bitmap. - - Handle to a device context. - A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors. - The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal RGB values). - A pointer to a variable that receives a pointer to the location of the DIB bit values. - A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL. - The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. - - If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values. - If the function fails, the return value is NULL, and *ppvBits is NULL. - - - - - Defines how to interpret the values in the color table of a DIB. - - - - - The color table contains literal RGB values. - - - - - The color table consists of an array of 16-bit indexes into the LogPalette - object that is currently defined in the playback device context. - - - - - No color table exists. The pixels in the DIB are indices into the current logical - palette in the playback device context. - - - - - - - - - - Creates a memory device context (DC) compatible with the specified device. - - Handle to an existing device context. - - The handle to a memory device context indicates success. - NULL indicates failure. - - - - - - - Specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. - Specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). - This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows. - A pointer to a DEVMODE structure containing device-specific initialization data for the device driver. - - - - - Creates a bitmap compatible with the device that is associated with the specified device context. - - A handle to a device context. - The bitmap width, in pixels. - The bitmap height, in pixels. - - If the function succeeds, the return value is a handle to the compatible bitmap (DDB). - If the function fails, the return value is NULL. - - - - - Selects an object into a specified device context. The new object replaces the previous object of the same type. - - Handle to the device context. - Handle to the object to be selected. - - If the selected object is not a region, the handle of the object being replaced indicates success. - If the selected object is a region, one of the following values indicates success. - - - - - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. - - Handle to a logical pen, brush, font, bitmap, region, or palette. - - Nonzero indicates success. - Zero indicates that the specified handle is not valid or that the handle is currently selected into a device context. - - - - - Deletes the specified device context. - - A handle to the device context. - - If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. - - - - - A generic resource. - - - - - Raw resource data. - - - - - Raw resource data. - - - - - An unstructured generic resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A generic resource. - - Resource name. - Resource type. - Resource language. - - - - Read a generic resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - A new collection of icons that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a .ico file. - - - - - Resource type. - - - - - Icon. - - - - - Cursor. - - - - - Type of the group icon resource. - - - - - Collection of icons in an .ico file. - - - - - An existing .ico file. - - An existing icon (.ico) file. - - - - Load from a .ico file. - - An existing icon (.ico) file. - - - - Read icons. - - Pointer to the beginning of a FILEGRPICONDIR structure. - Pointer to the end of a FILEGRPICONDIR structure. - - - - This structure depicts the organization of icon data in a .ico file. - - - - - Icon header. - - - - - Icon bitmap. - - - - - New icon data. - - - - - Icon width. - - - - - Icon height. - - - - - Image size in bytes. - - - - - Read a single icon (.ico). - - Pointer to the beginning of this icon's data. - Pointer to the beginning of all icon data. - Pointer to the end of this icon's data. - - - - Icon size as a string. - - Icon size in the width x height format. - - - - This structure depicts the organization of data in an icon resource. - - - - - Directory header. - - - - - Actual image. - - - - - Hardware-independent icon directory header. - - - - - Embedded icon Id. - - - - - An icon image. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Create a new icon image resource from a file icon. - - File icon. - Resource type. - Resource id. - Resource language. - - - - Icon width in pixels. - - - - - Icon height in pixels. - - - - - Image size in bytes. - - - - - Read an icon resource from a previously loaded module. - - Module handle. - Pointer to a directory entry in the hardware-independent icon resource. - Pointer to the end of the icon resource. - - - - Read the bitmap image. - - DIB bits. - Size of image. - - - - Icon pixel format. - - - - - Icon pixel format English standard string. - - - - - String representation of the icon. - - A string in a format of width x height followed by the pixel format. - - - - Write icon resource data to a binary stream. - - Binary stream. - - - - Save icon to a file. - - Target executable file. - - - - This structure depicts the organization of data in an icon resource. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Resource language. - An icon resource. - - - - Kernel32.dll interop functions. - - - - - A resource header. - - - - - Header length. - - - - - Data length. - - - - - Resource type. - - - - - A new resource header of a given length. - - - - - - Resource header type. - - - - - Binary data. - - - - - String data. - - - - - Language and code page combinations. - The low-order word of each DWORD must contain a Microsoft language identifier, - and the high-order word must contain the IBM code page number. - Either high-order or low-order word can be zero, indicating that the file is language - or code page independent. - - - - - Microsoft language identifier. - - - - - IBM code page number. - - - - - This structure contains version information about a file. - This information is language- and code page–independent. - http://msdn.microsoft.com/en-us/library/ms647001.aspx - - - - - Contains the value 0xFEEF04BD. This is used with the szKey member of the VS_VERSIONINFO structure when searching a file for the VS_FIXEDFILEINFO structure. - - - - - Specifies the binary version number of this structure. The high-order word of this member contains the major version number, and the low-order word contains the minor version number. - - - - - Specifies the most significant 32 bits of the file's binary version number. This member is used with dwFileVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the file's binary version number. This member is used with dwFileVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the most significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Contains a bitmask that specifies the valid bits in dwFileFlags. A bit is valid only if it was defined when the file was created. - - - - - Contains a bitmask that specifies the Boolean attributes of the file. - - - - - Specifies the operating system for which this file was designed. - - - - - Specifies the general type of file. - - - - - Specifies the function of the file. - - - - - Specifies the most significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Specifies the least significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Creates a default Windows VS_FIXEDFILEINFO structure. - - A default Windows VS_FIXEDFILEINFO. - - - - A hardware-independent icon directory resource header. - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Reserved, must be zero. - - - - - Resource type, 1 for icons. - - - - - Number of images. - - - - - Hardware-independent icon directory entry. - See http://msdn.microsoft.com/en-us/library/ms997538.aspx for more information. - - - - - Width of the image. Starting with Windows 95 a value of 0 represents width of 256. - - - - - Height of the image. Starting with Windows 95 a value of 0 represents height of 256. - - - - - Number of colors in the image. - bColors = 1 << (wBitsPerPixel * wPlanes) - If wBitsPerPixel* wPlanes is greater orequal to 8, then bColors = 0. - - - - - Reserved. - - - - - Number of bitmap planes. - 1: monochrome bitmap - - - - - Bits per pixel. - 1: monochrome bitmap - - - - - Image size in bytes. - - - - - Icon ID. - - - - - Hardware-independent icon directory entry in an .ico file. - - - - - Icon width. - - - - - Icon height. - - - - - Colors; 0 means 256 or more. - - - - - Reserved. - - - - - Number of bitmap planes for icons. - Horizontal hotspot for cursors. - - - - - Bits per pixel for icons. - Vertical hostpot for cursors. - - - - - Image size in bytes. - - - - - Offset of bitmap data from the beginning of the file. - - - - - Hardware-independent icon structure in an .ico file. - - - - - Reserved, must be zero. - - - - - Resource Type (1 for icons). - - - - - Number of images. - - - - - If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. - - - - - If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. - - - - - If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy. - - - - - If this value is used, the system does not perform automatic trust comparisons on the DLL or its dependents when they are loaded. - - - - - Loads the specified module into the address space of the calling process. - The specified module may cause other modules to be loaded. - - The name of the module. - This parameter is reserved for future use. - The action to be taken when loading the module. - - - - - Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. - - A handle to the loaded library module. - If the function succeeds, the return value is nonzero. - - - - Predefined resource types. - - - - - Hardware-dependent cursor resource. - - - - - Bitmap resource. - - - - - Hardware-dependent icon resource. - - - - - Menu resource. - - - - - Dialog box. - - - - - String-table entry. - - - - - Font directory resource. - - - - - Font resource. - - - - - Accelerator table. - - - - - Application-defined resource (raw data). - - - - - Message-table entry. - - - - - Hardware-independent cursor resource. - - - - - Hardware-independent icon resource. - - - - - Version resource. - - - - - Allows a resource editing tool to associate a string with an .rc file. - - - - - Plug and Play resource. - - - - - VXD. - - - - - Animated cursor. - - - - - Animated icon. - - - - - HTML. - - - - - Microsoft Windows XP: Side-by-Side Assembly XML Manifest. - - - - - Enumerates resource types within a binary module. - - Handle to a module to search. - Pointer to the callback function to be called for each enumerated resource type. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful; otherwise, FALSE. - - - - An application-defined callback function used with the EnumResourceTypes and EnumResourceTypesEx functions. - - The handle to the module whose executable file contains the resources for which the types are to be enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the type is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceTypes or EnumResourceTypesEx function. - Returns TRUE if successful; otherwise, FALSE. - - - - Enumerates resources of a specified type within a binary module. - - Handle to a module to search. - Pointer to a null-terminated string specifying the type of the resource for which the name is being enumerated. - Pointer to the callback function to be called for each enumerated resource name or ID. - Specifies an application-defined value passed to the callback function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - An application-defined callback function used with the EnumResourceNames and EnumResourceNamesEx functions. - - The handle to the module whose executable file contains the resources that are being enumerated. - Pointer to a null-terminated string specifying the type of resource that is being enumerated. - Specifies the name of a resource of the type being enumerated. - Specifies the application-defined parameter passed to the EnumResourceNames or EnumResourceNamesEx function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - Enumerates language-specific resources, of the specified type and name, associated with a binary module. - - The handle to a module to search. - Pointer to a null-terminated string specifying the type of resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Pointer to the callback function to be called for each enumerated resource language. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful or FALSE otherwise. - - - - An application-defined callback function used with the EnumResourceLanguages and EnumResourceLanguagesEx functions. - - The handle to the module whose executable file contains the resources for which the languages are being enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Specifies the language identifier for the resource for which the language is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceLanguages or EnumResourceLanguagesEx function. - Returns TRUE if successful or FALSE otherwise. - - - - Determines the location of the resource with the specified type, name, and language in the specified module. - - Handle to the module whose executable file contains the resource. - Pointer to a null-terminated string specifying the type name of the resource. - Pointer to a null-terminated string specifying the name of the resource. - Specifies the language of the resource. - If the function succeeds, the return value is a handle to the specified resource's information block. - - - - Locks the specified resource in memory. - - Handle to the resource to be locked. - If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL. - - - - Loads the specified resource into global memory. - - Handle to the module whose executable file contains the resource. - Handle to the resource to be loaded. - If the function succeeds, the return value is a handle to the data associated with the resource. - - - - Returns the size, in bytes, of the specified resource. - - Handle to the module whose executable file contains the resource. - Handle to the resource. This handle must be created by using the FindResource or FindResourceEx function. - If the function succeeds, the return value is the number of bytes in the resource. - - - - Closes an open object handle. - - A valid handle to an open object. - If the function succeeds, the return value is nonzero. - - - - Returns a handle to either a language-neutral portable executable file (LN file) or a - language-specific resource file (.mui file) that can be used by the UpdateResource function - to add, delete, or replace resources in a binary module. - - Pointer to a null-terminated string that specifies the binary file in which to update resources. - Specifies whether to delete the pFileName parameter's existing resources. - If the function succeeds, the return value is a handle that can be used by the UpdateResource and EndUpdateResource functions. - - - - Adds, deletes, or replaces a resource in a portable executable (PE) file. - There are some restrictions on resource updates in files that contain Resource Configuration (RC Config) data: - language-neutral (LN) files and language-specific resource (.mui) files. - - A module handle returned by the BeginUpdateResource function, referencing the file to be updated. - Pointer to a null-terminated string specifying the resource type to be updated. - Pointer to a null-terminated string specifying the name of the resource to be updated. - Specifies the language identifier of the resource to be updated. - Pointer to the resource data to be inserted into the file indicated by hUpdate. - Specifies the size, in bytes, of the resource data at lpData. - Returns TRUE if successful or FALSE otherwise. - - - - Commits or discards changes made prior to a call to UpdateResource. - - A module handle returned by the BeginUpdateResource function, and used by UpdateResource, referencing the file to be updated. - Specifies whether to write the resource updates to the file. If this parameter is TRUE, no changes are made. If it is FALSE, the changes are made: the resource updates will take effect. - Returns TRUE if the function succeeds; FALSE otherwise. - - - - Neutral primary language ID. - - - - - US-English primary language ID. - - - - - Neutral sublanguage ID. - - - - - US-English sublanguage ID. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID is used primarily for EXEs. If an executable has a resource of type RT_MANIFEST, - ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will create a process default activation context for the process. - The process default activation context will be used by all components running in the process. - CREATEPROCESS_MANIFEST_RESOURCE_ID can also used by DLLs. When Windows probe for dependencies, if the dll has - a resource of type RT_MANIFEST, ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will use that manifest as the - dependency. - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID is used primarily for DLLs. It should be used if the dll wants private - dependencies other than the process default. For example, if an dll depends on comctl32.dll version 6.0.0.0. - It should have a resource of type RT_MANIFEST, ID ISOLATIONAWARE_MANIFEST_RESOURCE_ID to depend on comctl32.dll - version 6.0.0.0, so that even if the process executable wants comctl32.dll version 5.1, the dll itself will still - use the right version of comctl32.dll. - - - - - When ISOLATION_AWARE_ENABLED is defined, Windows re-defines certain APIs. For example LoadLibraryExW - is redefined to IsolationAwareLoadLibraryExW. - - - - - Resource manifest type. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_NOSTATICIMPORT_MANIFEST_RESOURCE_ID - - - - - Copies the contents of a source memory block to a destination memory block, and supports overlapping source and destination memory blocks. - - A pointer to the starting address of the copied block's destination. - A pointer to the starting address of the block of memory to copy. - The size of the block of memory to copy, in bytes. - - - - A resource load exception. - - - - - The Win32 exception from a resource enumeration function. - - - - - A new resource load exception. - - Error message. - The inner exception thrown within a single resource. - The outer exception from the Win32 API. - - - - A combined message of the inner and outer exception. - - - - - An embedded SxS manifest. - - - - - Embedded XML manifest. - - - - - Manifest type. - - - - - An existing embedded manifest resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new executable CreateProcess manifest. - - - - - A new executable manifest. - - Manifest type. - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - Load a manifest resource from an executable file. - - Name of an executable file (.exe or .dll). - Manifest resource type. - - - - Extended menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write the menu template. - - Binary stream. - - - - String representation of the menu in the MENUEX format. - - String representation of the menu. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of extended menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - A command menu item. - - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - An extended popup menu item. - - - - - Sub menu items. - - - - - An extended popup menu item. - - - - - Read an extended popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENUEX format. - - String representation. - - - - A generic resource. - - - - - Menu template. - - - - - A structured menu resource. - - - - - A structured menu resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - Read a menu resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the menu resource to a binary stream. - - Binary stream. - - - - String representation of the menu resource in the MENU format. - - String representation of the menu resource. - - - - Standard menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write menu template to a binary stream. - - Binary stream. - - - - String representation of the menu in the MENU format. - - String representation of the menu. - - - - A menu template header. - - - - - Read the menu template header. - - Address in memory. - - - - Write the menu to a binary stream. - - Binary stream. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - Command menu id. - - - - - A command menu item. - - - - - Read a command menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A popup menu item. - - - - - Sub menu items. - - - - - A popup menu item. - - - - - Read a popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - A version resource. - - - - - Resource type. - - - - - Resource name. - - - - - Resource language. - - - - - Loaded binary nodule. - - - - - Pointer to the resource. - - - - - Resource size. - - - - - Version resource size in bytes. - - - - - Language ID. - - - - - Resource type. - - - - - String representation of the resource type. - - - - - Resource name. - - - - - A new resource. - - - - - A structured resource embedded in an executable module. - - Module handle. - Resource handle. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Lock and read the resource. - - Module handle. - Resource handle. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - Resource name. - Resource type. - Resource language. - - - - Load a resource from an executable (.exe or .dll) module. - - An executable (.exe or .dll) module. - Resource type. - Resource name. - Resource language. - - - - Read a resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - Write the resource to a memory stream. - - Binary stream. - - - - Return resource data. - - Resource data. - - - - Save a resource. - - Name of an executable file (.exe or .dll). - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Language id. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - Resource data. - - - - Save a batch of resources to a given file. - - Path to an executable file. - The resources to write. - - - - A resource Id. - There're two types of resource Ids, reserved integer numbers (eg. RT_ICON) and custom string names (eg. "CUSTOM"). - - - - - A resource identifier. - - A integer or string resource id. - - - - A resource identifier. - - A integer resource id. - - - - A well-known resource-type identifier. - - A well known resource type. - - - - A custom resource identifier. - - - - - - Resource Id. - - - If the resource Id is a string, it will be copied. - - - - - String representation of a resource type name. - - - - - An enumerated resource type for built-in resource types only. - - - - - Returns true if the resource is an integer resource. - - - - - Returns true if the resource is an integer resource. - - Resource pointer. - - - - Resource Id in a string format. - - - - - String representation of the resource Id. - - Resource name. - - - - Resource Id hash code. - Resource Ids of the same type have the same hash code. - - Resource Id. - - - - Compares two resource Ids by value. - - Resource Id. - True if both resource Ids represent the same resource. - - - - Resource info manager. - - - - - A dictionary of resources, the key is the resource type, eg. "REGISTRY" or "16" (version). - - - - - A shortcut for available resource types. - - - - - A new resource info. - - - - - Unload the previously loaded module. - - - - - Load an executable or a DLL and read its resources. - - Source filename. - - - - Enumerate resource types. - - Module handle. - Resource type. - Additional parameter. - TRUE if successful. - - - - Enumerate resource names within a resource by type - - Module handle. - Resource type. - Resource name. - Additional parameter. - TRUE if successful. - - - - Create a resource of a given type. - - Module handle. - Pointer to the resource in memory. - Resource type. - Resource name. - Language ID. - Size of resource. - A specialized or a generic resource. - - - - Enumerate resource languages within a resource by name - - Module handle. - Resource type. - Resource name. - Language ID. - Additional parameter. - TRUE if successful. - - - - Save resource to a file. - - Target filename. - - - - Dispose resource info object. - - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - A resource table header. - - - - - Resource table header. - - - - - Resource table key. - - - - - Resource table key. - - - - - Resource header. - - - - - A new resource table header. - - - - - An resource table header with a specific key. - - resource key - - - - An existing resource table. - - Pointer to resource table data. - - - - Read the resource header, return a pointer to the end of it. - - Top of header. - End of header, after the key, aligned at a 32 bit boundary. - - - - Write the resource table. - - Binary stream. - - - - String representation. - - String representation. - - - - String representation. - - Indent. - String representation. - - - - Resource utilities. - - - - - Align an address to a 4-byte boundary. - - Address in memory. - 4-byte aligned pointer. - - - - Align a pointer to a 4-byte boundary. - - Pointer to an address in memory. - 4-byte aligned pointer. - - - - Pad data to a WORD. - - Binary stream. - New position within the binary stream. - - - - Pad data to a DWORD. - - Binary stream. - New position within the binary stream. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Write a value at a given position. - Used to write a size of data in an earlier located header. - - Binary stream. - Value to write. - Address to write the value at. - - - - Pad bytes. - - Binary stream. - Number of bytes to write. - New position within the stream. - - - - Neutral language ID. - - - - - US-English language ID. - - - - - Make a language ID from a primary language ID (low-order 10 bits) and a sublanguage (high-order 6 bits). - - Primary language ID. - Sublanguage ID. - Microsoft language ID. - - - - Return the primary language ID from a Microsoft language ID. - - Microsoft language ID - primary language ID (low-order 10 bits) - - - - Return the sublanguage ID from a Microsoft language ID. - - Microsoft language ID. - Sublanguage ID (high-order 6 bits). - - - - Returns the memory representation of an object. - - Object type. - Data. - Object's representation in memory. - - - - Get a collection of flags from a flag value. - - Flag collection type. - Flag value. - Collection of flags. - - - - Get a string representation of flags. - - Flag collection type. - Flag vlaue - String representation of flags in the f1 | ... | fn format. - - - - This structure depicts the organization of data in a file-version resource. - It contains version information that can be displayed for a particular language and code page. - http://msdn.microsoft.com/en-us/library/aa908808.aspx - - - - - Resource strings. - - - - - A new string file-version resource. - - - - - An existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - - - - Read an existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - Pointer to the end of the string file-version resource. - - - - Write the string file-version resource to a binary stream. - - Binary stream. - - - - Default (first) string table. - - - - - Indexed string table. - - Key. - A string table at a given index. - - - - String representation of StringFileInfo. - - Indent. - String in the StringFileInfo format. - - - - A string, RT_STRING resource. - Each string resource block has 16 strings, each represented as an ordered pair - (length, text). Length is a WORD that specifies the size, in terms of the number of characters, - in the text that follows. Text follows length and contains the string in Unicode without the - NULL terminating character. There may be no characters in text, in which case length is zero. - - - - - String collection in this resource. - - - - - Returns a string of a given Id. - - String Id. - A string of a given Id. - - - - A new string resource. - - - - - A new string resource of a given block id. - - Block id. - - - - A new string resource of a given block id. - - Block id. - - - - An existing string resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A string with ID, stringId, is located in the block with ID given by the following formula. - http://support.microsoft.com/kb/q196774/ - - - - - String table block id. - - - - - Read the strings. - - Handle to a module. - Pointer to the beginning of the string table. - Address of the end of the string table. - - - - String representation of the strings resource. - - - - - - This structure depicts the organization of data in a file-version resource. It contains language - and code page formatting information for the strings. A code page is an ordered character set. - See http://msdn.microsoft.com/en-us/library/aa909192.aspx for more information. - - - - - Resource strings. - - - - - A new string table. - - - - - A new string table. - - String table key. - - - - An existing string table. - - Pointer to the beginning of the table. - - - - Read a string table. - - Pointer to the beginning of the string table. - Pointer to the end of the string table. - - - - Write the string table to a binary stream. - - Binary stream. - Last unpadded position. - - - - The four most significant digits of the key represent the language identifier. - Each Microsoft Standard Language identifier contains two parts: the low-order 10 bits - specify the major language, and the high-order 6 bits specify the sublanguage. - - - - - The four least significant digits of the key represent the code page for which the data is formatted. - - - - - Returns an entry within the string table. - - Key. - An entry within the string table. - - - - String representation of the string table. - - Indent. - String representation of the strings table. - - - - This structure depicts the organization of data in a file-version resource. It contains a string - that describes a specific aspect of a file, such as a file's version, its copyright notices, - or its trademarks. - http://msdn.microsoft.com/en-us/library/aa909025.aspx - - - - - The value is always stored double-null-terminated. - - - - - When set to true the length in the header will also contain the padding bytes when writing to a stream. - The MSDN reference (http://www.webcitation.org/6zBLYbvww) does not clarify which variant is 'right'. - - - - - String resource header. - - - - - Key. - - - - - String value (removing the double-null-terminator). - - - - - Value. - - - - - A new string resource. - - Key. - - - - An existing string resource. - - Pointer to the beginning of a string resource. - - - - Read a string resource. - - Pointer to the beginning of a string resource. - - - - Write a string resource to a binary stream. - - Binary stream. - - - - User32.dll functions. - - - - - Contains information about an icon or a cursor. - - - - - Specifies whether this structure defines an icon or a cursor. - A value of TRUE specifies an icon; FALSE specifies a cursor. - - - - - Specifies the x-coordinate of a cursor's hot spot. If this structure defines an icon, the hot spot is - always in the center of the icon, and this member is ignored. - - - - - Specifies the y-coordinate of the cursor's hot spot. If this structure defines an icon, the hot spot - is always in the center of the icon, and this member is ignored. - - - - - Specifies the icon bitmask bitmap. - - - - - Handle to the icon color bitmap. - - - - - Retrieve a handle to a device context (DC) for the client area of a specified window or for the entire screen. - - A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. - - If the function succeeds, the return value is a handle to the DC for the specified window's client area. - If the function fails, the return value is NULL. - - - - - Releases a device context (DC), freeing it for use by other applications. - - A handle to the window whose DC is to be released. - A handle to the DC to be released. - - The return value indicates whether the DC was released. If the DC was released, the return value is 1. - If the DC was not released, the return value is zero. - - - - - The DIALOGTEMPLATE structure defines the dimensions and style of a dialog box. - This structure, always the first in a standard template for a dialog box, - also specifies the number of controls in the dialog box and therefore specifies - the number of subsequent DIALOGITEMTEMPLATE structures in the template. - - - - - Specifies the style of the dialog box. - - - - - Extended styles for a window. - - - - - Specifies the number of items in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - The DIALOGITEMTEMPLATE structure defines the dimensions and style of a control in a dialog box. - - - - - Specifies the style of the control. - - - - - Extended styles for a window. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the width, in dialog box units, of the control. - - - - - Specifies the height, in dialog box units, of the control. - - - - - Specifies the control identifier. - - - - - An extended dialog box template begins with a DIALOGEXTEMPLATE header that describes - the dialog box and specifies the number of controls in the dialog box. For each - control in a dialog box, an extended dialog box template has a block of data that - uses the DIALOGEXITEMTEMPLATE format to describe the control. - - - - - Specifies the version number of the extended dialog box template. This member must be 1. - - - - - Indicates whether a template is an extended dialog box template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the number of controls in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - A control entry in an extended dialog template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - Specifies the control identifier. - - - - - Window styles. - http://msdn.microsoft.com/en-us/library/ms632600(VS.85).aspx - - - - - Creates an overlapped window. An overlapped window has a title bar and - a border. Same as the WS_TILED style. - - - - - Creates a pop-up window. This style cannot be used with the WS_CHILD style. - - - - - Creates a child window. A window with this style cannot have - a menu bar. This style cannot be used with the WS_POPUP style. - - - - - Creates a window that is initially minimized. Same as the WS_ICONIC style. - - - - - Creates a window that is initially visible. - - - - - Creates a window that is initially disabled. A disabled window cannot receive - input from the user. - - - - - Clips child windows relative to each other; that is, when a particular - child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips - all other overlapping child windows out of the region of the child window - to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, - it is possible, when drawing within the client area of a child window, to draw - within the client area of a neighboring child window. - - - - - Excludes the area occupied by child windows when drawing occurs - within the parent window. This style is used when creating the parent window. - - - - - Creates a window that is initially maximized. - - - - - Creates a window that has a title bar (includes the WS_BORDER style). - - - - - Creates a window that has a thin-line border. - - - - - Creates a window that has a border of a style typically used with dialog - boxes. A window with this style cannot have a title bar. - - - - - Creates a window that has a vertical scroll bar. - - - - - Creates a window that has a horizontal scroll bar. - - - - - Creates a window that has a window menu on its title bar. The WS_CAPTION - style must also be specified. - - - - - Creates a window that has a sizing border. Same as the WS_SIZEBOX style. - - - - - Specifies the first control of a group of controls. The group consists of this - first control and all controls defined after it, up to the next control with - the WS_GROUP style. The first control in each group usually has the WS_TABSTOP - style so that the user can move from group to group. The user can subsequently - change the keyboard focus from one control in the group to the next control in - the group by using the direction keys. - - - - - Specifies a control that can receive the keyboard focus when the user presses - the TAB key. Pressing the TAB key changes the keyboard focus to the next - control with the WS_TABSTOP style. - - - - - Dialog styles. - http://msdn.microsoft.com/en-us/library/ms644994(VS.85).aspx - - - - - Specifying this style in the dialog template tells Windows that the dtX and dtY values - of the DIALOGTEMPLATE struct are relative to the screen origin, not the owner of the - dialog box. - - - - - Create a dialog box with the WS_EX_TOPMOST flag. This flag cannot be combined with the - DS_CONTROL style. This flag is obsolete and is included for compatibility with 16-bit - versions of Windows. - - - - - Applies to 16-bit applications only. This style directs edit controls in the dialog - box to allocate memory from the application data segment. Otherwise, edit controls - allocate storage from a global memory object. - - - - - Indicates that the header of the dialog box template contains additional data specifying - the font to use for text in the client area and controls of the dialog box. - - - - - Creates a dialog box with a modal dialog-box frame that can be combined with a title - bar and window menu by specifying the WS_CAPTION and WS_SYSMENU styles. - - - - - Suppresses WM_ENTERIDLE messages that the system would otherwise send to the owner of the - dialog box while the dialog box is displayed. - - - - - Causes the system to use the SetForegroundWindow function to bring the dialog - box to the foreground. - - - - - Gives the dialog box a nonbold font and draws three-dimensional borders around - control windows in the dialog box. - - - - - Causes the dialog box to use the SYSTEM_FIXED_FONT instead of the default SYSTEM_FONT. - This is a monospace font compatible with the System font in 16-bit versions of Windows - earlier than 3.0. - - - - - Creates the dialog box even if errors occur — for example, if a child window cannot be - created or if the system cannot create a special data segment for an edit control. - - - - - Creates a dialog box that works well as a child window of another dialog box, - much like a page in a property sheet. This style allows the user to tab among - the control windows of a child dialog box, use its accelerator keys, and so on. - - - - - Centers the dialog box in the working area; that is, the area not obscured by the tray. - - - - - Centers the dialog box on the mouse cursor. - - - - - Includes a question mark in the title bar of the dialog box. When the user clicks the - question mark, the cursor changes to a question mark with a pointer. If the user then - clicks a control in the dialog box, the control receives a WM_HELP message. The control - should pass the message to the dialog box procedure, which should call the function - using the HELP_WM_HELP command. The help application displays a pop-up window that - typically contains help for the control. - - - - - Indicates that the dialog box should use the system font. - - - - - - - - - - Extended dialog styles. - - - - - Creates a window that has a double border; the window can, optionally, be created - with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY - message to its parent window when it is created or destroyed. - - - - - Specifies that a window created with this style should be placed above all non-topmost - windows and should stay above them, even when the window is deactivated. To add or remove - this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Specifies that a window created with this style should not be painted until siblings beneath - the window (that were created by the same thread) have been painted. The window appears - transparent because the bits of underlying sibling windows have already been painted. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. - A tool window has a title bar that is shorter than a normal title bar, and the - window title is drawn using a smaller font. A tool window does not appear in - the taskbar or in the dialog that appears when the user presses ALT+TAB. If a - tool window has a system menu, its icon is not displayed on the title bar. However, - you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window has a border with a raised edge. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, - the cursor changes to a question mark with a pointer. If the user then clicks a child window, - the child receives a WM_HELP message. The child window should pass the message to the parent - window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The - Help application displays a pop-up window that typically contains help for the child window. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has - an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls - has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with - button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment, the window text is displayed using right-to-left reading-order properties. - For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order - alignment, the vertical scroll bar (if present) is to the left of the client area. For other - languages, the style is ignored. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - The window itself contains child windows that should take part in dialog box navigation. - If this style is specified, the dialog manager recurses into children of this window when - performing navigation operations such as handling the TAB key, an arrow key, or a - keyboard mnemonic. - - - - - Creates a window with a three-dimensional border style intended to be used for items that - do not accept user input. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child - windows. Also, this cannot be used if the window has a class style of either CS_OWNDC - or CS_CLASSDC. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose - horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order - using double-buffering. For more information, see Remarks. This cannot be used - if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground - window when the user clicks it. The system does not bring this window to the foreground - when the user minimizes or closes the foreground window. - - - - - Possible DIALOGEXITEMTEMPLATE WindowClass ordinals. - - - - - A button. - - - - - An edit box. - - - - - A static control. - - - - - A list box. - - - - - A scroll bar. - - - - - A combo box. - - - - - Static control styles. - A static control specifies the STATIC class, appropriate window style constants, - and a combination of the following static control styles. - http://msdn.microsoft.com/en-us/library/bb760773(VS.85).aspx - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next left-aligned - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and centers the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next centered - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and right-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next - right-aligned line. Words that are longer than the width of the control - are truncated. - - - - - Specifies an icon to be displayed in the dialog box. If the control is created - as part of a dialog box, the text is the name of an icon (not a filename) defined - elsewhere in the resource file. If the control is created via CreateWindow or a - related function, the text is the name of an icon (not a filename) defined in the - resource file associated with the module specified by the hInstance parameter to - CreateWindow. The icon can be an animated cursor. - - - - - Specifies a rectangle filled with the current window frame color. - This color is black in the default color scheme. - - - - - Specifies a rectangle filled with the current screen background color. - This color is gray in the default color scheme. - - - - - Specifies a rectangle filled with the current window background color. This color is white - in the default color scheme. - - - - - Specifies a box with a frame drawn in the same color as the window frames. - This color is black in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the screen background (desktop). - This color is gray in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the window background. This color is - white in the default color scheme. - - - - - - - - - - Specifies a simple rectangle and displays a single line of left-aligned text in the rectangle. - The text line cannot be shortened or altered in any way. Also, if the control is disabled, - the control does not gray its text. - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - Tabs are expanded, but words are not wrapped. Text that extends past the - end of a line is clipped. - - - - - Specifies that the owner of the static control is responsible for drawing - the control. The owner window receives a WM_DRAWITEM message whenever the - control needs to be drawn. - - - - - Specifies that a bitmap is to be displayed in the static control. - The text is the name of a bitmap (not a filename) defined elsewhere in the - resource file. The style ignores the nWidth and nHeight parameters; the control - automatically sizes itself to accommodate the bitmap. - - - - - Specifies that an enhanced metafile is to be displayed in the static control. - The text is the name of a metafile. An enhanced metafile static control has a - fixed size; the metafile is scaled to fit the static control's client area. - - - - - Draws the top and bottom edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the left and right edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the frame of the static control using the EDGE_ETCHED edge style. - - - - - Windows 2000: A composite style bit that results from using the OR operator on - SS_* style bits. Can be used to mask out valid SS_* bits from a given bitmask. - Note that this is out of date and does not correctly include all valid styles. - Thus, you should not use this style. - - - - - Windows XP or later: Adjusts the bitmap to fit the size of the static control. - For example, changing the locale can change the system font, and thus controls - might be resized. If a static control had a bitmap, the bitmap would no longer - fit the control. This style bit dictates automatic redimensioning of bitmaps - to fit their controls. - - - - - Prevents interpretation of any ampersand characters in the control's text as - accelerator prefix characters. These are displayed with the ampersand removed and - the next character in the string underlined. This static control style may be - included with any of the defined static controls. You can combine SS_NOPREFIX - with other styles. This can be useful when filenames or other strings that may - contain an ampersand must be displayed in a static control in a dialog box. - - - - - Sends the parent window STN_CLICKED, STN_DBLCLK, STN_DISABLE, and STN_ENABLE - notification messages when the user clicks or double-clicks the control. - - - - - Specifies that a bitmap is centered in the static control that contains it. - The control is not resized, so that a bitmap too large for the control will - be clipped. If the static control contains a single line of text, the text - is centered vertically in the client area of the control. - - - - - Specifies that the lower right corner of a static control with the SS_BITMAP - or SS_ICON style is to remain fixed when the control is resized. Only the top - and left sides are adjusted to accommodate a new bitmap or icon. - - - - - Specifies that the actual resource width is used and the icon is loaded using - LoadImage. SS_REALSIZEIMAGE is always used in conjunction with SS_ICON. - - - - - Draws a half-sunken border around a static control. - - - - - Microsoft Windows 2000: Specifies that the static control duplicates the - text-displaying characteristics of a multiline edit control. Specifically, the - average character width is calculated in the same manner as with an edit control, - and the function does not display a partially visible last line. - - - - - Microsoft Windows NT or later: If the end of a string does not fit in the rectangle, - it is truncated and ellipses are added. If a word that is not at the end of the string - goes beyond the limits of the rectangle, it is truncated without ellipses. Using this - style will force the control’s text to be on one line with no word wrap. Compare with - SS_PATHELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Replaces characters in the middle of the string with ellipses so - that the result fits in the specified rectangle. If the string contains backslash (\) - characters, SS_PATHELLIPSIS preserves as much as possible of the text after the last - backslash. Using this style will force the control’s text to be on one line with no - word wrap. Compare with SS_ENDELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Truncates any word that does not fit in the rectangle and adds ellipses. - Using this style will force the control’s text to be on one line with no word wrap. - - - - - - - - - - Push button styles. - http://msdn.microsoft.com/en-us/library/bb775951(VS.85).aspx - - - - - Creates a push button that posts a WM_COMMAND message to the owner window when the - user selects the button. - - - - - Creates a push button that behaves like a BS_PUSHBUTTON style button, but has a distinct - appearance. If the button is in a dialog box, the user can select the button by pressing - the ENTER key, even when the button does not have the input focus. This style is useful - for enabling the user to quickly select the most likely (default) option. - - - - - Creates a small, empty check box with text. By default, the text is displayed to - the right of the check box. To display the text to the left of the check box, - combine this flag with the BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). - - - - - Creates a button that is the same as a check box, except that the check state - automatically toggles between checked and cleared each time the user selects the - check box. - - - - - Creates a small circle with text. By default, the text is displayed to the right of the - circle. To display the text to the left of the circle, combine this flag with the - BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). Use radio buttons for - groups of related, but mutually exclusive choices. - - - - - Creates a button that is the same as a check box, except that the box can be grayed - as well as checked or cleared. Use the grayed state to show that the state of the - check box is not determined. - - - - - Creates a button that is the same as a three-state check box, except that the box - changes its state when the user selects it. The state cycles through checked, - indeterminate, and cleared. - - - - - Creates a rectangle in which other controls can be grouped. Any text associated with - this style is displayed in the rectangle's upper left corner. - - - - - Obsolete, but provided for compatibility with 16-bit versions of Windows. Applications - should use BS_OWNERDRAW instead. - - - - - Creates a button that is the same as a radio button, except that when the user selects it, - the system automatically sets the button's check state to checked and automatically sets - the check state for all other buttons in the same group to cleared. - - - - - - - - - - Creates an owner-drawn button. The owner window receives a WM_DRAWITEM message when a visual - aspect of the button has changed. Do not combine the BS_OWNERDRAW style with any other - button styles. - - - - - Microsoft Windows 2000: A composite style bit that results from using the OR operator on - BS_* style bits. It can be used to mask out valid BS_* bits from a given bitmask. - - - - - Places text on the left side of the radio button or check box when combined with a radio button - or check box style. Same as the BS_RIGHTBUTTON style. - - - - - Specifies that the button displays text. - - - - - Specifies that the button displays an icon. - - - - - Specifies that the button displays a bitmap. See the Remarks section for its interaction - with BS_ICON. - - - - - Left-justifies the text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is left justified on the right side - of the check box or radio button. - - - - - Right-justifies text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is right justified on the right - side of the check box or radio button. - - - - - Centers text horizontally in the button rectangle. - - - - - Places text at the top of the button rectangle. - - - - - Places text at the bottom of the button rectangle. - - - - - Places text in the middle (vertically) of the button rectangle. - - - - - Makes a button (such as a check box, three-state check box, or radio button) look and - act like a push button. The button looks raised when it isn't pushed or checked, and - sunken when it is pushed or checked. - - - - - Wraps the button text to multiple lines if the text string is too long to fit on a - single line in the button rectangle. - - - - - Enables a button to send BN_KILLFOCUS and BN_SETFOCUS notification messages to its - parent window. - - - - - Specifies that the button is two-dimensional; it does not use the default - shading to create a 3-D image. - - - - - Microsoft Windows Vista and Version 6.00. Creates a split button that behaves like a - BS_PUSHBUTTON style button, but also has a distinctive appearance. If the split button - is in a dialog box, the user can select the split button by pressing the ENTER key, even - when the split button does not have the input focus. This style is useful for enabling - the user to quickly select the most likely (default) option. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like a - BS_PUSHBUTTON style button, but the command link button has a green arrow on the left pointing - to the button text. A caption for the button text can be set by sending the BCM_SETNOTE - message to the button. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like - a BS_PUSHBUTTON style button. If the button is in a dialog box, the user can select the - command link button by pressing the ENTER key, even when the command link button does - not have the input focus. This style is useful for enabling the user to quickly select - the most likely (default) option. - - - - - Edit control styles. - http://msdn.microsoft.com/en-us/library/bb775464(VS.85).aspx - - - - - Aligns text with the left margin. - - - - - Windows 98/Me, Windows 2000/XP: Centers text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Centers text in a multiline edit control. - - - - - Windows 98/Me, Windows 2000/XP: Right-aligns text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Right aligns text in a multiline edit control. - - - - - Designates a multiline edit control. The default is single-line edit control. - - - - - Converts all characters to uppercase as they are typed into the edit control. - - - - - Converts all characters to lowercase as they are typed into the edit control. - - - - - Displays an asterisk (*) for each character typed into the edit control. - This style is valid only for single-line edit controls. - - - - - Automatically scrolls text up one page when the user presses the ENTER key on - the last line. - - - - - Automatically scrolls text to the right by 10 characters when the user types - a character at the end of the line. When the user presses the ENTER key, - the control scrolls all text back to position zero. - - - - - Negates the default behavior for an edit control. - - - - - Converts text entered in the edit control. - - - - - Prevents the user from typing or editing text in the edit control. - - - - - Specifies that a carriage return be inserted when the user presses the - ENTER key while entering text into a multiline edit control in a dialog box. - If you do not specify this style, pressing the ENTER key has the same effect - as pressing the dialog box's default push button. This style has no effect - on a single-line edit control. - - - - - Allows only digits to be entered into the edit control. - - - - - Defines the header for a menu template. - A complete menu template consists of a header and one or more menu item lists. - - - - - Specifies the version number. This member must be zero. - - - - - Specifies the offset, in bytes, from the end of the header. - The menu item list begins at this offset. Usually, this member is zero, and the menu - item list follows immediately after the header. - - - - - Defines a menu item in a menu template. - - - - - Specifies one or more of the following predefined menu options that control the appearance of the menu item. - TODO - - - - - Defines the header for an extended menu template. - - - - - Template version number. This member must be 1 for extended menu templates. - - - - - Offset of the first MENUEXITEMTEMPLATE structure, relative to the end of - this structure member. If the first item definition immediately follows the - dwHelpId member, this member should be 4. - - - - - Drop-down menu or submenu item. - - - - - Menu item type. This member can be a combination of the type (beginning with MFT) values - listed with the MENUITEMINFO structure. - - - - - Menu item state. This member can be a combination of the state (beginning with MFS) values - listed with the MENUITEMINFO structure. - - - - - Menu item identifier. This is an application-defined value that identifies the menu item. - - - - - Value specifying whether the menu item is the last item in the menu bar, drop-down menu, - submenu, or shortcut menu and whether it is an item that opens a drop-down menu or submenu. - - - - - Specifies one or more of the following predefined menu options that control the - appearance of the menu item. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item is initially inactive and drawn with a gray effect. - - - - - - - - - - - - - - - Indicates that the menu item has a check mark next to it. - - - - - - - - - - - - - - - - - - - - Indicates that the owner window of the menu is responsible for drawing all visual - aspects of the menu item, including highlighted, selected, and inactive states. - This option is not valid for an item in a menu bar. - - - - - Indicates that the item is one that opens a drop-down menu or submenu. - - - - - Indicates that the menu item is placed in a new column. The old and new columns - are separated by a bar. - - - - - Indicates that the menu item is placed in a new column. - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item has a vertical separator to its left. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Specifies whether the menu item is the last item in the menu bar, drop-down menu, submenu, or shortcut - menu and whether it is an item that opens a drop-down menu or submenu. This member can be zero or more - of these values. - - - - - Defines the last menu item in the menu bar, drop-down menu, submenu, or shortcut menu. - - - - - Defines a item that opens a drop-down menu or submenu. Subsequent structures define menu - items in the corresponding drop-down menu or submenu. - - - - - Defines an accelerator key used in an accelerator table. - http://msdn.microsoft.com/en-us/library/ms646340(VS.85).aspx - - - - - Accelerator flags. - - - - - Accelerator key. This member can be either a virtual-key code or an ASCII character code. - - - - - Accelerator identifier. - - - - - Flags, fVirt field of the Accelerator table structure. - - - - - Virtual key. - - - - - Specifies that no top-level menu item is highlighted when the accelerator is used. - This is useful when defining accelerators for actions such as scrolling that do not - correspond to a menu item. If NOINVERT is omitted, a top-level menu item will be - highlighted (if possible) when the accelerator is used. - - - - - Causes the accelerator to be activated only if the SHIFT key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the CONTROL key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the ALT key is down. - Applies only to virtual keys. - - - - - Virtual key definitions. - - - - - Standard virtual left mouse button. - - - - - Standard virtual right mouse button. - - - - - Ctrl-Break / Ctrl-C. - - - - - Standard virtual middle mouse button. - - - - - - - - - - - - - - - Backspace. - - - - - Tab. - - - - - Delete. - - - - - Return. - - - - - Shift. - - - - - Control. - - - - - Menu. - - - - - Pause. - - - - - Caps lock. - - - - - - - - - - - - - - - - - - - - - - - - - Escape. - - - - - - - - - - - - - - - - - - - - - - - - - Space. - - - - - - - - - - - - - - - End. - - - - - Home. - - - - - Left arrow. - - - - - Up arrow. - - - - - Right arrow. - - - - - Down arrow. - - - - - - - - - - Print Screen. - - - - - - - - - - - - - - - Insert. - - - - - Delete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NEC PC-9800 keyboard '=' key on numpad. - - - - - Fujitsu/OASYS keyboard 'Dictionary' key. - - - - - Fujitsu/OASYS keyboard 'Unregister word' key. - - - - - Fujitsu/OASYS keyboard 'Register word' key. - - - - - Fujitsu/OASYS keyboard 'Left OYAYUBI' key. - - - - - Fujitsu/OASYS keyboard 'Right OYAYUBI' key. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';:' for US - - - - - '+' any country - - - - - ',' any country - - - - - '-' any country - - - - - '.' any country - - - - - '/?' for US - - - - - '`~' for US - - - - - '[{' for US - - - - - '\|' for US - - - - - ']}' for US - - - - - ''"' for US - - - - - - - - - - 'AX' key on Japanese AX kbd - - - - - "<>" or "\|" on RT 102-key kbd. - - - - - Help key on ICO - - - - - 00 key on ICO - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contains information about an individual font in a font resource group. - - - - - Specifies a user-defined version number for the resource data that tools can - use to read and write resource files. - - - - - Specifies the size of the file, in bytes. - - - - - Contains a 60-character string with the font supplier's copyright information. - - - - - Specifies the type of font file. - - - - - Specifies the point size at which this character set looks best. - - - - - Specifies the vertical resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the horizontal resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the distance from the top of a character definition cell to the baseline of the - typographical font. - - - - - Specifies the amount of leading inside the bounds set by the dfPixHeight member. Accent marks and - other diacritical characters can occur in this area. - - - - - Specifies the amount of extra leading that the application adds between rows. - - - - - Specifies an italic font if not equal to zero. - - - - - Specifies an underlined font if not equal to zero. - - - - - Specifies a strikeout font if not equal to zero. - - - - - Specifies the weight of the font in the range 0 through 1000. For example, 400 is roman and - 700 is bold. If this value is zero, a default weight is used. - - - - - Specifies the character set of the font. - - - - - Specifies the width of the grid on which a vector font was digitized. For raster fonts, - if the member is not equal to zero, it represents the width for all the characters in the - bitmap. If the member is equal to zero, the font has variable-width characters. - - - - - Specifies the height of the character bitmap for raster fonts or the height of the grid - on which a vector font was digitized. - - - - - Specifies the pitch and the family of the font. - - - - - Specifies the average width of characters in the font (generally defined as the width of - the letter x). This value does not include the overhang required for bold or italic characters. - - - - - Specifies the width of the widest character in the font. - - - - - Specifies the first character code defined in the font. - - - - - Specifies the last character code defined in the font. - - - - - Specifies the character to substitute for characters not in the font. - - - - - Specifies the character that will be used to define word breaks for text justification. - - - - - Specifies the number of bytes in each row of the bitmap. This value is always even so - that the rows start on word boundaries. For vector fonts, this member has no meaning. - - - - - Specifies the offset in the file to a null-terminated string that specifies a device name. - For a generic font, this value is zero. - - - - - Specifies the offset in the file to a null-terminated string that names the typeface. - - - - - This member is reserved. - - - - - This structure depicts the organization of data in a file-version resource. - It contains version information not dependent on a particular language and code page combination. - http://msdn.microsoft.com/en-us/library/aa909193.aspx - - - - - A hardware independent dictionary of language and code page identifier tables. - - - - - A new hardware independent dictionary of language and code page identifier tables. - - - - - An existing hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - - - - Read a hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - Pointer to the end of data. - - - - Write the hardware independent dictionary of language and code page identifier tables to a binary stream. - - Binary stream. - - - - The default language and code page identifier table. - - - - - Returns a language and code page identifier table. - - Language ID. - A language and code page identifier table. - - - - String representation of VarFileInfo. - - Indent. - String in the VarFileInfo format. - - - - This structure depicts the organization of data in a file-version resource. It typically contains a - list of language and code page identifier pairs that the version of the application or DLL supports. - http://msdn.microsoft.com/en-us/library/bb202818.aspx - - - - - A dictionary of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - Table key. - - - - An existing table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - Read a table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - - Write the table of language and code page identifier pairs to a binary stream. - - Binary stream. - Last unpadded position. - - - - Returns a code page identifier for a given language. - - Language ID. - Code page identifier. - - - - String representation of the var table. - - Indent. - String representation of the var table. - - - - VS_VERSIONINFO - This structure depicts the organization of data in a file-version resource. It is the root structure - that contains all other file-version information structures. - http://msdn.microsoft.com/en-us/library/aa914916.aspx - - - - - The resource header. - - - - - A dictionary of resource tables. - - - - - An existing version resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new language-netural version resource. - - - - - Read a version resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - String representation of the file version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - String representation of the protect version. - - - - - Write this version resource to a binary stream. - - Binary stream. - - - - Returns an entry within this resource table. - - Entry key. - A resource table. - - - - Returns an entry within this resource table. - - Entry index. - A resource table. - - - - Return string representation of the version resource. - - - - - - winver.h, version management functions, types and definitions - - - - - VS_VERSION signature. - - - - - VS_VERSION structure version. - - - - - VS_VERSION file flags mask. - - - - - VS_VERSION file flags. - - - - - The file contains debugging information. - - - - - The file is a prerelease development version, not a final commercial release. - - - - - PThe file has been modified somehow and is not identical to the original file - that shipped with the product. - - - - - The file was not built using standard release procedures. There should be data - in the file's "PrivateBuild" version information string. - - - - - The version information in this structure was not found inside the file, - but instead was created when needed based on the best information available. - Therefore, this structure's information may differ slightly from what the "real" - values are. - - - - - The file was built using standard release procedures, but is somehow different - from the normal file having the same version number. There should be data in the - file's "SpecialBuild" version information string. - - - - - VS_VERSION file OSs. - - - - - The operating system under which the file was designed to run could not be determined. - - - - - The file was designed to run under MS-DOS. - - - - - The file was designed to run under a 16-bit version of OS/2. - - - - - The file was designed to run under a 32-bit version of OS/2. - - - - - The file was designed to run under Windows NT/2000. - - - - - - - - - - The file was designed to run under the 16-bit Windows API. - - - - - The file was designed to be run under a 16-bit version of Presentation Manager. - - - - - The file was designed to be run under a 32-bit version of Presentation Manager. - - - - - The file was designed to run under the 32-bit Windows API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VS_VERSION file types. - - - - - The type of file could not be determined. - - - - - The file is an application. - - - - - The file is a Dynamic Link Library (DLL). - - - - - The file is a device driver. dwFileSubtype contains more information. - - - - - The file is a font. dwFileSubtype contains more information. - - - - - The file is a virtual device. - - - - - The file is a static link library. - - - - - File sub-type. - - - - - The type of driver could not be determined. - - - - - The file is a printer driver. - - - - - The file is a keyboard driver. - - - - - The file is a language driver. - - - - - The file is a display driver. - - - - - The file is a mouse driver. - - - - - The file is a network driver. - - - - - The file is a system driver. - - - - - The file is an installable driver. - - - - - The file is a sound driver. - - - - - The file is a communications driver. - - - - - The file is an input method driver. - - - - - The file is a versioned printer driver. - - - - - The file is a raster font. - - - - - The file is a vector font. - - - - - The file is a TrueType font. - - - - diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.dll b/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.dll deleted file mode 100644 index 6e9a065..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.dll and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.xml b/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.xml deleted file mode 100644 index ca74d41..0000000 --- a/packages/Vestris.ResourceLib.2.1.0/lib/net40/Vestris.ResourceLib.xml +++ /dev/null @@ -1,6603 +0,0 @@ - - - - Vestris.ResourceLib - - - - - Standard accelerator. - - - - - Read the accelerator. - - Address in memory. - - - - Write accelerator to a binary stream. - - Binary stream. - - - - String representation of the accelerator key. - - - - - An unsigned integer value that identifies the accelerator. - - - - - String representation of the accelerator. - - String representation of the accelerator. - - - - An accelerator, RT_ACCELERATOR resource. - An accelerator provides the user with access to an application's command set. - - - - - Accelerator keys. - - - - - A new accelerator resource. - - - - - An existing accelerator resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the accelerators table. - - Handle to a module. - Pointer to the beginning of the accelerator table. - Address of the end of the accelerator table. - - - - String representation of the accelerators resource. - - - - - - Creates an 8 bit aligned copy of the buffer if it is not already aligned - - - - - A bitmap file in a .bmp format. - - - - - Device independent bitmap. - - - - - An existing bitmap file. - - A file in a .bmp format. - - - - An embedded bitmap resource. - - - - - An existing bitmap resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new bitmap resource. - - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the bitmap resource to a binary stream. - - Binary stream. - - - - A device independent bitmap. - - - - - This structure depicts the organization of data in a hardware-independent cursor resource. - - - - - A hardware-independent cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent cursor resource. - - - - - A new collection of cursors that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a cursor resource. - - - - - An existing cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new cursor resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Language. - An icon resource. - - - - Horizontal hotspot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Vertical hot spot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Write the cursor data to a file. - - Target executable file. - - - - Read DIB image. - - DIB bits. - DIB size. - - - - A device-independent image consists of a BITMAPINFOHEADER where - bmWidth is the width of the image andbmHeight is double the height - of the image, followed by the bitmap color table, followed by the image - pixels, followed by the mask pixels. - - - - - Raw image data. - - - - - Bitmap info header. - - - - - Bitmap size in bytes. - - - - - A new icon image. - - - - - A device-independent bitmap. - - Bitmap data. - - - - Create a copy of an image. - - Source image. - - - - Read icon data. - - Pointer to the beginning of icon data. - Icon data size. - - - - Size of the image mask. - - - - - Position of the DIB bitmap bits within a DIB bitmap array. - - - - - Number of colors in the palette. - - - - - Returns the width of a row in a DIB Bitmap given the number of bits. DIB Bitmap rows always align on a DWORD boundary. - - Number of bits. - Width of a row in bytes. - - - - Bitmap monochrome mask. - - - - - Bitmap color (XOR) part of the image. - - - - - Complete image. - - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - Indicates the character set to use. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Weight of the font. - - - - - Indicates whether the font is italic. - - - - - Number of dialog items. - - - - - An extended dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write dialog control to a binary stream. - - Binary stream. - - - - String representation of the dialog. - - String in the DIALOGEX [dialog] format. - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - An extended dialog control template structure. - - - - - Read the dialog control. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Return a string representation of the dialog control. - - A single line in the "CLASS name id, dimensions and styles' format. - - - - A dialog template resource. - - - - - A dialog template structure that describes the dialog. - - - - - A structured dialog resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A structured dialog resource embedded in an executable module. - - - - - Dialog resource in standard resource editor text format. - - Multi-line string. - - - - A container for the DIALOGTEMPLATE structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Number of dialog items. - - - - - A standard dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog template data to a binary stream. - - Binary stream. - - - - Returns a string representation of the dialog. - - String in the DIALOG ... format. - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Number of items in this structure. - - - - - The name of the typeface for the font. - - - - - Point size of the font to use for the text in the dialog box and its controls. - - - - - Dialog caption. - - - - - Menu resource Id. - - - - - Window class Id. - - - - - Controls within this dialog. - - - - - Dialog template representation in a standard text format. - - Multiline string. - - - - String represetnation of a control. - - - - - - Write the resource to a binary stream. - - Binary stream. - - - - A container for a control within a dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - A standard dialog control structure. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - String represetnation of a control. - - - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Dialog caption. - - - - - Window class Id. - - - - - Window class of the control. - - - - - Additional creation data. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Dialog template utility functions. - - - - - Read a dialog resource id. - - Address in memory. - Resource read. - - - - - String representation of the dialog or control style of two types. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control styles of two types. - - Dialog or control style. - Dialog or control extended style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control style of one type. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - Returns the type of the resource in this group. - - - - - Icons contained in this hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - Save a hardware-independent icon resource to an executable file. - - Name of an executable file (.exe or .dll). - - - - Read a hardware-independent icon resource from a loaded module. - - Loaded executable module. - Pointer to the beginning of a hardware-independent icon resource. - Pointer to the end of the hardware-independent icon resource. - - - - Write a hardware-independent icon resource to a binary stream. - - Binary stream. - - - - Fixed file information. - - - - - Default Windows fixed file information. - - - - - Fixed file info structure. - - - - - Read the fixed file information structure. - - Address in memory. - - - - String representation of the file version. - - - - - String representation of the protect version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - Write fixed file information to a binary stream. - - Binary stream. - - - - Size of the VS_FIXEDFILEINFO structure. - - - - - String representation of the fixed file info. - - String representation of the fixed file info. - - - - A font directory entry. - - - - - Font ordinal. - - - - - Typeface name of the font. - - - - - Specifies the name of the device if this font file is designated for a specific device. - - - - - Font information. - - - - - A new font directory entry. - - - - - Read the font directory entry. - - Pointer in memory. - Pointer to the end of the font directory entry. - - - - Write the font directory entry to a binary stream. - - Binary stream. - - - - A font directory, RT_FONTDIR resource. - - - - - Number of fonts in this directory. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font directory to a binary stream. - - Binary stream. - - - - A font, RT_FONT resource. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font resource to a binary writer. - - Binary writer. - - - - Gdi32.dll interop functions. - - - - - Bitmap compression options. - - - - - An uncompressed format. - - - - - A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression. - - - - - An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression. - - - - - Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image. - - - - - A bitmap info header. - See http://msdn.microsoft.com/en-us/library/ms532290.aspx for more information. - - - - - Bitmap information size. - - - - - Bitmap width. - - - - - Bitmap height. - - - - - Number of logical planes. - - - - - Bitmap bitrate. - - - - - Bitmap compression. - - - - - Image size. - - - - - Horizontal pixel resolution. - - - - - Vertical pixel resolution. - - - - - - - - - - - - - - - Returns the current bitmap compression. - - - - - Bitmap pixel format. - - - - - Bitmap pixel format English standard string. - - - - - Defines the dimensions and color information of a Windows-based device-independent bitmap (DIB). - http://msdn.microsoft.com/en-us/library/dd183375(VS.85).aspx. - - - - - Specifies a bitmap information header structure that contains information about the dimensions of color format. - - - - - An array of RGBQUAD. The elements of the array make up the color table. - - - - - Store colors in a paletised icon (2, 4 or 8 bit). - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Blue. - - - - - Green. - - - - - Red. - - - - - Reserved. - - - - - The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - http://msdn.microsoft.com/en-us/library/dd183374(VS.85).aspx - - - - - The file type; must be BM. - - - - - The size, in bytes, of the bitmap file. - - - - - Reserved; must be zero. - - - - - Reserved; must be zero. - - - - - The offset, in bytes, from the beginning of the BITMAPFILEHEADER structure to the bitmap bits. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Retrieves the bits of the specified compatible bitmap and copies them into a buffer as - a DIB using the specified format - - A handle to the device context. - A handle to the bitmap. This must be a compatible bitmap (DDB). - The first scan line to retrieve. - The number of scan lines to retrieve. - A pointer to a buffer to receive the bitmap data. - A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data. - The format of the bmiColors member of the BITMAPINFO structure. - - If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap. - If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is non-zero. - If the function fails, the return value is zero. - - - - - Create a DIB that applications can write to directly. The function gives you a pointer to the location - of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use - to create the bitmap, or you can let the system allocate the memory for the bitmap. - - Handle to a device context. - A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors. - The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal RGB values). - A pointer to a variable that receives a pointer to the location of the DIB bit values. - A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL. - The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. - - If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values. - If the function fails, the return value is NULL, and *ppvBits is NULL. - - - - - Defines how to interpret the values in the color table of a DIB. - - - - - The color table contains literal RGB values. - - - - - The color table consists of an array of 16-bit indexes into the LogPalette - object that is currently defined in the playback device context. - - - - - No color table exists. The pixels in the DIB are indices into the current logical - palette in the playback device context. - - - - - - - - - - Creates a memory device context (DC) compatible with the specified device. - - Handle to an existing device context. - - The handle to a memory device context indicates success. - NULL indicates failure. - - - - - - - Specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. - Specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). - This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows. - A pointer to a DEVMODE structure containing device-specific initialization data for the device driver. - - - - - Creates a bitmap compatible with the device that is associated with the specified device context. - - A handle to a device context. - The bitmap width, in pixels. - The bitmap height, in pixels. - - If the function succeeds, the return value is a handle to the compatible bitmap (DDB). - If the function fails, the return value is NULL. - - - - - Selects an object into a specified device context. The new object replaces the previous object of the same type. - - Handle to the device context. - Handle to the object to be selected. - - If the selected object is not a region, the handle of the object being replaced indicates success. - If the selected object is a region, one of the following values indicates success. - - - - - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. - - Handle to a logical pen, brush, font, bitmap, region, or palette. - - Nonzero indicates success. - Zero indicates that the specified handle is not valid or that the handle is currently selected into a device context. - - - - - Deletes the specified device context. - - A handle to the device context. - - If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. - - - - - A generic resource. - - - - - Raw resource data. - - - - - Raw resource data. - - - - - An unstructured generic resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A generic resource. - - Resource name. - Resource type. - Resource language. - - - - Read a generic resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - A new collection of icons that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a .ico file. - - - - - Resource type. - - - - - Icon. - - - - - Cursor. - - - - - Type of the group icon resource. - - - - - Collection of icons in an .ico file. - - - - - An existing .ico file. - - An existing icon (.ico) file. - - - - Load from a .ico file. - - An existing icon (.ico) file. - - - - Read icons. - - Pointer to the beginning of a FILEGRPICONDIR structure. - Pointer to the end of a FILEGRPICONDIR structure. - - - - This structure depicts the organization of icon data in a .ico file. - - - - - Icon header. - - - - - Icon bitmap. - - - - - New icon data. - - - - - Icon width. - - - - - Icon height. - - - - - Image size in bytes. - - - - - Read a single icon (.ico). - - Pointer to the beginning of this icon's data. - Pointer to the beginning of all icon data. - Pointer to the end of this icon's data. - - - - Icon size as a string. - - Icon size in the width x height format. - - - - This structure depicts the organization of data in an icon resource. - - - - - Directory header. - - - - - Actual image. - - - - - Hardware-independent icon directory header. - - - - - Embedded icon Id. - - - - - An icon image. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Create a new icon image resource from a file icon. - - File icon. - Resource type. - Resource id. - Resource language. - - - - Icon width in pixels. - - - - - Icon height in pixels. - - - - - Image size in bytes. - - - - - Read an icon resource from a previously loaded module. - - Module handle. - Pointer to a directory entry in the hardware-independent icon resource. - Pointer to the end of the icon resource. - - - - Read the bitmap image. - - DIB bits. - Size of image. - - - - Icon pixel format. - - - - - Icon pixel format English standard string. - - - - - String representation of the icon. - - A string in a format of width x height followed by the pixel format. - - - - Write icon resource data to a binary stream. - - Binary stream. - - - - Save icon to a file. - - Target executable file. - - - - This structure depicts the organization of data in an icon resource. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Resource language. - An icon resource. - - - - Kernel32.dll interop functions. - - - - - A resource header. - - - - - Header length. - - - - - Data length. - - - - - Resource type. - - - - - A new resource header of a given length. - - - - - - Resource header type. - - - - - Binary data. - - - - - String data. - - - - - Language and code page combinations. - The low-order word of each DWORD must contain a Microsoft language identifier, - and the high-order word must contain the IBM code page number. - Either high-order or low-order word can be zero, indicating that the file is language - or code page independent. - - - - - Microsoft language identifier. - - - - - IBM code page number. - - - - - This structure contains version information about a file. - This information is language- and code page–independent. - http://msdn.microsoft.com/en-us/library/ms647001.aspx - - - - - Contains the value 0xFEEF04BD. This is used with the szKey member of the VS_VERSIONINFO structure when searching a file for the VS_FIXEDFILEINFO structure. - - - - - Specifies the binary version number of this structure. The high-order word of this member contains the major version number, and the low-order word contains the minor version number. - - - - - Specifies the most significant 32 bits of the file's binary version number. This member is used with dwFileVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the file's binary version number. This member is used with dwFileVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the most significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Contains a bitmask that specifies the valid bits in dwFileFlags. A bit is valid only if it was defined when the file was created. - - - - - Contains a bitmask that specifies the Boolean attributes of the file. - - - - - Specifies the operating system for which this file was designed. - - - - - Specifies the general type of file. - - - - - Specifies the function of the file. - - - - - Specifies the most significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Specifies the least significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Creates a default Windows VS_FIXEDFILEINFO structure. - - A default Windows VS_FIXEDFILEINFO. - - - - A hardware-independent icon directory resource header. - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Reserved, must be zero. - - - - - Resource type, 1 for icons. - - - - - Number of images. - - - - - Hardware-independent icon directory entry. - See http://msdn.microsoft.com/en-us/library/ms997538.aspx for more information. - - - - - Width of the image. Starting with Windows 95 a value of 0 represents width of 256. - - - - - Height of the image. Starting with Windows 95 a value of 0 represents height of 256. - - - - - Number of colors in the image. - bColors = 1 << (wBitsPerPixel * wPlanes) - If wBitsPerPixel* wPlanes is greater orequal to 8, then bColors = 0. - - - - - Reserved. - - - - - Number of bitmap planes. - 1: monochrome bitmap - - - - - Bits per pixel. - 1: monochrome bitmap - - - - - Image size in bytes. - - - - - Icon ID. - - - - - Hardware-independent icon directory entry in an .ico file. - - - - - Icon width. - - - - - Icon height. - - - - - Colors; 0 means 256 or more. - - - - - Reserved. - - - - - Number of bitmap planes for icons. - Horizontal hotspot for cursors. - - - - - Bits per pixel for icons. - Vertical hostpot for cursors. - - - - - Image size in bytes. - - - - - Offset of bitmap data from the beginning of the file. - - - - - Hardware-independent icon structure in an .ico file. - - - - - Reserved, must be zero. - - - - - Resource Type (1 for icons). - - - - - Number of images. - - - - - If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. - - - - - If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. - - - - - If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy. - - - - - If this value is used, the system does not perform automatic trust comparisons on the DLL or its dependents when they are loaded. - - - - - Loads the specified module into the address space of the calling process. - The specified module may cause other modules to be loaded. - - The name of the module. - This parameter is reserved for future use. - The action to be taken when loading the module. - - - - - Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. - - A handle to the loaded library module. - If the function succeeds, the return value is nonzero. - - - - Predefined resource types. - - - - - Hardware-dependent cursor resource. - - - - - Bitmap resource. - - - - - Hardware-dependent icon resource. - - - - - Menu resource. - - - - - Dialog box. - - - - - String-table entry. - - - - - Font directory resource. - - - - - Font resource. - - - - - Accelerator table. - - - - - Application-defined resource (raw data). - - - - - Message-table entry. - - - - - Hardware-independent cursor resource. - - - - - Hardware-independent icon resource. - - - - - Version resource. - - - - - Allows a resource editing tool to associate a string with an .rc file. - - - - - Plug and Play resource. - - - - - VXD. - - - - - Animated cursor. - - - - - Animated icon. - - - - - HTML. - - - - - Microsoft Windows XP: Side-by-Side Assembly XML Manifest. - - - - - Enumerates resource types within a binary module. - - Handle to a module to search. - Pointer to the callback function to be called for each enumerated resource type. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful; otherwise, FALSE. - - - - An application-defined callback function used with the EnumResourceTypes and EnumResourceTypesEx functions. - - The handle to the module whose executable file contains the resources for which the types are to be enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the type is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceTypes or EnumResourceTypesEx function. - Returns TRUE if successful; otherwise, FALSE. - - - - Enumerates resources of a specified type within a binary module. - - Handle to a module to search. - Pointer to a null-terminated string specifying the type of the resource for which the name is being enumerated. - Pointer to the callback function to be called for each enumerated resource name or ID. - Specifies an application-defined value passed to the callback function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - An application-defined callback function used with the EnumResourceNames and EnumResourceNamesEx functions. - - The handle to the module whose executable file contains the resources that are being enumerated. - Pointer to a null-terminated string specifying the type of resource that is being enumerated. - Specifies the name of a resource of the type being enumerated. - Specifies the application-defined parameter passed to the EnumResourceNames or EnumResourceNamesEx function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - Enumerates language-specific resources, of the specified type and name, associated with a binary module. - - The handle to a module to search. - Pointer to a null-terminated string specifying the type of resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Pointer to the callback function to be called for each enumerated resource language. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful or FALSE otherwise. - - - - An application-defined callback function used with the EnumResourceLanguages and EnumResourceLanguagesEx functions. - - The handle to the module whose executable file contains the resources for which the languages are being enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Specifies the language identifier for the resource for which the language is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceLanguages or EnumResourceLanguagesEx function. - Returns TRUE if successful or FALSE otherwise. - - - - Determines the location of the resource with the specified type, name, and language in the specified module. - - Handle to the module whose executable file contains the resource. - Pointer to a null-terminated string specifying the type name of the resource. - Pointer to a null-terminated string specifying the name of the resource. - Specifies the language of the resource. - If the function succeeds, the return value is a handle to the specified resource's information block. - - - - Locks the specified resource in memory. - - Handle to the resource to be locked. - If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL. - - - - Loads the specified resource into global memory. - - Handle to the module whose executable file contains the resource. - Handle to the resource to be loaded. - If the function succeeds, the return value is a handle to the data associated with the resource. - - - - Returns the size, in bytes, of the specified resource. - - Handle to the module whose executable file contains the resource. - Handle to the resource. This handle must be created by using the FindResource or FindResourceEx function. - If the function succeeds, the return value is the number of bytes in the resource. - - - - Closes an open object handle. - - A valid handle to an open object. - If the function succeeds, the return value is nonzero. - - - - Returns a handle to either a language-neutral portable executable file (LN file) or a - language-specific resource file (.mui file) that can be used by the UpdateResource function - to add, delete, or replace resources in a binary module. - - Pointer to a null-terminated string that specifies the binary file in which to update resources. - Specifies whether to delete the pFileName parameter's existing resources. - If the function succeeds, the return value is a handle that can be used by the UpdateResource and EndUpdateResource functions. - - - - Adds, deletes, or replaces a resource in a portable executable (PE) file. - There are some restrictions on resource updates in files that contain Resource Configuration (RC Config) data: - language-neutral (LN) files and language-specific resource (.mui) files. - - A module handle returned by the BeginUpdateResource function, referencing the file to be updated. - Pointer to a null-terminated string specifying the resource type to be updated. - Pointer to a null-terminated string specifying the name of the resource to be updated. - Specifies the language identifier of the resource to be updated. - Pointer to the resource data to be inserted into the file indicated by hUpdate. - Specifies the size, in bytes, of the resource data at lpData. - Returns TRUE if successful or FALSE otherwise. - - - - Commits or discards changes made prior to a call to UpdateResource. - - A module handle returned by the BeginUpdateResource function, and used by UpdateResource, referencing the file to be updated. - Specifies whether to write the resource updates to the file. If this parameter is TRUE, no changes are made. If it is FALSE, the changes are made: the resource updates will take effect. - Returns TRUE if the function succeeds; FALSE otherwise. - - - - Neutral primary language ID. - - - - - US-English primary language ID. - - - - - Neutral sublanguage ID. - - - - - US-English sublanguage ID. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID is used primarily for EXEs. If an executable has a resource of type RT_MANIFEST, - ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will create a process default activation context for the process. - The process default activation context will be used by all components running in the process. - CREATEPROCESS_MANIFEST_RESOURCE_ID can also used by DLLs. When Windows probe for dependencies, if the dll has - a resource of type RT_MANIFEST, ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will use that manifest as the - dependency. - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID is used primarily for DLLs. It should be used if the dll wants private - dependencies other than the process default. For example, if an dll depends on comctl32.dll version 6.0.0.0. - It should have a resource of type RT_MANIFEST, ID ISOLATIONAWARE_MANIFEST_RESOURCE_ID to depend on comctl32.dll - version 6.0.0.0, so that even if the process executable wants comctl32.dll version 5.1, the dll itself will still - use the right version of comctl32.dll. - - - - - When ISOLATION_AWARE_ENABLED is defined, Windows re-defines certain APIs. For example LoadLibraryExW - is redefined to IsolationAwareLoadLibraryExW. - - - - - Resource manifest type. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_NOSTATICIMPORT_MANIFEST_RESOURCE_ID - - - - - Copies the contents of a source memory block to a destination memory block, and supports overlapping source and destination memory blocks. - - A pointer to the starting address of the copied block's destination. - A pointer to the starting address of the block of memory to copy. - The size of the block of memory to copy, in bytes. - - - - A resource load exception. - - - - - The Win32 exception from a resource enumeration function. - - - - - A new resource load exception. - - Error message. - The inner exception thrown within a single resource. - The outer exception from the Win32 API. - - - - A combined message of the inner and outer exception. - - - - - An embedded SxS manifest. - - - - - Embedded XML manifest. - - - - - Manifest type. - - - - - An existing embedded manifest resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new executable CreateProcess manifest. - - - - - A new executable manifest. - - Manifest type. - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - Load a manifest resource from an executable file. - - Name of an executable file (.exe or .dll). - Manifest resource type. - - - - Extended menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write the menu template. - - Binary stream. - - - - String representation of the menu in the MENUEX format. - - String representation of the menu. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of extended menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - A command menu item. - - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - An extended popup menu item. - - - - - Sub menu items. - - - - - An extended popup menu item. - - - - - Read an extended popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENUEX format. - - String representation. - - - - A generic resource. - - - - - Menu template. - - - - - A structured menu resource. - - - - - A structured menu resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - Read a menu resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the menu resource to a binary stream. - - Binary stream. - - - - String representation of the menu resource in the MENU format. - - String representation of the menu resource. - - - - Standard menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write menu template to a binary stream. - - Binary stream. - - - - String representation of the menu in the MENU format. - - String representation of the menu. - - - - A menu template header. - - - - - Read the menu template header. - - Address in memory. - - - - Write the menu to a binary stream. - - Binary stream. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - Command menu id. - - - - - A command menu item. - - - - - Read a command menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A popup menu item. - - - - - Sub menu items. - - - - - A popup menu item. - - - - - Read a popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - A version resource. - - - - - Resource type. - - - - - Resource name. - - - - - Resource language. - - - - - Loaded binary nodule. - - - - - Pointer to the resource. - - - - - Resource size. - - - - - Version resource size in bytes. - - - - - Language ID. - - - - - Resource type. - - - - - String representation of the resource type. - - - - - Resource name. - - - - - A new resource. - - - - - A structured resource embedded in an executable module. - - Module handle. - Resource handle. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Lock and read the resource. - - Module handle. - Resource handle. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - Resource name. - Resource type. - Resource language. - - - - Load a resource from an executable (.exe or .dll) module. - - An executable (.exe or .dll) module. - Resource type. - Resource name. - Resource language. - - - - Read a resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - Write the resource to a memory stream. - - Binary stream. - - - - Return resource data. - - Resource data. - - - - Save a resource. - - Name of an executable file (.exe or .dll). - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Language id. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - Resource data. - - - - Save a batch of resources to a given file. - - Path to an executable file. - The resources to write. - - - - A resource Id. - There're two types of resource Ids, reserved integer numbers (eg. RT_ICON) and custom string names (eg. "CUSTOM"). - - - - - A resource identifier. - - A integer or string resource id. - - - - A resource identifier. - - A integer resource id. - - - - A well-known resource-type identifier. - - A well known resource type. - - - - A custom resource identifier. - - - - - - Resource Id. - - - If the resource Id is a string, it will be copied. - - - - - String representation of a resource type name. - - - - - An enumerated resource type for built-in resource types only. - - - - - Returns true if the resource is an integer resource. - - - - - Returns true if the resource is an integer resource. - - Resource pointer. - - - - Resource Id in a string format. - - - - - String representation of the resource Id. - - Resource name. - - - - Resource Id hash code. - Resource Ids of the same type have the same hash code. - - Resource Id. - - - - Compares two resource Ids by value. - - Resource Id. - True if both resource Ids represent the same resource. - - - - Resource info manager. - - - - - A dictionary of resources, the key is the resource type, eg. "REGISTRY" or "16" (version). - - - - - A shortcut for available resource types. - - - - - A new resource info. - - - - - Unload the previously loaded module. - - - - - Load an executable or a DLL and read its resources. - - Source filename. - - - - Enumerate resource types. - - Module handle. - Resource type. - Additional parameter. - TRUE if successful. - - - - Enumerate resource names within a resource by type - - Module handle. - Resource type. - Resource name. - Additional parameter. - TRUE if successful. - - - - Create a resource of a given type. - - Module handle. - Pointer to the resource in memory. - Resource type. - Resource name. - Language ID. - Size of resource. - A specialized or a generic resource. - - - - Enumerate resource languages within a resource by name - - Module handle. - Resource type. - Resource name. - Language ID. - Additional parameter. - TRUE if successful. - - - - Save resource to a file. - - Target filename. - - - - Dispose resource info object. - - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - A resource table header. - - - - - Resource table header. - - - - - Resource table key. - - - - - Resource table key. - - - - - Resource header. - - - - - A new resource table header. - - - - - An resource table header with a specific key. - - resource key - - - - An existing resource table. - - Pointer to resource table data. - - - - Read the resource header, return a pointer to the end of it. - - Top of header. - End of header, after the key, aligned at a 32 bit boundary. - - - - Write the resource table. - - Binary stream. - - - - String representation. - - String representation. - - - - String representation. - - Indent. - String representation. - - - - Resource utilities. - - - - - Align an address to a 4-byte boundary. - - Address in memory. - 4-byte aligned pointer. - - - - Align a pointer to a 4-byte boundary. - - Pointer to an address in memory. - 4-byte aligned pointer. - - - - Pad data to a WORD. - - Binary stream. - New position within the binary stream. - - - - Pad data to a DWORD. - - Binary stream. - New position within the binary stream. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Write a value at a given position. - Used to write a size of data in an earlier located header. - - Binary stream. - Value to write. - Address to write the value at. - - - - Pad bytes. - - Binary stream. - Number of bytes to write. - New position within the stream. - - - - Neutral language ID. - - - - - US-English language ID. - - - - - Make a language ID from a primary language ID (low-order 10 bits) and a sublanguage (high-order 6 bits). - - Primary language ID. - Sublanguage ID. - Microsoft language ID. - - - - Return the primary language ID from a Microsoft language ID. - - Microsoft language ID - primary language ID (low-order 10 bits) - - - - Return the sublanguage ID from a Microsoft language ID. - - Microsoft language ID. - Sublanguage ID (high-order 6 bits). - - - - Returns the memory representation of an object. - - Object type. - Data. - Object's representation in memory. - - - - Get a collection of flags from a flag value. - - Flag collection type. - Flag value. - Collection of flags. - - - - Get a string representation of flags. - - Flag collection type. - Flag vlaue - String representation of flags in the f1 | ... | fn format. - - - - This structure depicts the organization of data in a file-version resource. - It contains version information that can be displayed for a particular language and code page. - http://msdn.microsoft.com/en-us/library/aa908808.aspx - - - - - Resource strings. - - - - - A new string file-version resource. - - - - - An existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - - - - Read an existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - Pointer to the end of the string file-version resource. - - - - Write the string file-version resource to a binary stream. - - Binary stream. - - - - Default (first) string table. - - - - - Indexed string table. - - Key. - A string table at a given index. - - - - String representation of StringFileInfo. - - Indent. - String in the StringFileInfo format. - - - - A string, RT_STRING resource. - Each string resource block has 16 strings, each represented as an ordered pair - (length, text). Length is a WORD that specifies the size, in terms of the number of characters, - in the text that follows. Text follows length and contains the string in Unicode without the - NULL terminating character. There may be no characters in text, in which case length is zero. - - - - - String collection in this resource. - - - - - Returns a string of a given Id. - - String Id. - A string of a given Id. - - - - A new string resource. - - - - - A new string resource of a given block id. - - Block id. - - - - A new string resource of a given block id. - - Block id. - - - - An existing string resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A string with ID, stringId, is located in the block with ID given by the following formula. - http://support.microsoft.com/kb/q196774/ - - - - - String table block id. - - - - - Read the strings. - - Handle to a module. - Pointer to the beginning of the string table. - Address of the end of the string table. - - - - String representation of the strings resource. - - - - - - This structure depicts the organization of data in a file-version resource. It contains language - and code page formatting information for the strings. A code page is an ordered character set. - See http://msdn.microsoft.com/en-us/library/aa909192.aspx for more information. - - - - - Resource strings. - - - - - A new string table. - - - - - A new string table. - - String table key. - - - - An existing string table. - - Pointer to the beginning of the table. - - - - Read a string table. - - Pointer to the beginning of the string table. - Pointer to the end of the string table. - - - - Write the string table to a binary stream. - - Binary stream. - Last unpadded position. - - - - The four most significant digits of the key represent the language identifier. - Each Microsoft Standard Language identifier contains two parts: the low-order 10 bits - specify the major language, and the high-order 6 bits specify the sublanguage. - - - - - The four least significant digits of the key represent the code page for which the data is formatted. - - - - - Returns an entry within the string table. - - Key. - An entry within the string table. - - - - String representation of the string table. - - Indent. - String representation of the strings table. - - - - This structure depicts the organization of data in a file-version resource. It contains a string - that describes a specific aspect of a file, such as a file's version, its copyright notices, - or its trademarks. - http://msdn.microsoft.com/en-us/library/aa909025.aspx - - - - - The value is always stored double-null-terminated. - - - - - When set to true the length in the header will also contain the padding bytes when writing to a stream. - The MSDN reference (http://www.webcitation.org/6zBLYbvww) does not clarify which variant is 'right'. - - - - - String resource header. - - - - - Key. - - - - - String value (removing the double-null-terminator). - - - - - Value. - - - - - A new string resource. - - Key. - - - - An existing string resource. - - Pointer to the beginning of a string resource. - - - - Read a string resource. - - Pointer to the beginning of a string resource. - - - - Write a string resource to a binary stream. - - Binary stream. - - - - User32.dll functions. - - - - - Contains information about an icon or a cursor. - - - - - Specifies whether this structure defines an icon or a cursor. - A value of TRUE specifies an icon; FALSE specifies a cursor. - - - - - Specifies the x-coordinate of a cursor's hot spot. If this structure defines an icon, the hot spot is - always in the center of the icon, and this member is ignored. - - - - - Specifies the y-coordinate of the cursor's hot spot. If this structure defines an icon, the hot spot - is always in the center of the icon, and this member is ignored. - - - - - Specifies the icon bitmask bitmap. - - - - - Handle to the icon color bitmap. - - - - - Retrieve a handle to a device context (DC) for the client area of a specified window or for the entire screen. - - A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. - - If the function succeeds, the return value is a handle to the DC for the specified window's client area. - If the function fails, the return value is NULL. - - - - - Releases a device context (DC), freeing it for use by other applications. - - A handle to the window whose DC is to be released. - A handle to the DC to be released. - - The return value indicates whether the DC was released. If the DC was released, the return value is 1. - If the DC was not released, the return value is zero. - - - - - The DIALOGTEMPLATE structure defines the dimensions and style of a dialog box. - This structure, always the first in a standard template for a dialog box, - also specifies the number of controls in the dialog box and therefore specifies - the number of subsequent DIALOGITEMTEMPLATE structures in the template. - - - - - Specifies the style of the dialog box. - - - - - Extended styles for a window. - - - - - Specifies the number of items in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - The DIALOGITEMTEMPLATE structure defines the dimensions and style of a control in a dialog box. - - - - - Specifies the style of the control. - - - - - Extended styles for a window. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the width, in dialog box units, of the control. - - - - - Specifies the height, in dialog box units, of the control. - - - - - Specifies the control identifier. - - - - - An extended dialog box template begins with a DIALOGEXTEMPLATE header that describes - the dialog box and specifies the number of controls in the dialog box. For each - control in a dialog box, an extended dialog box template has a block of data that - uses the DIALOGEXITEMTEMPLATE format to describe the control. - - - - - Specifies the version number of the extended dialog box template. This member must be 1. - - - - - Indicates whether a template is an extended dialog box template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the number of controls in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - A control entry in an extended dialog template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - Specifies the control identifier. - - - - - Window styles. - http://msdn.microsoft.com/en-us/library/ms632600(VS.85).aspx - - - - - Creates an overlapped window. An overlapped window has a title bar and - a border. Same as the WS_TILED style. - - - - - Creates a pop-up window. This style cannot be used with the WS_CHILD style. - - - - - Creates a child window. A window with this style cannot have - a menu bar. This style cannot be used with the WS_POPUP style. - - - - - Creates a window that is initially minimized. Same as the WS_ICONIC style. - - - - - Creates a window that is initially visible. - - - - - Creates a window that is initially disabled. A disabled window cannot receive - input from the user. - - - - - Clips child windows relative to each other; that is, when a particular - child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips - all other overlapping child windows out of the region of the child window - to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, - it is possible, when drawing within the client area of a child window, to draw - within the client area of a neighboring child window. - - - - - Excludes the area occupied by child windows when drawing occurs - within the parent window. This style is used when creating the parent window. - - - - - Creates a window that is initially maximized. - - - - - Creates a window that has a title bar (includes the WS_BORDER style). - - - - - Creates a window that has a thin-line border. - - - - - Creates a window that has a border of a style typically used with dialog - boxes. A window with this style cannot have a title bar. - - - - - Creates a window that has a vertical scroll bar. - - - - - Creates a window that has a horizontal scroll bar. - - - - - Creates a window that has a window menu on its title bar. The WS_CAPTION - style must also be specified. - - - - - Creates a window that has a sizing border. Same as the WS_SIZEBOX style. - - - - - Specifies the first control of a group of controls. The group consists of this - first control and all controls defined after it, up to the next control with - the WS_GROUP style. The first control in each group usually has the WS_TABSTOP - style so that the user can move from group to group. The user can subsequently - change the keyboard focus from one control in the group to the next control in - the group by using the direction keys. - - - - - Specifies a control that can receive the keyboard focus when the user presses - the TAB key. Pressing the TAB key changes the keyboard focus to the next - control with the WS_TABSTOP style. - - - - - Dialog styles. - http://msdn.microsoft.com/en-us/library/ms644994(VS.85).aspx - - - - - Specifying this style in the dialog template tells Windows that the dtX and dtY values - of the DIALOGTEMPLATE struct are relative to the screen origin, not the owner of the - dialog box. - - - - - Create a dialog box with the WS_EX_TOPMOST flag. This flag cannot be combined with the - DS_CONTROL style. This flag is obsolete and is included for compatibility with 16-bit - versions of Windows. - - - - - Applies to 16-bit applications only. This style directs edit controls in the dialog - box to allocate memory from the application data segment. Otherwise, edit controls - allocate storage from a global memory object. - - - - - Indicates that the header of the dialog box template contains additional data specifying - the font to use for text in the client area and controls of the dialog box. - - - - - Creates a dialog box with a modal dialog-box frame that can be combined with a title - bar and window menu by specifying the WS_CAPTION and WS_SYSMENU styles. - - - - - Suppresses WM_ENTERIDLE messages that the system would otherwise send to the owner of the - dialog box while the dialog box is displayed. - - - - - Causes the system to use the SetForegroundWindow function to bring the dialog - box to the foreground. - - - - - Gives the dialog box a nonbold font and draws three-dimensional borders around - control windows in the dialog box. - - - - - Causes the dialog box to use the SYSTEM_FIXED_FONT instead of the default SYSTEM_FONT. - This is a monospace font compatible with the System font in 16-bit versions of Windows - earlier than 3.0. - - - - - Creates the dialog box even if errors occur — for example, if a child window cannot be - created or if the system cannot create a special data segment for an edit control. - - - - - Creates a dialog box that works well as a child window of another dialog box, - much like a page in a property sheet. This style allows the user to tab among - the control windows of a child dialog box, use its accelerator keys, and so on. - - - - - Centers the dialog box in the working area; that is, the area not obscured by the tray. - - - - - Centers the dialog box on the mouse cursor. - - - - - Includes a question mark in the title bar of the dialog box. When the user clicks the - question mark, the cursor changes to a question mark with a pointer. If the user then - clicks a control in the dialog box, the control receives a WM_HELP message. The control - should pass the message to the dialog box procedure, which should call the function - using the HELP_WM_HELP command. The help application displays a pop-up window that - typically contains help for the control. - - - - - Indicates that the dialog box should use the system font. - - - - - - - - - - Extended dialog styles. - - - - - Creates a window that has a double border; the window can, optionally, be created - with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY - message to its parent window when it is created or destroyed. - - - - - Specifies that a window created with this style should be placed above all non-topmost - windows and should stay above them, even when the window is deactivated. To add or remove - this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Specifies that a window created with this style should not be painted until siblings beneath - the window (that were created by the same thread) have been painted. The window appears - transparent because the bits of underlying sibling windows have already been painted. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. - A tool window has a title bar that is shorter than a normal title bar, and the - window title is drawn using a smaller font. A tool window does not appear in - the taskbar or in the dialog that appears when the user presses ALT+TAB. If a - tool window has a system menu, its icon is not displayed on the title bar. However, - you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window has a border with a raised edge. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, - the cursor changes to a question mark with a pointer. If the user then clicks a child window, - the child receives a WM_HELP message. The child window should pass the message to the parent - window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The - Help application displays a pop-up window that typically contains help for the child window. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has - an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls - has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with - button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment, the window text is displayed using right-to-left reading-order properties. - For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order - alignment, the vertical scroll bar (if present) is to the left of the client area. For other - languages, the style is ignored. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - The window itself contains child windows that should take part in dialog box navigation. - If this style is specified, the dialog manager recurses into children of this window when - performing navigation operations such as handling the TAB key, an arrow key, or a - keyboard mnemonic. - - - - - Creates a window with a three-dimensional border style intended to be used for items that - do not accept user input. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child - windows. Also, this cannot be used if the window has a class style of either CS_OWNDC - or CS_CLASSDC. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose - horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order - using double-buffering. For more information, see Remarks. This cannot be used - if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground - window when the user clicks it. The system does not bring this window to the foreground - when the user minimizes or closes the foreground window. - - - - - Possible DIALOGEXITEMTEMPLATE WindowClass ordinals. - - - - - A button. - - - - - An edit box. - - - - - A static control. - - - - - A list box. - - - - - A scroll bar. - - - - - A combo box. - - - - - Static control styles. - A static control specifies the STATIC class, appropriate window style constants, - and a combination of the following static control styles. - http://msdn.microsoft.com/en-us/library/bb760773(VS.85).aspx - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next left-aligned - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and centers the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next centered - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and right-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next - right-aligned line. Words that are longer than the width of the control - are truncated. - - - - - Specifies an icon to be displayed in the dialog box. If the control is created - as part of a dialog box, the text is the name of an icon (not a filename) defined - elsewhere in the resource file. If the control is created via CreateWindow or a - related function, the text is the name of an icon (not a filename) defined in the - resource file associated with the module specified by the hInstance parameter to - CreateWindow. The icon can be an animated cursor. - - - - - Specifies a rectangle filled with the current window frame color. - This color is black in the default color scheme. - - - - - Specifies a rectangle filled with the current screen background color. - This color is gray in the default color scheme. - - - - - Specifies a rectangle filled with the current window background color. This color is white - in the default color scheme. - - - - - Specifies a box with a frame drawn in the same color as the window frames. - This color is black in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the screen background (desktop). - This color is gray in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the window background. This color is - white in the default color scheme. - - - - - - - - - - Specifies a simple rectangle and displays a single line of left-aligned text in the rectangle. - The text line cannot be shortened or altered in any way. Also, if the control is disabled, - the control does not gray its text. - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - Tabs are expanded, but words are not wrapped. Text that extends past the - end of a line is clipped. - - - - - Specifies that the owner of the static control is responsible for drawing - the control. The owner window receives a WM_DRAWITEM message whenever the - control needs to be drawn. - - - - - Specifies that a bitmap is to be displayed in the static control. - The text is the name of a bitmap (not a filename) defined elsewhere in the - resource file. The style ignores the nWidth and nHeight parameters; the control - automatically sizes itself to accommodate the bitmap. - - - - - Specifies that an enhanced metafile is to be displayed in the static control. - The text is the name of a metafile. An enhanced metafile static control has a - fixed size; the metafile is scaled to fit the static control's client area. - - - - - Draws the top and bottom edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the left and right edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the frame of the static control using the EDGE_ETCHED edge style. - - - - - Windows 2000: A composite style bit that results from using the OR operator on - SS_* style bits. Can be used to mask out valid SS_* bits from a given bitmask. - Note that this is out of date and does not correctly include all valid styles. - Thus, you should not use this style. - - - - - Windows XP or later: Adjusts the bitmap to fit the size of the static control. - For example, changing the locale can change the system font, and thus controls - might be resized. If a static control had a bitmap, the bitmap would no longer - fit the control. This style bit dictates automatic redimensioning of bitmaps - to fit their controls. - - - - - Prevents interpretation of any ampersand characters in the control's text as - accelerator prefix characters. These are displayed with the ampersand removed and - the next character in the string underlined. This static control style may be - included with any of the defined static controls. You can combine SS_NOPREFIX - with other styles. This can be useful when filenames or other strings that may - contain an ampersand must be displayed in a static control in a dialog box. - - - - - Sends the parent window STN_CLICKED, STN_DBLCLK, STN_DISABLE, and STN_ENABLE - notification messages when the user clicks or double-clicks the control. - - - - - Specifies that a bitmap is centered in the static control that contains it. - The control is not resized, so that a bitmap too large for the control will - be clipped. If the static control contains a single line of text, the text - is centered vertically in the client area of the control. - - - - - Specifies that the lower right corner of a static control with the SS_BITMAP - or SS_ICON style is to remain fixed when the control is resized. Only the top - and left sides are adjusted to accommodate a new bitmap or icon. - - - - - Specifies that the actual resource width is used and the icon is loaded using - LoadImage. SS_REALSIZEIMAGE is always used in conjunction with SS_ICON. - - - - - Draws a half-sunken border around a static control. - - - - - Microsoft Windows 2000: Specifies that the static control duplicates the - text-displaying characteristics of a multiline edit control. Specifically, the - average character width is calculated in the same manner as with an edit control, - and the function does not display a partially visible last line. - - - - - Microsoft Windows NT or later: If the end of a string does not fit in the rectangle, - it is truncated and ellipses are added. If a word that is not at the end of the string - goes beyond the limits of the rectangle, it is truncated without ellipses. Using this - style will force the control’s text to be on one line with no word wrap. Compare with - SS_PATHELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Replaces characters in the middle of the string with ellipses so - that the result fits in the specified rectangle. If the string contains backslash (\) - characters, SS_PATHELLIPSIS preserves as much as possible of the text after the last - backslash. Using this style will force the control’s text to be on one line with no - word wrap. Compare with SS_ENDELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Truncates any word that does not fit in the rectangle and adds ellipses. - Using this style will force the control’s text to be on one line with no word wrap. - - - - - - - - - - Push button styles. - http://msdn.microsoft.com/en-us/library/bb775951(VS.85).aspx - - - - - Creates a push button that posts a WM_COMMAND message to the owner window when the - user selects the button. - - - - - Creates a push button that behaves like a BS_PUSHBUTTON style button, but has a distinct - appearance. If the button is in a dialog box, the user can select the button by pressing - the ENTER key, even when the button does not have the input focus. This style is useful - for enabling the user to quickly select the most likely (default) option. - - - - - Creates a small, empty check box with text. By default, the text is displayed to - the right of the check box. To display the text to the left of the check box, - combine this flag with the BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). - - - - - Creates a button that is the same as a check box, except that the check state - automatically toggles between checked and cleared each time the user selects the - check box. - - - - - Creates a small circle with text. By default, the text is displayed to the right of the - circle. To display the text to the left of the circle, combine this flag with the - BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). Use radio buttons for - groups of related, but mutually exclusive choices. - - - - - Creates a button that is the same as a check box, except that the box can be grayed - as well as checked or cleared. Use the grayed state to show that the state of the - check box is not determined. - - - - - Creates a button that is the same as a three-state check box, except that the box - changes its state when the user selects it. The state cycles through checked, - indeterminate, and cleared. - - - - - Creates a rectangle in which other controls can be grouped. Any text associated with - this style is displayed in the rectangle's upper left corner. - - - - - Obsolete, but provided for compatibility with 16-bit versions of Windows. Applications - should use BS_OWNERDRAW instead. - - - - - Creates a button that is the same as a radio button, except that when the user selects it, - the system automatically sets the button's check state to checked and automatically sets - the check state for all other buttons in the same group to cleared. - - - - - - - - - - Creates an owner-drawn button. The owner window receives a WM_DRAWITEM message when a visual - aspect of the button has changed. Do not combine the BS_OWNERDRAW style with any other - button styles. - - - - - Microsoft Windows 2000: A composite style bit that results from using the OR operator on - BS_* style bits. It can be used to mask out valid BS_* bits from a given bitmask. - - - - - Places text on the left side of the radio button or check box when combined with a radio button - or check box style. Same as the BS_RIGHTBUTTON style. - - - - - Specifies that the button displays text. - - - - - Specifies that the button displays an icon. - - - - - Specifies that the button displays a bitmap. See the Remarks section for its interaction - with BS_ICON. - - - - - Left-justifies the text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is left justified on the right side - of the check box or radio button. - - - - - Right-justifies text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is right justified on the right - side of the check box or radio button. - - - - - Centers text horizontally in the button rectangle. - - - - - Places text at the top of the button rectangle. - - - - - Places text at the bottom of the button rectangle. - - - - - Places text in the middle (vertically) of the button rectangle. - - - - - Makes a button (such as a check box, three-state check box, or radio button) look and - act like a push button. The button looks raised when it isn't pushed or checked, and - sunken when it is pushed or checked. - - - - - Wraps the button text to multiple lines if the text string is too long to fit on a - single line in the button rectangle. - - - - - Enables a button to send BN_KILLFOCUS and BN_SETFOCUS notification messages to its - parent window. - - - - - Specifies that the button is two-dimensional; it does not use the default - shading to create a 3-D image. - - - - - Microsoft Windows Vista and Version 6.00. Creates a split button that behaves like a - BS_PUSHBUTTON style button, but also has a distinctive appearance. If the split button - is in a dialog box, the user can select the split button by pressing the ENTER key, even - when the split button does not have the input focus. This style is useful for enabling - the user to quickly select the most likely (default) option. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like a - BS_PUSHBUTTON style button, but the command link button has a green arrow on the left pointing - to the button text. A caption for the button text can be set by sending the BCM_SETNOTE - message to the button. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like - a BS_PUSHBUTTON style button. If the button is in a dialog box, the user can select the - command link button by pressing the ENTER key, even when the command link button does - not have the input focus. This style is useful for enabling the user to quickly select - the most likely (default) option. - - - - - Edit control styles. - http://msdn.microsoft.com/en-us/library/bb775464(VS.85).aspx - - - - - Aligns text with the left margin. - - - - - Windows 98/Me, Windows 2000/XP: Centers text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Centers text in a multiline edit control. - - - - - Windows 98/Me, Windows 2000/XP: Right-aligns text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Right aligns text in a multiline edit control. - - - - - Designates a multiline edit control. The default is single-line edit control. - - - - - Converts all characters to uppercase as they are typed into the edit control. - - - - - Converts all characters to lowercase as they are typed into the edit control. - - - - - Displays an asterisk (*) for each character typed into the edit control. - This style is valid only for single-line edit controls. - - - - - Automatically scrolls text up one page when the user presses the ENTER key on - the last line. - - - - - Automatically scrolls text to the right by 10 characters when the user types - a character at the end of the line. When the user presses the ENTER key, - the control scrolls all text back to position zero. - - - - - Negates the default behavior for an edit control. - - - - - Converts text entered in the edit control. - - - - - Prevents the user from typing or editing text in the edit control. - - - - - Specifies that a carriage return be inserted when the user presses the - ENTER key while entering text into a multiline edit control in a dialog box. - If you do not specify this style, pressing the ENTER key has the same effect - as pressing the dialog box's default push button. This style has no effect - on a single-line edit control. - - - - - Allows only digits to be entered into the edit control. - - - - - Defines the header for a menu template. - A complete menu template consists of a header and one or more menu item lists. - - - - - Specifies the version number. This member must be zero. - - - - - Specifies the offset, in bytes, from the end of the header. - The menu item list begins at this offset. Usually, this member is zero, and the menu - item list follows immediately after the header. - - - - - Defines a menu item in a menu template. - - - - - Specifies one or more of the following predefined menu options that control the appearance of the menu item. - TODO - - - - - Defines the header for an extended menu template. - - - - - Template version number. This member must be 1 for extended menu templates. - - - - - Offset of the first MENUEXITEMTEMPLATE structure, relative to the end of - this structure member. If the first item definition immediately follows the - dwHelpId member, this member should be 4. - - - - - Drop-down menu or submenu item. - - - - - Menu item type. This member can be a combination of the type (beginning with MFT) values - listed with the MENUITEMINFO structure. - - - - - Menu item state. This member can be a combination of the state (beginning with MFS) values - listed with the MENUITEMINFO structure. - - - - - Menu item identifier. This is an application-defined value that identifies the menu item. - - - - - Value specifying whether the menu item is the last item in the menu bar, drop-down menu, - submenu, or shortcut menu and whether it is an item that opens a drop-down menu or submenu. - - - - - Specifies one or more of the following predefined menu options that control the - appearance of the menu item. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item is initially inactive and drawn with a gray effect. - - - - - - - - - - - - - - - Indicates that the menu item has a check mark next to it. - - - - - - - - - - - - - - - - - - - - Indicates that the owner window of the menu is responsible for drawing all visual - aspects of the menu item, including highlighted, selected, and inactive states. - This option is not valid for an item in a menu bar. - - - - - Indicates that the item is one that opens a drop-down menu or submenu. - - - - - Indicates that the menu item is placed in a new column. The old and new columns - are separated by a bar. - - - - - Indicates that the menu item is placed in a new column. - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item has a vertical separator to its left. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Specifies whether the menu item is the last item in the menu bar, drop-down menu, submenu, or shortcut - menu and whether it is an item that opens a drop-down menu or submenu. This member can be zero or more - of these values. - - - - - Defines the last menu item in the menu bar, drop-down menu, submenu, or shortcut menu. - - - - - Defines a item that opens a drop-down menu or submenu. Subsequent structures define menu - items in the corresponding drop-down menu or submenu. - - - - - Defines an accelerator key used in an accelerator table. - http://msdn.microsoft.com/en-us/library/ms646340(VS.85).aspx - - - - - Accelerator flags. - - - - - Accelerator key. This member can be either a virtual-key code or an ASCII character code. - - - - - Accelerator identifier. - - - - - Flags, fVirt field of the Accelerator table structure. - - - - - Virtual key. - - - - - Specifies that no top-level menu item is highlighted when the accelerator is used. - This is useful when defining accelerators for actions such as scrolling that do not - correspond to a menu item. If NOINVERT is omitted, a top-level menu item will be - highlighted (if possible) when the accelerator is used. - - - - - Causes the accelerator to be activated only if the SHIFT key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the CONTROL key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the ALT key is down. - Applies only to virtual keys. - - - - - Virtual key definitions. - - - - - Standard virtual left mouse button. - - - - - Standard virtual right mouse button. - - - - - Ctrl-Break / Ctrl-C. - - - - - Standard virtual middle mouse button. - - - - - - - - - - - - - - - Backspace. - - - - - Tab. - - - - - Delete. - - - - - Return. - - - - - Shift. - - - - - Control. - - - - - Menu. - - - - - Pause. - - - - - Caps lock. - - - - - - - - - - - - - - - - - - - - - - - - - Escape. - - - - - - - - - - - - - - - - - - - - - - - - - Space. - - - - - - - - - - - - - - - End. - - - - - Home. - - - - - Left arrow. - - - - - Up arrow. - - - - - Right arrow. - - - - - Down arrow. - - - - - - - - - - Print Screen. - - - - - - - - - - - - - - - Insert. - - - - - Delete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NEC PC-9800 keyboard '=' key on numpad. - - - - - Fujitsu/OASYS keyboard 'Dictionary' key. - - - - - Fujitsu/OASYS keyboard 'Unregister word' key. - - - - - Fujitsu/OASYS keyboard 'Register word' key. - - - - - Fujitsu/OASYS keyboard 'Left OYAYUBI' key. - - - - - Fujitsu/OASYS keyboard 'Right OYAYUBI' key. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';:' for US - - - - - '+' any country - - - - - ',' any country - - - - - '-' any country - - - - - '.' any country - - - - - '/?' for US - - - - - '`~' for US - - - - - '[{' for US - - - - - '\|' for US - - - - - ']}' for US - - - - - ''"' for US - - - - - - - - - - 'AX' key on Japanese AX kbd - - - - - "<>" or "\|" on RT 102-key kbd. - - - - - Help key on ICO - - - - - 00 key on ICO - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contains information about an individual font in a font resource group. - - - - - Specifies a user-defined version number for the resource data that tools can - use to read and write resource files. - - - - - Specifies the size of the file, in bytes. - - - - - Contains a 60-character string with the font supplier's copyright information. - - - - - Specifies the type of font file. - - - - - Specifies the point size at which this character set looks best. - - - - - Specifies the vertical resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the horizontal resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the distance from the top of a character definition cell to the baseline of the - typographical font. - - - - - Specifies the amount of leading inside the bounds set by the dfPixHeight member. Accent marks and - other diacritical characters can occur in this area. - - - - - Specifies the amount of extra leading that the application adds between rows. - - - - - Specifies an italic font if not equal to zero. - - - - - Specifies an underlined font if not equal to zero. - - - - - Specifies a strikeout font if not equal to zero. - - - - - Specifies the weight of the font in the range 0 through 1000. For example, 400 is roman and - 700 is bold. If this value is zero, a default weight is used. - - - - - Specifies the character set of the font. - - - - - Specifies the width of the grid on which a vector font was digitized. For raster fonts, - if the member is not equal to zero, it represents the width for all the characters in the - bitmap. If the member is equal to zero, the font has variable-width characters. - - - - - Specifies the height of the character bitmap for raster fonts or the height of the grid - on which a vector font was digitized. - - - - - Specifies the pitch and the family of the font. - - - - - Specifies the average width of characters in the font (generally defined as the width of - the letter x). This value does not include the overhang required for bold or italic characters. - - - - - Specifies the width of the widest character in the font. - - - - - Specifies the first character code defined in the font. - - - - - Specifies the last character code defined in the font. - - - - - Specifies the character to substitute for characters not in the font. - - - - - Specifies the character that will be used to define word breaks for text justification. - - - - - Specifies the number of bytes in each row of the bitmap. This value is always even so - that the rows start on word boundaries. For vector fonts, this member has no meaning. - - - - - Specifies the offset in the file to a null-terminated string that specifies a device name. - For a generic font, this value is zero. - - - - - Specifies the offset in the file to a null-terminated string that names the typeface. - - - - - This member is reserved. - - - - - This structure depicts the organization of data in a file-version resource. - It contains version information not dependent on a particular language and code page combination. - http://msdn.microsoft.com/en-us/library/aa909193.aspx - - - - - A hardware independent dictionary of language and code page identifier tables. - - - - - A new hardware independent dictionary of language and code page identifier tables. - - - - - An existing hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - - - - Read a hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - Pointer to the end of data. - - - - Write the hardware independent dictionary of language and code page identifier tables to a binary stream. - - Binary stream. - - - - The default language and code page identifier table. - - - - - Returns a language and code page identifier table. - - Language ID. - A language and code page identifier table. - - - - String representation of VarFileInfo. - - Indent. - String in the VarFileInfo format. - - - - This structure depicts the organization of data in a file-version resource. It typically contains a - list of language and code page identifier pairs that the version of the application or DLL supports. - http://msdn.microsoft.com/en-us/library/bb202818.aspx - - - - - A dictionary of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - Table key. - - - - An existing table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - Read a table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - - Write the table of language and code page identifier pairs to a binary stream. - - Binary stream. - Last unpadded position. - - - - Returns a code page identifier for a given language. - - Language ID. - Code page identifier. - - - - String representation of the var table. - - Indent. - String representation of the var table. - - - - VS_VERSIONINFO - This structure depicts the organization of data in a file-version resource. It is the root structure - that contains all other file-version information structures. - http://msdn.microsoft.com/en-us/library/aa914916.aspx - - - - - The resource header. - - - - - A dictionary of resource tables. - - - - - An existing version resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new language-netural version resource. - - - - - Read a version resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - String representation of the file version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - String representation of the protect version. - - - - - Write this version resource to a binary stream. - - Binary stream. - - - - Returns an entry within this resource table. - - Entry key. - A resource table. - - - - Returns an entry within this resource table. - - Entry index. - A resource table. - - - - Return string representation of the version resource. - - - - - - winver.h, version management functions, types and definitions - - - - - VS_VERSION signature. - - - - - VS_VERSION structure version. - - - - - VS_VERSION file flags mask. - - - - - VS_VERSION file flags. - - - - - The file contains debugging information. - - - - - The file is a prerelease development version, not a final commercial release. - - - - - PThe file has been modified somehow and is not identical to the original file - that shipped with the product. - - - - - The file was not built using standard release procedures. There should be data - in the file's "PrivateBuild" version information string. - - - - - The version information in this structure was not found inside the file, - but instead was created when needed based on the best information available. - Therefore, this structure's information may differ slightly from what the "real" - values are. - - - - - The file was built using standard release procedures, but is somehow different - from the normal file having the same version number. There should be data in the - file's "SpecialBuild" version information string. - - - - - VS_VERSION file OSs. - - - - - The operating system under which the file was designed to run could not be determined. - - - - - The file was designed to run under MS-DOS. - - - - - The file was designed to run under a 16-bit version of OS/2. - - - - - The file was designed to run under a 32-bit version of OS/2. - - - - - The file was designed to run under Windows NT/2000. - - - - - - - - - - The file was designed to run under the 16-bit Windows API. - - - - - The file was designed to be run under a 16-bit version of Presentation Manager. - - - - - The file was designed to be run under a 32-bit version of Presentation Manager. - - - - - The file was designed to run under the 32-bit Windows API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VS_VERSION file types. - - - - - The type of file could not be determined. - - - - - The file is an application. - - - - - The file is a Dynamic Link Library (DLL). - - - - - The file is a device driver. dwFileSubtype contains more information. - - - - - The file is a font. dwFileSubtype contains more information. - - - - - The file is a virtual device. - - - - - The file is a static link library. - - - - - File sub-type. - - - - - The type of driver could not be determined. - - - - - The file is a printer driver. - - - - - The file is a keyboard driver. - - - - - The file is a language driver. - - - - - The file is a display driver. - - - - - The file is a mouse driver. - - - - - The file is a network driver. - - - - - The file is a system driver. - - - - - The file is an installable driver. - - - - - The file is a sound driver. - - - - - The file is a communications driver. - - - - - The file is an input method driver. - - - - - The file is a versioned printer driver. - - - - - The file is a raster font. - - - - - The file is a vector font. - - - - - The file is a TrueType font. - - - - diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.dll b/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.dll deleted file mode 100644 index 2b7841b..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.dll and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.xml b/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.xml deleted file mode 100644 index ca74d41..0000000 --- a/packages/Vestris.ResourceLib.2.1.0/lib/net45/Vestris.ResourceLib.xml +++ /dev/null @@ -1,6603 +0,0 @@ - - - - Vestris.ResourceLib - - - - - Standard accelerator. - - - - - Read the accelerator. - - Address in memory. - - - - Write accelerator to a binary stream. - - Binary stream. - - - - String representation of the accelerator key. - - - - - An unsigned integer value that identifies the accelerator. - - - - - String representation of the accelerator. - - String representation of the accelerator. - - - - An accelerator, RT_ACCELERATOR resource. - An accelerator provides the user with access to an application's command set. - - - - - Accelerator keys. - - - - - A new accelerator resource. - - - - - An existing accelerator resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the accelerators table. - - Handle to a module. - Pointer to the beginning of the accelerator table. - Address of the end of the accelerator table. - - - - String representation of the accelerators resource. - - - - - - Creates an 8 bit aligned copy of the buffer if it is not already aligned - - - - - A bitmap file in a .bmp format. - - - - - Device independent bitmap. - - - - - An existing bitmap file. - - A file in a .bmp format. - - - - An embedded bitmap resource. - - - - - An existing bitmap resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new bitmap resource. - - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the bitmap resource to a binary stream. - - Binary stream. - - - - A device independent bitmap. - - - - - This structure depicts the organization of data in a hardware-independent cursor resource. - - - - - A hardware-independent cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent cursor resource. - - - - - A new collection of cursors that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a cursor resource. - - - - - An existing cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new cursor resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Language. - An icon resource. - - - - Horizontal hotspot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Vertical hot spot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Write the cursor data to a file. - - Target executable file. - - - - Read DIB image. - - DIB bits. - DIB size. - - - - A device-independent image consists of a BITMAPINFOHEADER where - bmWidth is the width of the image andbmHeight is double the height - of the image, followed by the bitmap color table, followed by the image - pixels, followed by the mask pixels. - - - - - Raw image data. - - - - - Bitmap info header. - - - - - Bitmap size in bytes. - - - - - A new icon image. - - - - - A device-independent bitmap. - - Bitmap data. - - - - Create a copy of an image. - - Source image. - - - - Read icon data. - - Pointer to the beginning of icon data. - Icon data size. - - - - Size of the image mask. - - - - - Position of the DIB bitmap bits within a DIB bitmap array. - - - - - Number of colors in the palette. - - - - - Returns the width of a row in a DIB Bitmap given the number of bits. DIB Bitmap rows always align on a DWORD boundary. - - Number of bits. - Width of a row in bytes. - - - - Bitmap monochrome mask. - - - - - Bitmap color (XOR) part of the image. - - - - - Complete image. - - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - Indicates the character set to use. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Weight of the font. - - - - - Indicates whether the font is italic. - - - - - Number of dialog items. - - - - - An extended dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write dialog control to a binary stream. - - Binary stream. - - - - String representation of the dialog. - - String in the DIALOGEX [dialog] format. - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - An extended dialog control template structure. - - - - - Read the dialog control. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Return a string representation of the dialog control. - - A single line in the "CLASS name id, dimensions and styles' format. - - - - A dialog template resource. - - - - - A dialog template structure that describes the dialog. - - - - - A structured dialog resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A structured dialog resource embedded in an executable module. - - - - - Dialog resource in standard resource editor text format. - - Multi-line string. - - - - A container for the DIALOGTEMPLATE structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Number of dialog items. - - - - - A standard dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog template data to a binary stream. - - Binary stream. - - - - Returns a string representation of the dialog. - - String in the DIALOG ... format. - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Number of items in this structure. - - - - - The name of the typeface for the font. - - - - - Point size of the font to use for the text in the dialog box and its controls. - - - - - Dialog caption. - - - - - Menu resource Id. - - - - - Window class Id. - - - - - Controls within this dialog. - - - - - Dialog template representation in a standard text format. - - Multiline string. - - - - String represetnation of a control. - - - - - - Write the resource to a binary stream. - - Binary stream. - - - - A container for a control within a dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - A standard dialog control structure. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - String represetnation of a control. - - - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Dialog caption. - - - - - Window class Id. - - - - - Window class of the control. - - - - - Additional creation data. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Dialog template utility functions. - - - - - Read a dialog resource id. - - Address in memory. - Resource read. - - - - - String representation of the dialog or control style of two types. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control styles of two types. - - Dialog or control style. - Dialog or control extended style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control style of one type. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - Returns the type of the resource in this group. - - - - - Icons contained in this hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - Save a hardware-independent icon resource to an executable file. - - Name of an executable file (.exe or .dll). - - - - Read a hardware-independent icon resource from a loaded module. - - Loaded executable module. - Pointer to the beginning of a hardware-independent icon resource. - Pointer to the end of the hardware-independent icon resource. - - - - Write a hardware-independent icon resource to a binary stream. - - Binary stream. - - - - Fixed file information. - - - - - Default Windows fixed file information. - - - - - Fixed file info structure. - - - - - Read the fixed file information structure. - - Address in memory. - - - - String representation of the file version. - - - - - String representation of the protect version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - Write fixed file information to a binary stream. - - Binary stream. - - - - Size of the VS_FIXEDFILEINFO structure. - - - - - String representation of the fixed file info. - - String representation of the fixed file info. - - - - A font directory entry. - - - - - Font ordinal. - - - - - Typeface name of the font. - - - - - Specifies the name of the device if this font file is designated for a specific device. - - - - - Font information. - - - - - A new font directory entry. - - - - - Read the font directory entry. - - Pointer in memory. - Pointer to the end of the font directory entry. - - - - Write the font directory entry to a binary stream. - - Binary stream. - - - - A font directory, RT_FONTDIR resource. - - - - - Number of fonts in this directory. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font directory to a binary stream. - - Binary stream. - - - - A font, RT_FONT resource. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font resource to a binary writer. - - Binary writer. - - - - Gdi32.dll interop functions. - - - - - Bitmap compression options. - - - - - An uncompressed format. - - - - - A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression. - - - - - An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression. - - - - - Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image. - - - - - A bitmap info header. - See http://msdn.microsoft.com/en-us/library/ms532290.aspx for more information. - - - - - Bitmap information size. - - - - - Bitmap width. - - - - - Bitmap height. - - - - - Number of logical planes. - - - - - Bitmap bitrate. - - - - - Bitmap compression. - - - - - Image size. - - - - - Horizontal pixel resolution. - - - - - Vertical pixel resolution. - - - - - - - - - - - - - - - Returns the current bitmap compression. - - - - - Bitmap pixel format. - - - - - Bitmap pixel format English standard string. - - - - - Defines the dimensions and color information of a Windows-based device-independent bitmap (DIB). - http://msdn.microsoft.com/en-us/library/dd183375(VS.85).aspx. - - - - - Specifies a bitmap information header structure that contains information about the dimensions of color format. - - - - - An array of RGBQUAD. The elements of the array make up the color table. - - - - - Store colors in a paletised icon (2, 4 or 8 bit). - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Blue. - - - - - Green. - - - - - Red. - - - - - Reserved. - - - - - The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - http://msdn.microsoft.com/en-us/library/dd183374(VS.85).aspx - - - - - The file type; must be BM. - - - - - The size, in bytes, of the bitmap file. - - - - - Reserved; must be zero. - - - - - Reserved; must be zero. - - - - - The offset, in bytes, from the beginning of the BITMAPFILEHEADER structure to the bitmap bits. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Retrieves the bits of the specified compatible bitmap and copies them into a buffer as - a DIB using the specified format - - A handle to the device context. - A handle to the bitmap. This must be a compatible bitmap (DDB). - The first scan line to retrieve. - The number of scan lines to retrieve. - A pointer to a buffer to receive the bitmap data. - A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data. - The format of the bmiColors member of the BITMAPINFO structure. - - If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap. - If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is non-zero. - If the function fails, the return value is zero. - - - - - Create a DIB that applications can write to directly. The function gives you a pointer to the location - of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use - to create the bitmap, or you can let the system allocate the memory for the bitmap. - - Handle to a device context. - A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors. - The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal RGB values). - A pointer to a variable that receives a pointer to the location of the DIB bit values. - A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL. - The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. - - If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values. - If the function fails, the return value is NULL, and *ppvBits is NULL. - - - - - Defines how to interpret the values in the color table of a DIB. - - - - - The color table contains literal RGB values. - - - - - The color table consists of an array of 16-bit indexes into the LogPalette - object that is currently defined in the playback device context. - - - - - No color table exists. The pixels in the DIB are indices into the current logical - palette in the playback device context. - - - - - - - - - - Creates a memory device context (DC) compatible with the specified device. - - Handle to an existing device context. - - The handle to a memory device context indicates success. - NULL indicates failure. - - - - - - - Specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. - Specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). - This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows. - A pointer to a DEVMODE structure containing device-specific initialization data for the device driver. - - - - - Creates a bitmap compatible with the device that is associated with the specified device context. - - A handle to a device context. - The bitmap width, in pixels. - The bitmap height, in pixels. - - If the function succeeds, the return value is a handle to the compatible bitmap (DDB). - If the function fails, the return value is NULL. - - - - - Selects an object into a specified device context. The new object replaces the previous object of the same type. - - Handle to the device context. - Handle to the object to be selected. - - If the selected object is not a region, the handle of the object being replaced indicates success. - If the selected object is a region, one of the following values indicates success. - - - - - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. - - Handle to a logical pen, brush, font, bitmap, region, or palette. - - Nonzero indicates success. - Zero indicates that the specified handle is not valid or that the handle is currently selected into a device context. - - - - - Deletes the specified device context. - - A handle to the device context. - - If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. - - - - - A generic resource. - - - - - Raw resource data. - - - - - Raw resource data. - - - - - An unstructured generic resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A generic resource. - - Resource name. - Resource type. - Resource language. - - - - Read a generic resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - A new collection of icons that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a .ico file. - - - - - Resource type. - - - - - Icon. - - - - - Cursor. - - - - - Type of the group icon resource. - - - - - Collection of icons in an .ico file. - - - - - An existing .ico file. - - An existing icon (.ico) file. - - - - Load from a .ico file. - - An existing icon (.ico) file. - - - - Read icons. - - Pointer to the beginning of a FILEGRPICONDIR structure. - Pointer to the end of a FILEGRPICONDIR structure. - - - - This structure depicts the organization of icon data in a .ico file. - - - - - Icon header. - - - - - Icon bitmap. - - - - - New icon data. - - - - - Icon width. - - - - - Icon height. - - - - - Image size in bytes. - - - - - Read a single icon (.ico). - - Pointer to the beginning of this icon's data. - Pointer to the beginning of all icon data. - Pointer to the end of this icon's data. - - - - Icon size as a string. - - Icon size in the width x height format. - - - - This structure depicts the organization of data in an icon resource. - - - - - Directory header. - - - - - Actual image. - - - - - Hardware-independent icon directory header. - - - - - Embedded icon Id. - - - - - An icon image. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Create a new icon image resource from a file icon. - - File icon. - Resource type. - Resource id. - Resource language. - - - - Icon width in pixels. - - - - - Icon height in pixels. - - - - - Image size in bytes. - - - - - Read an icon resource from a previously loaded module. - - Module handle. - Pointer to a directory entry in the hardware-independent icon resource. - Pointer to the end of the icon resource. - - - - Read the bitmap image. - - DIB bits. - Size of image. - - - - Icon pixel format. - - - - - Icon pixel format English standard string. - - - - - String representation of the icon. - - A string in a format of width x height followed by the pixel format. - - - - Write icon resource data to a binary stream. - - Binary stream. - - - - Save icon to a file. - - Target executable file. - - - - This structure depicts the organization of data in an icon resource. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Resource language. - An icon resource. - - - - Kernel32.dll interop functions. - - - - - A resource header. - - - - - Header length. - - - - - Data length. - - - - - Resource type. - - - - - A new resource header of a given length. - - - - - - Resource header type. - - - - - Binary data. - - - - - String data. - - - - - Language and code page combinations. - The low-order word of each DWORD must contain a Microsoft language identifier, - and the high-order word must contain the IBM code page number. - Either high-order or low-order word can be zero, indicating that the file is language - or code page independent. - - - - - Microsoft language identifier. - - - - - IBM code page number. - - - - - This structure contains version information about a file. - This information is language- and code page–independent. - http://msdn.microsoft.com/en-us/library/ms647001.aspx - - - - - Contains the value 0xFEEF04BD. This is used with the szKey member of the VS_VERSIONINFO structure when searching a file for the VS_FIXEDFILEINFO structure. - - - - - Specifies the binary version number of this structure. The high-order word of this member contains the major version number, and the low-order word contains the minor version number. - - - - - Specifies the most significant 32 bits of the file's binary version number. This member is used with dwFileVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the file's binary version number. This member is used with dwFileVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the most significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Contains a bitmask that specifies the valid bits in dwFileFlags. A bit is valid only if it was defined when the file was created. - - - - - Contains a bitmask that specifies the Boolean attributes of the file. - - - - - Specifies the operating system for which this file was designed. - - - - - Specifies the general type of file. - - - - - Specifies the function of the file. - - - - - Specifies the most significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Specifies the least significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Creates a default Windows VS_FIXEDFILEINFO structure. - - A default Windows VS_FIXEDFILEINFO. - - - - A hardware-independent icon directory resource header. - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Reserved, must be zero. - - - - - Resource type, 1 for icons. - - - - - Number of images. - - - - - Hardware-independent icon directory entry. - See http://msdn.microsoft.com/en-us/library/ms997538.aspx for more information. - - - - - Width of the image. Starting with Windows 95 a value of 0 represents width of 256. - - - - - Height of the image. Starting with Windows 95 a value of 0 represents height of 256. - - - - - Number of colors in the image. - bColors = 1 << (wBitsPerPixel * wPlanes) - If wBitsPerPixel* wPlanes is greater orequal to 8, then bColors = 0. - - - - - Reserved. - - - - - Number of bitmap planes. - 1: monochrome bitmap - - - - - Bits per pixel. - 1: monochrome bitmap - - - - - Image size in bytes. - - - - - Icon ID. - - - - - Hardware-independent icon directory entry in an .ico file. - - - - - Icon width. - - - - - Icon height. - - - - - Colors; 0 means 256 or more. - - - - - Reserved. - - - - - Number of bitmap planes for icons. - Horizontal hotspot for cursors. - - - - - Bits per pixel for icons. - Vertical hostpot for cursors. - - - - - Image size in bytes. - - - - - Offset of bitmap data from the beginning of the file. - - - - - Hardware-independent icon structure in an .ico file. - - - - - Reserved, must be zero. - - - - - Resource Type (1 for icons). - - - - - Number of images. - - - - - If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. - - - - - If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. - - - - - If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy. - - - - - If this value is used, the system does not perform automatic trust comparisons on the DLL or its dependents when they are loaded. - - - - - Loads the specified module into the address space of the calling process. - The specified module may cause other modules to be loaded. - - The name of the module. - This parameter is reserved for future use. - The action to be taken when loading the module. - - - - - Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. - - A handle to the loaded library module. - If the function succeeds, the return value is nonzero. - - - - Predefined resource types. - - - - - Hardware-dependent cursor resource. - - - - - Bitmap resource. - - - - - Hardware-dependent icon resource. - - - - - Menu resource. - - - - - Dialog box. - - - - - String-table entry. - - - - - Font directory resource. - - - - - Font resource. - - - - - Accelerator table. - - - - - Application-defined resource (raw data). - - - - - Message-table entry. - - - - - Hardware-independent cursor resource. - - - - - Hardware-independent icon resource. - - - - - Version resource. - - - - - Allows a resource editing tool to associate a string with an .rc file. - - - - - Plug and Play resource. - - - - - VXD. - - - - - Animated cursor. - - - - - Animated icon. - - - - - HTML. - - - - - Microsoft Windows XP: Side-by-Side Assembly XML Manifest. - - - - - Enumerates resource types within a binary module. - - Handle to a module to search. - Pointer to the callback function to be called for each enumerated resource type. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful; otherwise, FALSE. - - - - An application-defined callback function used with the EnumResourceTypes and EnumResourceTypesEx functions. - - The handle to the module whose executable file contains the resources for which the types are to be enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the type is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceTypes or EnumResourceTypesEx function. - Returns TRUE if successful; otherwise, FALSE. - - - - Enumerates resources of a specified type within a binary module. - - Handle to a module to search. - Pointer to a null-terminated string specifying the type of the resource for which the name is being enumerated. - Pointer to the callback function to be called for each enumerated resource name or ID. - Specifies an application-defined value passed to the callback function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - An application-defined callback function used with the EnumResourceNames and EnumResourceNamesEx functions. - - The handle to the module whose executable file contains the resources that are being enumerated. - Pointer to a null-terminated string specifying the type of resource that is being enumerated. - Specifies the name of a resource of the type being enumerated. - Specifies the application-defined parameter passed to the EnumResourceNames or EnumResourceNamesEx function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - Enumerates language-specific resources, of the specified type and name, associated with a binary module. - - The handle to a module to search. - Pointer to a null-terminated string specifying the type of resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Pointer to the callback function to be called for each enumerated resource language. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful or FALSE otherwise. - - - - An application-defined callback function used with the EnumResourceLanguages and EnumResourceLanguagesEx functions. - - The handle to the module whose executable file contains the resources for which the languages are being enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Specifies the language identifier for the resource for which the language is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceLanguages or EnumResourceLanguagesEx function. - Returns TRUE if successful or FALSE otherwise. - - - - Determines the location of the resource with the specified type, name, and language in the specified module. - - Handle to the module whose executable file contains the resource. - Pointer to a null-terminated string specifying the type name of the resource. - Pointer to a null-terminated string specifying the name of the resource. - Specifies the language of the resource. - If the function succeeds, the return value is a handle to the specified resource's information block. - - - - Locks the specified resource in memory. - - Handle to the resource to be locked. - If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL. - - - - Loads the specified resource into global memory. - - Handle to the module whose executable file contains the resource. - Handle to the resource to be loaded. - If the function succeeds, the return value is a handle to the data associated with the resource. - - - - Returns the size, in bytes, of the specified resource. - - Handle to the module whose executable file contains the resource. - Handle to the resource. This handle must be created by using the FindResource or FindResourceEx function. - If the function succeeds, the return value is the number of bytes in the resource. - - - - Closes an open object handle. - - A valid handle to an open object. - If the function succeeds, the return value is nonzero. - - - - Returns a handle to either a language-neutral portable executable file (LN file) or a - language-specific resource file (.mui file) that can be used by the UpdateResource function - to add, delete, or replace resources in a binary module. - - Pointer to a null-terminated string that specifies the binary file in which to update resources. - Specifies whether to delete the pFileName parameter's existing resources. - If the function succeeds, the return value is a handle that can be used by the UpdateResource and EndUpdateResource functions. - - - - Adds, deletes, or replaces a resource in a portable executable (PE) file. - There are some restrictions on resource updates in files that contain Resource Configuration (RC Config) data: - language-neutral (LN) files and language-specific resource (.mui) files. - - A module handle returned by the BeginUpdateResource function, referencing the file to be updated. - Pointer to a null-terminated string specifying the resource type to be updated. - Pointer to a null-terminated string specifying the name of the resource to be updated. - Specifies the language identifier of the resource to be updated. - Pointer to the resource data to be inserted into the file indicated by hUpdate. - Specifies the size, in bytes, of the resource data at lpData. - Returns TRUE if successful or FALSE otherwise. - - - - Commits or discards changes made prior to a call to UpdateResource. - - A module handle returned by the BeginUpdateResource function, and used by UpdateResource, referencing the file to be updated. - Specifies whether to write the resource updates to the file. If this parameter is TRUE, no changes are made. If it is FALSE, the changes are made: the resource updates will take effect. - Returns TRUE if the function succeeds; FALSE otherwise. - - - - Neutral primary language ID. - - - - - US-English primary language ID. - - - - - Neutral sublanguage ID. - - - - - US-English sublanguage ID. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID is used primarily for EXEs. If an executable has a resource of type RT_MANIFEST, - ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will create a process default activation context for the process. - The process default activation context will be used by all components running in the process. - CREATEPROCESS_MANIFEST_RESOURCE_ID can also used by DLLs. When Windows probe for dependencies, if the dll has - a resource of type RT_MANIFEST, ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will use that manifest as the - dependency. - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID is used primarily for DLLs. It should be used if the dll wants private - dependencies other than the process default. For example, if an dll depends on comctl32.dll version 6.0.0.0. - It should have a resource of type RT_MANIFEST, ID ISOLATIONAWARE_MANIFEST_RESOURCE_ID to depend on comctl32.dll - version 6.0.0.0, so that even if the process executable wants comctl32.dll version 5.1, the dll itself will still - use the right version of comctl32.dll. - - - - - When ISOLATION_AWARE_ENABLED is defined, Windows re-defines certain APIs. For example LoadLibraryExW - is redefined to IsolationAwareLoadLibraryExW. - - - - - Resource manifest type. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_NOSTATICIMPORT_MANIFEST_RESOURCE_ID - - - - - Copies the contents of a source memory block to a destination memory block, and supports overlapping source and destination memory blocks. - - A pointer to the starting address of the copied block's destination. - A pointer to the starting address of the block of memory to copy. - The size of the block of memory to copy, in bytes. - - - - A resource load exception. - - - - - The Win32 exception from a resource enumeration function. - - - - - A new resource load exception. - - Error message. - The inner exception thrown within a single resource. - The outer exception from the Win32 API. - - - - A combined message of the inner and outer exception. - - - - - An embedded SxS manifest. - - - - - Embedded XML manifest. - - - - - Manifest type. - - - - - An existing embedded manifest resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new executable CreateProcess manifest. - - - - - A new executable manifest. - - Manifest type. - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - Load a manifest resource from an executable file. - - Name of an executable file (.exe or .dll). - Manifest resource type. - - - - Extended menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write the menu template. - - Binary stream. - - - - String representation of the menu in the MENUEX format. - - String representation of the menu. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of extended menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - A command menu item. - - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - An extended popup menu item. - - - - - Sub menu items. - - - - - An extended popup menu item. - - - - - Read an extended popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENUEX format. - - String representation. - - - - A generic resource. - - - - - Menu template. - - - - - A structured menu resource. - - - - - A structured menu resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - Read a menu resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the menu resource to a binary stream. - - Binary stream. - - - - String representation of the menu resource in the MENU format. - - String representation of the menu resource. - - - - Standard menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write menu template to a binary stream. - - Binary stream. - - - - String representation of the menu in the MENU format. - - String representation of the menu. - - - - A menu template header. - - - - - Read the menu template header. - - Address in memory. - - - - Write the menu to a binary stream. - - Binary stream. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - Command menu id. - - - - - A command menu item. - - - - - Read a command menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A popup menu item. - - - - - Sub menu items. - - - - - A popup menu item. - - - - - Read a popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - A version resource. - - - - - Resource type. - - - - - Resource name. - - - - - Resource language. - - - - - Loaded binary nodule. - - - - - Pointer to the resource. - - - - - Resource size. - - - - - Version resource size in bytes. - - - - - Language ID. - - - - - Resource type. - - - - - String representation of the resource type. - - - - - Resource name. - - - - - A new resource. - - - - - A structured resource embedded in an executable module. - - Module handle. - Resource handle. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Lock and read the resource. - - Module handle. - Resource handle. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - Resource name. - Resource type. - Resource language. - - - - Load a resource from an executable (.exe or .dll) module. - - An executable (.exe or .dll) module. - Resource type. - Resource name. - Resource language. - - - - Read a resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - Write the resource to a memory stream. - - Binary stream. - - - - Return resource data. - - Resource data. - - - - Save a resource. - - Name of an executable file (.exe or .dll). - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Language id. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - Resource data. - - - - Save a batch of resources to a given file. - - Path to an executable file. - The resources to write. - - - - A resource Id. - There're two types of resource Ids, reserved integer numbers (eg. RT_ICON) and custom string names (eg. "CUSTOM"). - - - - - A resource identifier. - - A integer or string resource id. - - - - A resource identifier. - - A integer resource id. - - - - A well-known resource-type identifier. - - A well known resource type. - - - - A custom resource identifier. - - - - - - Resource Id. - - - If the resource Id is a string, it will be copied. - - - - - String representation of a resource type name. - - - - - An enumerated resource type for built-in resource types only. - - - - - Returns true if the resource is an integer resource. - - - - - Returns true if the resource is an integer resource. - - Resource pointer. - - - - Resource Id in a string format. - - - - - String representation of the resource Id. - - Resource name. - - - - Resource Id hash code. - Resource Ids of the same type have the same hash code. - - Resource Id. - - - - Compares two resource Ids by value. - - Resource Id. - True if both resource Ids represent the same resource. - - - - Resource info manager. - - - - - A dictionary of resources, the key is the resource type, eg. "REGISTRY" or "16" (version). - - - - - A shortcut for available resource types. - - - - - A new resource info. - - - - - Unload the previously loaded module. - - - - - Load an executable or a DLL and read its resources. - - Source filename. - - - - Enumerate resource types. - - Module handle. - Resource type. - Additional parameter. - TRUE if successful. - - - - Enumerate resource names within a resource by type - - Module handle. - Resource type. - Resource name. - Additional parameter. - TRUE if successful. - - - - Create a resource of a given type. - - Module handle. - Pointer to the resource in memory. - Resource type. - Resource name. - Language ID. - Size of resource. - A specialized or a generic resource. - - - - Enumerate resource languages within a resource by name - - Module handle. - Resource type. - Resource name. - Language ID. - Additional parameter. - TRUE if successful. - - - - Save resource to a file. - - Target filename. - - - - Dispose resource info object. - - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - A resource table header. - - - - - Resource table header. - - - - - Resource table key. - - - - - Resource table key. - - - - - Resource header. - - - - - A new resource table header. - - - - - An resource table header with a specific key. - - resource key - - - - An existing resource table. - - Pointer to resource table data. - - - - Read the resource header, return a pointer to the end of it. - - Top of header. - End of header, after the key, aligned at a 32 bit boundary. - - - - Write the resource table. - - Binary stream. - - - - String representation. - - String representation. - - - - String representation. - - Indent. - String representation. - - - - Resource utilities. - - - - - Align an address to a 4-byte boundary. - - Address in memory. - 4-byte aligned pointer. - - - - Align a pointer to a 4-byte boundary. - - Pointer to an address in memory. - 4-byte aligned pointer. - - - - Pad data to a WORD. - - Binary stream. - New position within the binary stream. - - - - Pad data to a DWORD. - - Binary stream. - New position within the binary stream. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Write a value at a given position. - Used to write a size of data in an earlier located header. - - Binary stream. - Value to write. - Address to write the value at. - - - - Pad bytes. - - Binary stream. - Number of bytes to write. - New position within the stream. - - - - Neutral language ID. - - - - - US-English language ID. - - - - - Make a language ID from a primary language ID (low-order 10 bits) and a sublanguage (high-order 6 bits). - - Primary language ID. - Sublanguage ID. - Microsoft language ID. - - - - Return the primary language ID from a Microsoft language ID. - - Microsoft language ID - primary language ID (low-order 10 bits) - - - - Return the sublanguage ID from a Microsoft language ID. - - Microsoft language ID. - Sublanguage ID (high-order 6 bits). - - - - Returns the memory representation of an object. - - Object type. - Data. - Object's representation in memory. - - - - Get a collection of flags from a flag value. - - Flag collection type. - Flag value. - Collection of flags. - - - - Get a string representation of flags. - - Flag collection type. - Flag vlaue - String representation of flags in the f1 | ... | fn format. - - - - This structure depicts the organization of data in a file-version resource. - It contains version information that can be displayed for a particular language and code page. - http://msdn.microsoft.com/en-us/library/aa908808.aspx - - - - - Resource strings. - - - - - A new string file-version resource. - - - - - An existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - - - - Read an existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - Pointer to the end of the string file-version resource. - - - - Write the string file-version resource to a binary stream. - - Binary stream. - - - - Default (first) string table. - - - - - Indexed string table. - - Key. - A string table at a given index. - - - - String representation of StringFileInfo. - - Indent. - String in the StringFileInfo format. - - - - A string, RT_STRING resource. - Each string resource block has 16 strings, each represented as an ordered pair - (length, text). Length is a WORD that specifies the size, in terms of the number of characters, - in the text that follows. Text follows length and contains the string in Unicode without the - NULL terminating character. There may be no characters in text, in which case length is zero. - - - - - String collection in this resource. - - - - - Returns a string of a given Id. - - String Id. - A string of a given Id. - - - - A new string resource. - - - - - A new string resource of a given block id. - - Block id. - - - - A new string resource of a given block id. - - Block id. - - - - An existing string resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A string with ID, stringId, is located in the block with ID given by the following formula. - http://support.microsoft.com/kb/q196774/ - - - - - String table block id. - - - - - Read the strings. - - Handle to a module. - Pointer to the beginning of the string table. - Address of the end of the string table. - - - - String representation of the strings resource. - - - - - - This structure depicts the organization of data in a file-version resource. It contains language - and code page formatting information for the strings. A code page is an ordered character set. - See http://msdn.microsoft.com/en-us/library/aa909192.aspx for more information. - - - - - Resource strings. - - - - - A new string table. - - - - - A new string table. - - String table key. - - - - An existing string table. - - Pointer to the beginning of the table. - - - - Read a string table. - - Pointer to the beginning of the string table. - Pointer to the end of the string table. - - - - Write the string table to a binary stream. - - Binary stream. - Last unpadded position. - - - - The four most significant digits of the key represent the language identifier. - Each Microsoft Standard Language identifier contains two parts: the low-order 10 bits - specify the major language, and the high-order 6 bits specify the sublanguage. - - - - - The four least significant digits of the key represent the code page for which the data is formatted. - - - - - Returns an entry within the string table. - - Key. - An entry within the string table. - - - - String representation of the string table. - - Indent. - String representation of the strings table. - - - - This structure depicts the organization of data in a file-version resource. It contains a string - that describes a specific aspect of a file, such as a file's version, its copyright notices, - or its trademarks. - http://msdn.microsoft.com/en-us/library/aa909025.aspx - - - - - The value is always stored double-null-terminated. - - - - - When set to true the length in the header will also contain the padding bytes when writing to a stream. - The MSDN reference (http://www.webcitation.org/6zBLYbvww) does not clarify which variant is 'right'. - - - - - String resource header. - - - - - Key. - - - - - String value (removing the double-null-terminator). - - - - - Value. - - - - - A new string resource. - - Key. - - - - An existing string resource. - - Pointer to the beginning of a string resource. - - - - Read a string resource. - - Pointer to the beginning of a string resource. - - - - Write a string resource to a binary stream. - - Binary stream. - - - - User32.dll functions. - - - - - Contains information about an icon or a cursor. - - - - - Specifies whether this structure defines an icon or a cursor. - A value of TRUE specifies an icon; FALSE specifies a cursor. - - - - - Specifies the x-coordinate of a cursor's hot spot. If this structure defines an icon, the hot spot is - always in the center of the icon, and this member is ignored. - - - - - Specifies the y-coordinate of the cursor's hot spot. If this structure defines an icon, the hot spot - is always in the center of the icon, and this member is ignored. - - - - - Specifies the icon bitmask bitmap. - - - - - Handle to the icon color bitmap. - - - - - Retrieve a handle to a device context (DC) for the client area of a specified window or for the entire screen. - - A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. - - If the function succeeds, the return value is a handle to the DC for the specified window's client area. - If the function fails, the return value is NULL. - - - - - Releases a device context (DC), freeing it for use by other applications. - - A handle to the window whose DC is to be released. - A handle to the DC to be released. - - The return value indicates whether the DC was released. If the DC was released, the return value is 1. - If the DC was not released, the return value is zero. - - - - - The DIALOGTEMPLATE structure defines the dimensions and style of a dialog box. - This structure, always the first in a standard template for a dialog box, - also specifies the number of controls in the dialog box and therefore specifies - the number of subsequent DIALOGITEMTEMPLATE structures in the template. - - - - - Specifies the style of the dialog box. - - - - - Extended styles for a window. - - - - - Specifies the number of items in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - The DIALOGITEMTEMPLATE structure defines the dimensions and style of a control in a dialog box. - - - - - Specifies the style of the control. - - - - - Extended styles for a window. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the width, in dialog box units, of the control. - - - - - Specifies the height, in dialog box units, of the control. - - - - - Specifies the control identifier. - - - - - An extended dialog box template begins with a DIALOGEXTEMPLATE header that describes - the dialog box and specifies the number of controls in the dialog box. For each - control in a dialog box, an extended dialog box template has a block of data that - uses the DIALOGEXITEMTEMPLATE format to describe the control. - - - - - Specifies the version number of the extended dialog box template. This member must be 1. - - - - - Indicates whether a template is an extended dialog box template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the number of controls in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - A control entry in an extended dialog template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - Specifies the control identifier. - - - - - Window styles. - http://msdn.microsoft.com/en-us/library/ms632600(VS.85).aspx - - - - - Creates an overlapped window. An overlapped window has a title bar and - a border. Same as the WS_TILED style. - - - - - Creates a pop-up window. This style cannot be used with the WS_CHILD style. - - - - - Creates a child window. A window with this style cannot have - a menu bar. This style cannot be used with the WS_POPUP style. - - - - - Creates a window that is initially minimized. Same as the WS_ICONIC style. - - - - - Creates a window that is initially visible. - - - - - Creates a window that is initially disabled. A disabled window cannot receive - input from the user. - - - - - Clips child windows relative to each other; that is, when a particular - child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips - all other overlapping child windows out of the region of the child window - to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, - it is possible, when drawing within the client area of a child window, to draw - within the client area of a neighboring child window. - - - - - Excludes the area occupied by child windows when drawing occurs - within the parent window. This style is used when creating the parent window. - - - - - Creates a window that is initially maximized. - - - - - Creates a window that has a title bar (includes the WS_BORDER style). - - - - - Creates a window that has a thin-line border. - - - - - Creates a window that has a border of a style typically used with dialog - boxes. A window with this style cannot have a title bar. - - - - - Creates a window that has a vertical scroll bar. - - - - - Creates a window that has a horizontal scroll bar. - - - - - Creates a window that has a window menu on its title bar. The WS_CAPTION - style must also be specified. - - - - - Creates a window that has a sizing border. Same as the WS_SIZEBOX style. - - - - - Specifies the first control of a group of controls. The group consists of this - first control and all controls defined after it, up to the next control with - the WS_GROUP style. The first control in each group usually has the WS_TABSTOP - style so that the user can move from group to group. The user can subsequently - change the keyboard focus from one control in the group to the next control in - the group by using the direction keys. - - - - - Specifies a control that can receive the keyboard focus when the user presses - the TAB key. Pressing the TAB key changes the keyboard focus to the next - control with the WS_TABSTOP style. - - - - - Dialog styles. - http://msdn.microsoft.com/en-us/library/ms644994(VS.85).aspx - - - - - Specifying this style in the dialog template tells Windows that the dtX and dtY values - of the DIALOGTEMPLATE struct are relative to the screen origin, not the owner of the - dialog box. - - - - - Create a dialog box with the WS_EX_TOPMOST flag. This flag cannot be combined with the - DS_CONTROL style. This flag is obsolete and is included for compatibility with 16-bit - versions of Windows. - - - - - Applies to 16-bit applications only. This style directs edit controls in the dialog - box to allocate memory from the application data segment. Otherwise, edit controls - allocate storage from a global memory object. - - - - - Indicates that the header of the dialog box template contains additional data specifying - the font to use for text in the client area and controls of the dialog box. - - - - - Creates a dialog box with a modal dialog-box frame that can be combined with a title - bar and window menu by specifying the WS_CAPTION and WS_SYSMENU styles. - - - - - Suppresses WM_ENTERIDLE messages that the system would otherwise send to the owner of the - dialog box while the dialog box is displayed. - - - - - Causes the system to use the SetForegroundWindow function to bring the dialog - box to the foreground. - - - - - Gives the dialog box a nonbold font and draws three-dimensional borders around - control windows in the dialog box. - - - - - Causes the dialog box to use the SYSTEM_FIXED_FONT instead of the default SYSTEM_FONT. - This is a monospace font compatible with the System font in 16-bit versions of Windows - earlier than 3.0. - - - - - Creates the dialog box even if errors occur — for example, if a child window cannot be - created or if the system cannot create a special data segment for an edit control. - - - - - Creates a dialog box that works well as a child window of another dialog box, - much like a page in a property sheet. This style allows the user to tab among - the control windows of a child dialog box, use its accelerator keys, and so on. - - - - - Centers the dialog box in the working area; that is, the area not obscured by the tray. - - - - - Centers the dialog box on the mouse cursor. - - - - - Includes a question mark in the title bar of the dialog box. When the user clicks the - question mark, the cursor changes to a question mark with a pointer. If the user then - clicks a control in the dialog box, the control receives a WM_HELP message. The control - should pass the message to the dialog box procedure, which should call the function - using the HELP_WM_HELP command. The help application displays a pop-up window that - typically contains help for the control. - - - - - Indicates that the dialog box should use the system font. - - - - - - - - - - Extended dialog styles. - - - - - Creates a window that has a double border; the window can, optionally, be created - with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY - message to its parent window when it is created or destroyed. - - - - - Specifies that a window created with this style should be placed above all non-topmost - windows and should stay above them, even when the window is deactivated. To add or remove - this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Specifies that a window created with this style should not be painted until siblings beneath - the window (that were created by the same thread) have been painted. The window appears - transparent because the bits of underlying sibling windows have already been painted. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. - A tool window has a title bar that is shorter than a normal title bar, and the - window title is drawn using a smaller font. A tool window does not appear in - the taskbar or in the dialog that appears when the user presses ALT+TAB. If a - tool window has a system menu, its icon is not displayed on the title bar. However, - you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window has a border with a raised edge. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, - the cursor changes to a question mark with a pointer. If the user then clicks a child window, - the child receives a WM_HELP message. The child window should pass the message to the parent - window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The - Help application displays a pop-up window that typically contains help for the child window. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has - an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls - has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with - button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment, the window text is displayed using right-to-left reading-order properties. - For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order - alignment, the vertical scroll bar (if present) is to the left of the client area. For other - languages, the style is ignored. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - The window itself contains child windows that should take part in dialog box navigation. - If this style is specified, the dialog manager recurses into children of this window when - performing navigation operations such as handling the TAB key, an arrow key, or a - keyboard mnemonic. - - - - - Creates a window with a three-dimensional border style intended to be used for items that - do not accept user input. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child - windows. Also, this cannot be used if the window has a class style of either CS_OWNDC - or CS_CLASSDC. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose - horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order - using double-buffering. For more information, see Remarks. This cannot be used - if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground - window when the user clicks it. The system does not bring this window to the foreground - when the user minimizes or closes the foreground window. - - - - - Possible DIALOGEXITEMTEMPLATE WindowClass ordinals. - - - - - A button. - - - - - An edit box. - - - - - A static control. - - - - - A list box. - - - - - A scroll bar. - - - - - A combo box. - - - - - Static control styles. - A static control specifies the STATIC class, appropriate window style constants, - and a combination of the following static control styles. - http://msdn.microsoft.com/en-us/library/bb760773(VS.85).aspx - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next left-aligned - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and centers the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next centered - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and right-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next - right-aligned line. Words that are longer than the width of the control - are truncated. - - - - - Specifies an icon to be displayed in the dialog box. If the control is created - as part of a dialog box, the text is the name of an icon (not a filename) defined - elsewhere in the resource file. If the control is created via CreateWindow or a - related function, the text is the name of an icon (not a filename) defined in the - resource file associated with the module specified by the hInstance parameter to - CreateWindow. The icon can be an animated cursor. - - - - - Specifies a rectangle filled with the current window frame color. - This color is black in the default color scheme. - - - - - Specifies a rectangle filled with the current screen background color. - This color is gray in the default color scheme. - - - - - Specifies a rectangle filled with the current window background color. This color is white - in the default color scheme. - - - - - Specifies a box with a frame drawn in the same color as the window frames. - This color is black in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the screen background (desktop). - This color is gray in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the window background. This color is - white in the default color scheme. - - - - - - - - - - Specifies a simple rectangle and displays a single line of left-aligned text in the rectangle. - The text line cannot be shortened or altered in any way. Also, if the control is disabled, - the control does not gray its text. - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - Tabs are expanded, but words are not wrapped. Text that extends past the - end of a line is clipped. - - - - - Specifies that the owner of the static control is responsible for drawing - the control. The owner window receives a WM_DRAWITEM message whenever the - control needs to be drawn. - - - - - Specifies that a bitmap is to be displayed in the static control. - The text is the name of a bitmap (not a filename) defined elsewhere in the - resource file. The style ignores the nWidth and nHeight parameters; the control - automatically sizes itself to accommodate the bitmap. - - - - - Specifies that an enhanced metafile is to be displayed in the static control. - The text is the name of a metafile. An enhanced metafile static control has a - fixed size; the metafile is scaled to fit the static control's client area. - - - - - Draws the top and bottom edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the left and right edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the frame of the static control using the EDGE_ETCHED edge style. - - - - - Windows 2000: A composite style bit that results from using the OR operator on - SS_* style bits. Can be used to mask out valid SS_* bits from a given bitmask. - Note that this is out of date and does not correctly include all valid styles. - Thus, you should not use this style. - - - - - Windows XP or later: Adjusts the bitmap to fit the size of the static control. - For example, changing the locale can change the system font, and thus controls - might be resized. If a static control had a bitmap, the bitmap would no longer - fit the control. This style bit dictates automatic redimensioning of bitmaps - to fit their controls. - - - - - Prevents interpretation of any ampersand characters in the control's text as - accelerator prefix characters. These are displayed with the ampersand removed and - the next character in the string underlined. This static control style may be - included with any of the defined static controls. You can combine SS_NOPREFIX - with other styles. This can be useful when filenames or other strings that may - contain an ampersand must be displayed in a static control in a dialog box. - - - - - Sends the parent window STN_CLICKED, STN_DBLCLK, STN_DISABLE, and STN_ENABLE - notification messages when the user clicks or double-clicks the control. - - - - - Specifies that a bitmap is centered in the static control that contains it. - The control is not resized, so that a bitmap too large for the control will - be clipped. If the static control contains a single line of text, the text - is centered vertically in the client area of the control. - - - - - Specifies that the lower right corner of a static control with the SS_BITMAP - or SS_ICON style is to remain fixed when the control is resized. Only the top - and left sides are adjusted to accommodate a new bitmap or icon. - - - - - Specifies that the actual resource width is used and the icon is loaded using - LoadImage. SS_REALSIZEIMAGE is always used in conjunction with SS_ICON. - - - - - Draws a half-sunken border around a static control. - - - - - Microsoft Windows 2000: Specifies that the static control duplicates the - text-displaying characteristics of a multiline edit control. Specifically, the - average character width is calculated in the same manner as with an edit control, - and the function does not display a partially visible last line. - - - - - Microsoft Windows NT or later: If the end of a string does not fit in the rectangle, - it is truncated and ellipses are added. If a word that is not at the end of the string - goes beyond the limits of the rectangle, it is truncated without ellipses. Using this - style will force the control’s text to be on one line with no word wrap. Compare with - SS_PATHELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Replaces characters in the middle of the string with ellipses so - that the result fits in the specified rectangle. If the string contains backslash (\) - characters, SS_PATHELLIPSIS preserves as much as possible of the text after the last - backslash. Using this style will force the control’s text to be on one line with no - word wrap. Compare with SS_ENDELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Truncates any word that does not fit in the rectangle and adds ellipses. - Using this style will force the control’s text to be on one line with no word wrap. - - - - - - - - - - Push button styles. - http://msdn.microsoft.com/en-us/library/bb775951(VS.85).aspx - - - - - Creates a push button that posts a WM_COMMAND message to the owner window when the - user selects the button. - - - - - Creates a push button that behaves like a BS_PUSHBUTTON style button, but has a distinct - appearance. If the button is in a dialog box, the user can select the button by pressing - the ENTER key, even when the button does not have the input focus. This style is useful - for enabling the user to quickly select the most likely (default) option. - - - - - Creates a small, empty check box with text. By default, the text is displayed to - the right of the check box. To display the text to the left of the check box, - combine this flag with the BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). - - - - - Creates a button that is the same as a check box, except that the check state - automatically toggles between checked and cleared each time the user selects the - check box. - - - - - Creates a small circle with text. By default, the text is displayed to the right of the - circle. To display the text to the left of the circle, combine this flag with the - BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). Use radio buttons for - groups of related, but mutually exclusive choices. - - - - - Creates a button that is the same as a check box, except that the box can be grayed - as well as checked or cleared. Use the grayed state to show that the state of the - check box is not determined. - - - - - Creates a button that is the same as a three-state check box, except that the box - changes its state when the user selects it. The state cycles through checked, - indeterminate, and cleared. - - - - - Creates a rectangle in which other controls can be grouped. Any text associated with - this style is displayed in the rectangle's upper left corner. - - - - - Obsolete, but provided for compatibility with 16-bit versions of Windows. Applications - should use BS_OWNERDRAW instead. - - - - - Creates a button that is the same as a radio button, except that when the user selects it, - the system automatically sets the button's check state to checked and automatically sets - the check state for all other buttons in the same group to cleared. - - - - - - - - - - Creates an owner-drawn button. The owner window receives a WM_DRAWITEM message when a visual - aspect of the button has changed. Do not combine the BS_OWNERDRAW style with any other - button styles. - - - - - Microsoft Windows 2000: A composite style bit that results from using the OR operator on - BS_* style bits. It can be used to mask out valid BS_* bits from a given bitmask. - - - - - Places text on the left side of the radio button or check box when combined with a radio button - or check box style. Same as the BS_RIGHTBUTTON style. - - - - - Specifies that the button displays text. - - - - - Specifies that the button displays an icon. - - - - - Specifies that the button displays a bitmap. See the Remarks section for its interaction - with BS_ICON. - - - - - Left-justifies the text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is left justified on the right side - of the check box or radio button. - - - - - Right-justifies text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is right justified on the right - side of the check box or radio button. - - - - - Centers text horizontally in the button rectangle. - - - - - Places text at the top of the button rectangle. - - - - - Places text at the bottom of the button rectangle. - - - - - Places text in the middle (vertically) of the button rectangle. - - - - - Makes a button (such as a check box, three-state check box, or radio button) look and - act like a push button. The button looks raised when it isn't pushed or checked, and - sunken when it is pushed or checked. - - - - - Wraps the button text to multiple lines if the text string is too long to fit on a - single line in the button rectangle. - - - - - Enables a button to send BN_KILLFOCUS and BN_SETFOCUS notification messages to its - parent window. - - - - - Specifies that the button is two-dimensional; it does not use the default - shading to create a 3-D image. - - - - - Microsoft Windows Vista and Version 6.00. Creates a split button that behaves like a - BS_PUSHBUTTON style button, but also has a distinctive appearance. If the split button - is in a dialog box, the user can select the split button by pressing the ENTER key, even - when the split button does not have the input focus. This style is useful for enabling - the user to quickly select the most likely (default) option. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like a - BS_PUSHBUTTON style button, but the command link button has a green arrow on the left pointing - to the button text. A caption for the button text can be set by sending the BCM_SETNOTE - message to the button. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like - a BS_PUSHBUTTON style button. If the button is in a dialog box, the user can select the - command link button by pressing the ENTER key, even when the command link button does - not have the input focus. This style is useful for enabling the user to quickly select - the most likely (default) option. - - - - - Edit control styles. - http://msdn.microsoft.com/en-us/library/bb775464(VS.85).aspx - - - - - Aligns text with the left margin. - - - - - Windows 98/Me, Windows 2000/XP: Centers text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Centers text in a multiline edit control. - - - - - Windows 98/Me, Windows 2000/XP: Right-aligns text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Right aligns text in a multiline edit control. - - - - - Designates a multiline edit control. The default is single-line edit control. - - - - - Converts all characters to uppercase as they are typed into the edit control. - - - - - Converts all characters to lowercase as they are typed into the edit control. - - - - - Displays an asterisk (*) for each character typed into the edit control. - This style is valid only for single-line edit controls. - - - - - Automatically scrolls text up one page when the user presses the ENTER key on - the last line. - - - - - Automatically scrolls text to the right by 10 characters when the user types - a character at the end of the line. When the user presses the ENTER key, - the control scrolls all text back to position zero. - - - - - Negates the default behavior for an edit control. - - - - - Converts text entered in the edit control. - - - - - Prevents the user from typing or editing text in the edit control. - - - - - Specifies that a carriage return be inserted when the user presses the - ENTER key while entering text into a multiline edit control in a dialog box. - If you do not specify this style, pressing the ENTER key has the same effect - as pressing the dialog box's default push button. This style has no effect - on a single-line edit control. - - - - - Allows only digits to be entered into the edit control. - - - - - Defines the header for a menu template. - A complete menu template consists of a header and one or more menu item lists. - - - - - Specifies the version number. This member must be zero. - - - - - Specifies the offset, in bytes, from the end of the header. - The menu item list begins at this offset. Usually, this member is zero, and the menu - item list follows immediately after the header. - - - - - Defines a menu item in a menu template. - - - - - Specifies one or more of the following predefined menu options that control the appearance of the menu item. - TODO - - - - - Defines the header for an extended menu template. - - - - - Template version number. This member must be 1 for extended menu templates. - - - - - Offset of the first MENUEXITEMTEMPLATE structure, relative to the end of - this structure member. If the first item definition immediately follows the - dwHelpId member, this member should be 4. - - - - - Drop-down menu or submenu item. - - - - - Menu item type. This member can be a combination of the type (beginning with MFT) values - listed with the MENUITEMINFO structure. - - - - - Menu item state. This member can be a combination of the state (beginning with MFS) values - listed with the MENUITEMINFO structure. - - - - - Menu item identifier. This is an application-defined value that identifies the menu item. - - - - - Value specifying whether the menu item is the last item in the menu bar, drop-down menu, - submenu, or shortcut menu and whether it is an item that opens a drop-down menu or submenu. - - - - - Specifies one or more of the following predefined menu options that control the - appearance of the menu item. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item is initially inactive and drawn with a gray effect. - - - - - - - - - - - - - - - Indicates that the menu item has a check mark next to it. - - - - - - - - - - - - - - - - - - - - Indicates that the owner window of the menu is responsible for drawing all visual - aspects of the menu item, including highlighted, selected, and inactive states. - This option is not valid for an item in a menu bar. - - - - - Indicates that the item is one that opens a drop-down menu or submenu. - - - - - Indicates that the menu item is placed in a new column. The old and new columns - are separated by a bar. - - - - - Indicates that the menu item is placed in a new column. - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item has a vertical separator to its left. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Specifies whether the menu item is the last item in the menu bar, drop-down menu, submenu, or shortcut - menu and whether it is an item that opens a drop-down menu or submenu. This member can be zero or more - of these values. - - - - - Defines the last menu item in the menu bar, drop-down menu, submenu, or shortcut menu. - - - - - Defines a item that opens a drop-down menu or submenu. Subsequent structures define menu - items in the corresponding drop-down menu or submenu. - - - - - Defines an accelerator key used in an accelerator table. - http://msdn.microsoft.com/en-us/library/ms646340(VS.85).aspx - - - - - Accelerator flags. - - - - - Accelerator key. This member can be either a virtual-key code or an ASCII character code. - - - - - Accelerator identifier. - - - - - Flags, fVirt field of the Accelerator table structure. - - - - - Virtual key. - - - - - Specifies that no top-level menu item is highlighted when the accelerator is used. - This is useful when defining accelerators for actions such as scrolling that do not - correspond to a menu item. If NOINVERT is omitted, a top-level menu item will be - highlighted (if possible) when the accelerator is used. - - - - - Causes the accelerator to be activated only if the SHIFT key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the CONTROL key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the ALT key is down. - Applies only to virtual keys. - - - - - Virtual key definitions. - - - - - Standard virtual left mouse button. - - - - - Standard virtual right mouse button. - - - - - Ctrl-Break / Ctrl-C. - - - - - Standard virtual middle mouse button. - - - - - - - - - - - - - - - Backspace. - - - - - Tab. - - - - - Delete. - - - - - Return. - - - - - Shift. - - - - - Control. - - - - - Menu. - - - - - Pause. - - - - - Caps lock. - - - - - - - - - - - - - - - - - - - - - - - - - Escape. - - - - - - - - - - - - - - - - - - - - - - - - - Space. - - - - - - - - - - - - - - - End. - - - - - Home. - - - - - Left arrow. - - - - - Up arrow. - - - - - Right arrow. - - - - - Down arrow. - - - - - - - - - - Print Screen. - - - - - - - - - - - - - - - Insert. - - - - - Delete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NEC PC-9800 keyboard '=' key on numpad. - - - - - Fujitsu/OASYS keyboard 'Dictionary' key. - - - - - Fujitsu/OASYS keyboard 'Unregister word' key. - - - - - Fujitsu/OASYS keyboard 'Register word' key. - - - - - Fujitsu/OASYS keyboard 'Left OYAYUBI' key. - - - - - Fujitsu/OASYS keyboard 'Right OYAYUBI' key. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';:' for US - - - - - '+' any country - - - - - ',' any country - - - - - '-' any country - - - - - '.' any country - - - - - '/?' for US - - - - - '`~' for US - - - - - '[{' for US - - - - - '\|' for US - - - - - ']}' for US - - - - - ''"' for US - - - - - - - - - - 'AX' key on Japanese AX kbd - - - - - "<>" or "\|" on RT 102-key kbd. - - - - - Help key on ICO - - - - - 00 key on ICO - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contains information about an individual font in a font resource group. - - - - - Specifies a user-defined version number for the resource data that tools can - use to read and write resource files. - - - - - Specifies the size of the file, in bytes. - - - - - Contains a 60-character string with the font supplier's copyright information. - - - - - Specifies the type of font file. - - - - - Specifies the point size at which this character set looks best. - - - - - Specifies the vertical resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the horizontal resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the distance from the top of a character definition cell to the baseline of the - typographical font. - - - - - Specifies the amount of leading inside the bounds set by the dfPixHeight member. Accent marks and - other diacritical characters can occur in this area. - - - - - Specifies the amount of extra leading that the application adds between rows. - - - - - Specifies an italic font if not equal to zero. - - - - - Specifies an underlined font if not equal to zero. - - - - - Specifies a strikeout font if not equal to zero. - - - - - Specifies the weight of the font in the range 0 through 1000. For example, 400 is roman and - 700 is bold. If this value is zero, a default weight is used. - - - - - Specifies the character set of the font. - - - - - Specifies the width of the grid on which a vector font was digitized. For raster fonts, - if the member is not equal to zero, it represents the width for all the characters in the - bitmap. If the member is equal to zero, the font has variable-width characters. - - - - - Specifies the height of the character bitmap for raster fonts or the height of the grid - on which a vector font was digitized. - - - - - Specifies the pitch and the family of the font. - - - - - Specifies the average width of characters in the font (generally defined as the width of - the letter x). This value does not include the overhang required for bold or italic characters. - - - - - Specifies the width of the widest character in the font. - - - - - Specifies the first character code defined in the font. - - - - - Specifies the last character code defined in the font. - - - - - Specifies the character to substitute for characters not in the font. - - - - - Specifies the character that will be used to define word breaks for text justification. - - - - - Specifies the number of bytes in each row of the bitmap. This value is always even so - that the rows start on word boundaries. For vector fonts, this member has no meaning. - - - - - Specifies the offset in the file to a null-terminated string that specifies a device name. - For a generic font, this value is zero. - - - - - Specifies the offset in the file to a null-terminated string that names the typeface. - - - - - This member is reserved. - - - - - This structure depicts the organization of data in a file-version resource. - It contains version information not dependent on a particular language and code page combination. - http://msdn.microsoft.com/en-us/library/aa909193.aspx - - - - - A hardware independent dictionary of language and code page identifier tables. - - - - - A new hardware independent dictionary of language and code page identifier tables. - - - - - An existing hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - - - - Read a hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - Pointer to the end of data. - - - - Write the hardware independent dictionary of language and code page identifier tables to a binary stream. - - Binary stream. - - - - The default language and code page identifier table. - - - - - Returns a language and code page identifier table. - - Language ID. - A language and code page identifier table. - - - - String representation of VarFileInfo. - - Indent. - String in the VarFileInfo format. - - - - This structure depicts the organization of data in a file-version resource. It typically contains a - list of language and code page identifier pairs that the version of the application or DLL supports. - http://msdn.microsoft.com/en-us/library/bb202818.aspx - - - - - A dictionary of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - Table key. - - - - An existing table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - Read a table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - - Write the table of language and code page identifier pairs to a binary stream. - - Binary stream. - Last unpadded position. - - - - Returns a code page identifier for a given language. - - Language ID. - Code page identifier. - - - - String representation of the var table. - - Indent. - String representation of the var table. - - - - VS_VERSIONINFO - This structure depicts the organization of data in a file-version resource. It is the root structure - that contains all other file-version information structures. - http://msdn.microsoft.com/en-us/library/aa914916.aspx - - - - - The resource header. - - - - - A dictionary of resource tables. - - - - - An existing version resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new language-netural version resource. - - - - - Read a version resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - String representation of the file version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - String representation of the protect version. - - - - - Write this version resource to a binary stream. - - Binary stream. - - - - Returns an entry within this resource table. - - Entry key. - A resource table. - - - - Returns an entry within this resource table. - - Entry index. - A resource table. - - - - Return string representation of the version resource. - - - - - - winver.h, version management functions, types and definitions - - - - - VS_VERSION signature. - - - - - VS_VERSION structure version. - - - - - VS_VERSION file flags mask. - - - - - VS_VERSION file flags. - - - - - The file contains debugging information. - - - - - The file is a prerelease development version, not a final commercial release. - - - - - PThe file has been modified somehow and is not identical to the original file - that shipped with the product. - - - - - The file was not built using standard release procedures. There should be data - in the file's "PrivateBuild" version information string. - - - - - The version information in this structure was not found inside the file, - but instead was created when needed based on the best information available. - Therefore, this structure's information may differ slightly from what the "real" - values are. - - - - - The file was built using standard release procedures, but is somehow different - from the normal file having the same version number. There should be data in the - file's "SpecialBuild" version information string. - - - - - VS_VERSION file OSs. - - - - - The operating system under which the file was designed to run could not be determined. - - - - - The file was designed to run under MS-DOS. - - - - - The file was designed to run under a 16-bit version of OS/2. - - - - - The file was designed to run under a 32-bit version of OS/2. - - - - - The file was designed to run under Windows NT/2000. - - - - - - - - - - The file was designed to run under the 16-bit Windows API. - - - - - The file was designed to be run under a 16-bit version of Presentation Manager. - - - - - The file was designed to be run under a 32-bit version of Presentation Manager. - - - - - The file was designed to run under the 32-bit Windows API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VS_VERSION file types. - - - - - The type of file could not be determined. - - - - - The file is an application. - - - - - The file is a Dynamic Link Library (DLL). - - - - - The file is a device driver. dwFileSubtype contains more information. - - - - - The file is a font. dwFileSubtype contains more information. - - - - - The file is a virtual device. - - - - - The file is a static link library. - - - - - File sub-type. - - - - - The type of driver could not be determined. - - - - - The file is a printer driver. - - - - - The file is a keyboard driver. - - - - - The file is a language driver. - - - - - The file is a display driver. - - - - - The file is a mouse driver. - - - - - The file is a network driver. - - - - - The file is a system driver. - - - - - The file is an installable driver. - - - - - The file is a sound driver. - - - - - The file is a communications driver. - - - - - The file is an input method driver. - - - - - The file is a versioned printer driver. - - - - - The file is a raster font. - - - - - The file is a vector font. - - - - - The file is a TrueType font. - - - - diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.dll b/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.dll deleted file mode 100644 index cc39dd5..0000000 Binary files a/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.dll and /dev/null differ diff --git a/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.xml b/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.xml deleted file mode 100644 index ca74d41..0000000 --- a/packages/Vestris.ResourceLib.2.1.0/lib/netstandard2.0/Vestris.ResourceLib.xml +++ /dev/null @@ -1,6603 +0,0 @@ - - - - Vestris.ResourceLib - - - - - Standard accelerator. - - - - - Read the accelerator. - - Address in memory. - - - - Write accelerator to a binary stream. - - Binary stream. - - - - String representation of the accelerator key. - - - - - An unsigned integer value that identifies the accelerator. - - - - - String representation of the accelerator. - - String representation of the accelerator. - - - - An accelerator, RT_ACCELERATOR resource. - An accelerator provides the user with access to an application's command set. - - - - - Accelerator keys. - - - - - A new accelerator resource. - - - - - An existing accelerator resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the accelerators table. - - Handle to a module. - Pointer to the beginning of the accelerator table. - Address of the end of the accelerator table. - - - - String representation of the accelerators resource. - - - - - - Creates an 8 bit aligned copy of the buffer if it is not already aligned - - - - - A bitmap file in a .bmp format. - - - - - Device independent bitmap. - - - - - An existing bitmap file. - - A file in a .bmp format. - - - - An embedded bitmap resource. - - - - - An existing bitmap resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new bitmap resource. - - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the bitmap resource to a binary stream. - - Binary stream. - - - - A device independent bitmap. - - - - - This structure depicts the organization of data in a hardware-independent cursor resource. - - - - - A hardware-independent cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent cursor resource. - - - - - A new collection of cursors that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a cursor resource. - - - - - An existing cursor resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new cursor resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Language. - An icon resource. - - - - Horizontal hotspot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Vertical hot spot coordinate. - The hot spot of a cursor is the point to which Windows refers in tracking the cursor's position. - - - - - Write the cursor data to a file. - - Target executable file. - - - - Read DIB image. - - DIB bits. - DIB size. - - - - A device-independent image consists of a BITMAPINFOHEADER where - bmWidth is the width of the image andbmHeight is double the height - of the image, followed by the bitmap color table, followed by the image - pixels, followed by the mask pixels. - - - - - Raw image data. - - - - - Bitmap info header. - - - - - Bitmap size in bytes. - - - - - A new icon image. - - - - - A device-independent bitmap. - - Bitmap data. - - - - Create a copy of an image. - - Source image. - - - - Read icon data. - - Pointer to the beginning of icon data. - Icon data size. - - - - Size of the image mask. - - - - - Position of the DIB bitmap bits within a DIB bitmap array. - - - - - Number of colors in the palette. - - - - - Returns the width of a row in a DIB Bitmap given the number of bits. DIB Bitmap rows always align on a DWORD boundary. - - Number of bits. - Width of a row in bytes. - - - - Bitmap monochrome mask. - - - - - Bitmap color (XOR) part of the image. - - - - - Complete image. - - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - Indicates the character set to use. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Weight of the font. - - - - - Indicates whether the font is italic. - - - - - Number of dialog items. - - - - - An extended dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write dialog control to a binary stream. - - Binary stream. - - - - String representation of the dialog. - - String in the DIALOGEX [dialog] format. - - - - A container for the DIALOGTEMPLATEEX structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - An extended dialog control template structure. - - - - - Read the dialog control. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Return a string representation of the dialog control. - - A single line in the "CLASS name id, dimensions and styles' format. - - - - A dialog template resource. - - - - - A dialog template structure that describes the dialog. - - - - - A structured dialog resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A structured dialog resource embedded in an executable module. - - - - - Dialog resource in standard resource editor text format. - - Multi-line string. - - - - A container for the DIALOGTEMPLATE structure. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Number of dialog items. - - - - - A standard dialog structure. - - - - - Read the dialog resource. - - Pointer to the beginning of the dialog structure. - - - - Write the dialog template data to a binary stream. - - Binary stream. - - - - Returns a string representation of the dialog. - - String in the DIALOG ... format. - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Number of items in this structure. - - - - - The name of the typeface for the font. - - - - - Point size of the font to use for the text in the dialog box and its controls. - - - - - Dialog caption. - - - - - Menu resource Id. - - - - - Window class Id. - - - - - Controls within this dialog. - - - - - Dialog template representation in a standard text format. - - Multiline string. - - - - String represetnation of a control. - - - - - - Write the resource to a binary stream. - - Binary stream. - - - - A container for a control within a dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Dialog style. - - - - - Extended dialog style. - - - - - Control identifier. - - - - - A standard dialog control structure. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - String represetnation of a control. - - - - - - A dialog template. - - - - - X-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Width, in dialog box units, of the dialog box. - - - - - Height, in dialog box units, of the dialog box. - - - - - Style of the dialog box. - - - - - Optional extended style of the dialog box. - - - - - Dialog caption. - - - - - Window class Id. - - - - - Window class of the control. - - - - - Additional creation data. - - - - - Write the dialog control to a binary stream. - - Binary stream. - - - - Dialog template utility functions. - - - - - Read a dialog resource id. - - Address in memory. - Resource read. - - - - - String representation of the dialog or control style of two types. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control styles of two types. - - Dialog or control style. - Dialog or control extended style. - String in the "s1 | s2 | ... | s3" format. - - - - String representation of the dialog or control style of one type. - - Dialog or control style. - String in the "s1 | s2 | ... | s3" format. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - Returns the type of the resource in this group. - - - - - Icons contained in this hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - Save a hardware-independent icon resource to an executable file. - - Name of an executable file (.exe or .dll). - - - - Read a hardware-independent icon resource from a loaded module. - - Loaded executable module. - Pointer to the beginning of a hardware-independent icon resource. - Pointer to the end of the hardware-independent icon resource. - - - - Write a hardware-independent icon resource to a binary stream. - - Binary stream. - - - - Fixed file information. - - - - - Default Windows fixed file information. - - - - - Fixed file info structure. - - - - - Read the fixed file information structure. - - Address in memory. - - - - String representation of the file version. - - - - - String representation of the protect version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - Write fixed file information to a binary stream. - - Binary stream. - - - - Size of the VS_FIXEDFILEINFO structure. - - - - - String representation of the fixed file info. - - String representation of the fixed file info. - - - - A font directory entry. - - - - - Font ordinal. - - - - - Typeface name of the font. - - - - - Specifies the name of the device if this font file is designated for a specific device. - - - - - Font information. - - - - - A new font directory entry. - - - - - Read the font directory entry. - - Pointer in memory. - Pointer to the end of the font directory entry. - - - - Write the font directory entry to a binary stream. - - Binary stream. - - - - A font directory, RT_FONTDIR resource. - - - - - Number of fonts in this directory. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font directory to a binary stream. - - Binary stream. - - - - A font, RT_FONT resource. - - - - - A new font resource. - - - - - An existing font resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Read the font resource. - - Handle to a module. - Pointer to the beginning of the font structure. - Address of the end of the font structure. - - - - Write the font resource to a binary writer. - - Binary writer. - - - - Gdi32.dll interop functions. - - - - - Bitmap compression options. - - - - - An uncompressed format. - - - - - A run-length encoded (RLE) format for bitmaps with 8 bpp. The compression format is a 2-byte format consisting of a count byte followed by a byte containing a color index. For more information, see Bitmap Compression. - - - - - An RLE format for bitmaps with 4 bpp. The compression format is a 2-byte format consisting of a count byte followed by two word-length color indexes. For more information, see Bitmap Compression. - - - - - Specifies that the bitmap is not compressed and that the color table consists of three DWORD color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16- and 32-bpp bitmaps. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a JPEG image. - - - - - Windows 98/Me, Windows 2000/XP: Indicates that the image is a PNG image. - - - - - A bitmap info header. - See http://msdn.microsoft.com/en-us/library/ms532290.aspx for more information. - - - - - Bitmap information size. - - - - - Bitmap width. - - - - - Bitmap height. - - - - - Number of logical planes. - - - - - Bitmap bitrate. - - - - - Bitmap compression. - - - - - Image size. - - - - - Horizontal pixel resolution. - - - - - Vertical pixel resolution. - - - - - - - - - - - - - - - Returns the current bitmap compression. - - - - - Bitmap pixel format. - - - - - Bitmap pixel format English standard string. - - - - - Defines the dimensions and color information of a Windows-based device-independent bitmap (DIB). - http://msdn.microsoft.com/en-us/library/dd183375(VS.85).aspx. - - - - - Specifies a bitmap information header structure that contains information about the dimensions of color format. - - - - - An array of RGBQUAD. The elements of the array make up the color table. - - - - - Store colors in a paletised icon (2, 4 or 8 bit). - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Blue. - - - - - Green. - - - - - Red. - - - - - Reserved. - - - - - The BITMAPFILEHEADER structure contains information about the type, size, and layout of a file that contains a DIB. - http://msdn.microsoft.com/en-us/library/dd183374(VS.85).aspx - - - - - The file type; must be BM. - - - - - The size, in bytes, of the bitmap file. - - - - - Reserved; must be zero. - - - - - Reserved; must be zero. - - - - - The offset, in bytes, from the beginning of the BITMAPFILEHEADER structure to the bitmap bits. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Set the pixels in the specified rectangle on the device that is associated with the destination device - context using color data from a DIB, JPEG, or PNG image. - http://msdn.microsoft.com/en-us/library/dd162974(VS.85).aspx - - A handle to the device context. - The x-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The y-coordinate, in logical units, of the upper-left corner of the destination rectangle. - The width, in logical units, of the image. - The height, in logical units, of the image. - The x-coordinate, in logical units, of the lower-left corner of the image. - The y-coordinate, in logical units, of the lower-left corner of the image. - The starting scan line in the image. - The number of DIB scan lines contained in the array pointed to by the lpvBits parameter. - A pointer to the color data stored as an array of bytes. - A pointer to a BITMAPINFOHEADER structure that contains information about the DIB. - Indicates whether the bmiColors member of the BITMAPINFOHEADER structure contains explicit red, green, blue (RGB) values or indexes into a palette. - - If the function succeeds, the return value is the number of scan lines set. - If zero scan lines are set (such as when dwHeight is 0) or the function fails, the function returns zero. - If the driver cannot support the JPEG or PNG file image passed to SetDIBitsToDevice, the function will fail and return GDI_ERROR. - - - - - Retrieves the bits of the specified compatible bitmap and copies them into a buffer as - a DIB using the specified format - - A handle to the device context. - A handle to the bitmap. This must be a compatible bitmap (DDB). - The first scan line to retrieve. - The number of scan lines to retrieve. - A pointer to a buffer to receive the bitmap data. - A pointer to a BITMAPINFO structure that specifies the desired format for the DIB data. - The format of the bmiColors member of the BITMAPINFO structure. - - If the lpvBits parameter is non-NULL and the function succeeds, the return value is the number of scan lines copied from the bitmap. - If the lpvBits parameter is NULL and GetDIBits successfully fills the BITMAPINFO structure, the return value is non-zero. - If the function fails, the return value is zero. - - - - - Create a DIB that applications can write to directly. The function gives you a pointer to the location - of the bitmap bit values. You can supply a handle to a file-mapping object that the function will use - to create the bitmap, or you can let the system allocate the memory for the bitmap. - - Handle to a device context. - A pointer to a BITMAPINFO structure that specifies various attributes of the DIB, including the bitmap dimensions and colors. - The type of data contained in the bmiColors array member of the BITMAPINFO structure pointed to by pbmi (either logical palette indexes or literal RGB values). - A pointer to a variable that receives a pointer to the location of the DIB bit values. - A handle to a file-mapping object that the function will use to create the DIB. This parameter can be NULL. - The offset from the beginning of the file-mapping object referenced by hSection where storage for the bitmap bit values is to begin. - - If the function succeeds, the return value is a handle to the newly created DIB, and *ppvBits points to the bitmap bit values. - If the function fails, the return value is NULL, and *ppvBits is NULL. - - - - - Defines how to interpret the values in the color table of a DIB. - - - - - The color table contains literal RGB values. - - - - - The color table consists of an array of 16-bit indexes into the LogPalette - object that is currently defined in the playback device context. - - - - - No color table exists. The pixels in the DIB are indices into the current logical - palette in the playback device context. - - - - - - - - - - Creates a memory device context (DC) compatible with the specified device. - - Handle to an existing device context. - - The handle to a memory device context indicates success. - NULL indicates failure. - - - - - - - Specifies either DISPLAY or the name of a specific display device or the name of a print provider, which is usually WINSPOOL. - Specifies the name of the specific output device being used, as shown by the Print Manager (for example, Epson FX-80). - This parameter is ignored and should be set to NULL. It is provided only for compatibility with 16-bit Windows. - A pointer to a DEVMODE structure containing device-specific initialization data for the device driver. - - - - - Creates a bitmap compatible with the device that is associated with the specified device context. - - A handle to a device context. - The bitmap width, in pixels. - The bitmap height, in pixels. - - If the function succeeds, the return value is a handle to the compatible bitmap (DDB). - If the function fails, the return value is NULL. - - - - - Selects an object into a specified device context. The new object replaces the previous object of the same type. - - Handle to the device context. - Handle to the object to be selected. - - If the selected object is not a region, the handle of the object being replaced indicates success. - If the selected object is a region, one of the following values indicates success. - - - - - Deletes a logical pen, brush, font, bitmap, region, or palette, freeing all system resources associated with the object. - - Handle to a logical pen, brush, font, bitmap, region, or palette. - - Nonzero indicates success. - Zero indicates that the specified handle is not valid or that the handle is currently selected into a device context. - - - - - Deletes the specified device context. - - A handle to the device context. - - If the function succeeds, the return value is nonzero. - If the function fails, the return value is zero. - - - - - A generic resource. - - - - - Raw resource data. - - - - - Raw resource data. - - - - - An unstructured generic resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - A generic resource. - - Resource name. - Resource type. - Resource language. - - - - Read a generic resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - This structure depicts the organization of data in a hardware-independent icon resource. - - - - - A hardware-independent icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new hardware-independent icon resource. - - - - - A new collection of icons that can be embedded into an executable file. - - - - - This structure depicts the organization of data in a .ico file. - - - - - Resource type. - - - - - Icon. - - - - - Cursor. - - - - - Type of the group icon resource. - - - - - Collection of icons in an .ico file. - - - - - An existing .ico file. - - An existing icon (.ico) file. - - - - Load from a .ico file. - - An existing icon (.ico) file. - - - - Read icons. - - Pointer to the beginning of a FILEGRPICONDIR structure. - Pointer to the end of a FILEGRPICONDIR structure. - - - - This structure depicts the organization of icon data in a .ico file. - - - - - Icon header. - - - - - Icon bitmap. - - - - - New icon data. - - - - - Icon width. - - - - - Icon height. - - - - - Image size in bytes. - - - - - Read a single icon (.ico). - - Pointer to the beginning of this icon's data. - Pointer to the beginning of all icon data. - Pointer to the end of this icon's data. - - - - Icon size as a string. - - Icon size in the width x height format. - - - - This structure depicts the organization of data in an icon resource. - - - - - Directory header. - - - - - Actual image. - - - - - Hardware-independent icon directory header. - - - - - Embedded icon Id. - - - - - An icon image. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Create a new icon image resource from a file icon. - - File icon. - Resource type. - Resource id. - Resource language. - - - - Icon width in pixels. - - - - - Icon height in pixels. - - - - - Image size in bytes. - - - - - Read an icon resource from a previously loaded module. - - Module handle. - Pointer to a directory entry in the hardware-independent icon resource. - Pointer to the end of the icon resource. - - - - Read the bitmap image. - - DIB bits. - Size of image. - - - - Icon pixel format. - - - - - Icon pixel format English standard string. - - - - - String representation of the icon. - - A string in a format of width x height followed by the pixel format. - - - - Write icon resource data to a binary stream. - - Binary stream. - - - - Save icon to a file. - - Target executable file. - - - - This structure depicts the organization of data in an icon resource. - - - - - An existing icon resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new icon resource. - - - - - Convert into an icon resource that can be written into an executable. - - Icon image. - Icon Id. - Resource language. - An icon resource. - - - - Kernel32.dll interop functions. - - - - - A resource header. - - - - - Header length. - - - - - Data length. - - - - - Resource type. - - - - - A new resource header of a given length. - - - - - - Resource header type. - - - - - Binary data. - - - - - String data. - - - - - Language and code page combinations. - The low-order word of each DWORD must contain a Microsoft language identifier, - and the high-order word must contain the IBM code page number. - Either high-order or low-order word can be zero, indicating that the file is language - or code page independent. - - - - - Microsoft language identifier. - - - - - IBM code page number. - - - - - This structure contains version information about a file. - This information is language- and code page–independent. - http://msdn.microsoft.com/en-us/library/ms647001.aspx - - - - - Contains the value 0xFEEF04BD. This is used with the szKey member of the VS_VERSIONINFO structure when searching a file for the VS_FIXEDFILEINFO structure. - - - - - Specifies the binary version number of this structure. The high-order word of this member contains the major version number, and the low-order word contains the minor version number. - - - - - Specifies the most significant 32 bits of the file's binary version number. This member is used with dwFileVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the file's binary version number. This member is used with dwFileVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the most significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionLS to form a 64-bit value used for numeric comparisons. - - - - - Specifies the least significant 32 bits of the binary version number of the product with which this file was distributed. This member is used with dwProductVersionMS to form a 64-bit value used for numeric comparisons. - - - - - Contains a bitmask that specifies the valid bits in dwFileFlags. A bit is valid only if it was defined when the file was created. - - - - - Contains a bitmask that specifies the Boolean attributes of the file. - - - - - Specifies the operating system for which this file was designed. - - - - - Specifies the general type of file. - - - - - Specifies the function of the file. - - - - - Specifies the most significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Specifies the least significant 32 bits of the file's 64-bit binary creation date and time stamp. - - - - - Creates a default Windows VS_FIXEDFILEINFO structure. - - A default Windows VS_FIXEDFILEINFO. - - - - A hardware-independent icon directory resource header. - http://msdn.microsoft.com/en-us/library/ms997538.aspx - - - - - Reserved, must be zero. - - - - - Resource type, 1 for icons. - - - - - Number of images. - - - - - Hardware-independent icon directory entry. - See http://msdn.microsoft.com/en-us/library/ms997538.aspx for more information. - - - - - Width of the image. Starting with Windows 95 a value of 0 represents width of 256. - - - - - Height of the image. Starting with Windows 95 a value of 0 represents height of 256. - - - - - Number of colors in the image. - bColors = 1 << (wBitsPerPixel * wPlanes) - If wBitsPerPixel* wPlanes is greater orequal to 8, then bColors = 0. - - - - - Reserved. - - - - - Number of bitmap planes. - 1: monochrome bitmap - - - - - Bits per pixel. - 1: monochrome bitmap - - - - - Image size in bytes. - - - - - Icon ID. - - - - - Hardware-independent icon directory entry in an .ico file. - - - - - Icon width. - - - - - Icon height. - - - - - Colors; 0 means 256 or more. - - - - - Reserved. - - - - - Number of bitmap planes for icons. - Horizontal hotspot for cursors. - - - - - Bits per pixel for icons. - Vertical hostpot for cursors. - - - - - Image size in bytes. - - - - - Offset of bitmap data from the beginning of the file. - - - - - Hardware-independent icon structure in an .ico file. - - - - - Reserved, must be zero. - - - - - Resource Type (1 for icons). - - - - - Number of images. - - - - - If this value is used, the system maps the file into the calling process's virtual address space as if it were a data file. - - - - - If this value is used, and the executable module is a DLL, the system does not call DllMain for process and thread initialization and termination. - - - - - If this value is used and lpFileName specifies an absolute path, the system uses the alternate file search strategy. - - - - - If this value is used, the system does not perform automatic trust comparisons on the DLL or its dependents when they are loaded. - - - - - Loads the specified module into the address space of the calling process. - The specified module may cause other modules to be loaded. - - The name of the module. - This parameter is reserved for future use. - The action to be taken when loading the module. - - - - - Frees the loaded dynamic-link library (DLL) module and, if necessary, decrements its reference count. - - A handle to the loaded library module. - If the function succeeds, the return value is nonzero. - - - - Predefined resource types. - - - - - Hardware-dependent cursor resource. - - - - - Bitmap resource. - - - - - Hardware-dependent icon resource. - - - - - Menu resource. - - - - - Dialog box. - - - - - String-table entry. - - - - - Font directory resource. - - - - - Font resource. - - - - - Accelerator table. - - - - - Application-defined resource (raw data). - - - - - Message-table entry. - - - - - Hardware-independent cursor resource. - - - - - Hardware-independent icon resource. - - - - - Version resource. - - - - - Allows a resource editing tool to associate a string with an .rc file. - - - - - Plug and Play resource. - - - - - VXD. - - - - - Animated cursor. - - - - - Animated icon. - - - - - HTML. - - - - - Microsoft Windows XP: Side-by-Side Assembly XML Manifest. - - - - - Enumerates resource types within a binary module. - - Handle to a module to search. - Pointer to the callback function to be called for each enumerated resource type. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful; otherwise, FALSE. - - - - An application-defined callback function used with the EnumResourceTypes and EnumResourceTypesEx functions. - - The handle to the module whose executable file contains the resources for which the types are to be enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the type is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceTypes or EnumResourceTypesEx function. - Returns TRUE if successful; otherwise, FALSE. - - - - Enumerates resources of a specified type within a binary module. - - Handle to a module to search. - Pointer to a null-terminated string specifying the type of the resource for which the name is being enumerated. - Pointer to the callback function to be called for each enumerated resource name or ID. - Specifies an application-defined value passed to the callback function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - An application-defined callback function used with the EnumResourceNames and EnumResourceNamesEx functions. - - The handle to the module whose executable file contains the resources that are being enumerated. - Pointer to a null-terminated string specifying the type of resource that is being enumerated. - Specifies the name of a resource of the type being enumerated. - Specifies the application-defined parameter passed to the EnumResourceNames or EnumResourceNamesEx function. - Returns TRUE if the function succeeds or FALSE if the function does not find a resource of the type specified, or if the function fails for another reason. - - - - Enumerates language-specific resources, of the specified type and name, associated with a binary module. - - The handle to a module to search. - Pointer to a null-terminated string specifying the type of resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Pointer to the callback function to be called for each enumerated resource language. - Specifies an application-defined value passed to the callback function. - Returns TRUE if successful or FALSE otherwise. - - - - An application-defined callback function used with the EnumResourceLanguages and EnumResourceLanguagesEx functions. - - The handle to the module whose executable file contains the resources for which the languages are being enumerated. - Pointer to a null-terminated string specifying the type name of the resource for which the language is being enumerated. - Pointer to a null-terminated string specifying the name of the resource for which the language is being enumerated. - Specifies the language identifier for the resource for which the language is being enumerated. - Specifies the application-defined parameter passed to the EnumResourceLanguages or EnumResourceLanguagesEx function. - Returns TRUE if successful or FALSE otherwise. - - - - Determines the location of the resource with the specified type, name, and language in the specified module. - - Handle to the module whose executable file contains the resource. - Pointer to a null-terminated string specifying the type name of the resource. - Pointer to a null-terminated string specifying the name of the resource. - Specifies the language of the resource. - If the function succeeds, the return value is a handle to the specified resource's information block. - - - - Locks the specified resource in memory. - - Handle to the resource to be locked. - If the loaded resource is locked, the return value is a pointer to the first byte of the resource; otherwise, it is NULL. - - - - Loads the specified resource into global memory. - - Handle to the module whose executable file contains the resource. - Handle to the resource to be loaded. - If the function succeeds, the return value is a handle to the data associated with the resource. - - - - Returns the size, in bytes, of the specified resource. - - Handle to the module whose executable file contains the resource. - Handle to the resource. This handle must be created by using the FindResource or FindResourceEx function. - If the function succeeds, the return value is the number of bytes in the resource. - - - - Closes an open object handle. - - A valid handle to an open object. - If the function succeeds, the return value is nonzero. - - - - Returns a handle to either a language-neutral portable executable file (LN file) or a - language-specific resource file (.mui file) that can be used by the UpdateResource function - to add, delete, or replace resources in a binary module. - - Pointer to a null-terminated string that specifies the binary file in which to update resources. - Specifies whether to delete the pFileName parameter's existing resources. - If the function succeeds, the return value is a handle that can be used by the UpdateResource and EndUpdateResource functions. - - - - Adds, deletes, or replaces a resource in a portable executable (PE) file. - There are some restrictions on resource updates in files that contain Resource Configuration (RC Config) data: - language-neutral (LN) files and language-specific resource (.mui) files. - - A module handle returned by the BeginUpdateResource function, referencing the file to be updated. - Pointer to a null-terminated string specifying the resource type to be updated. - Pointer to a null-terminated string specifying the name of the resource to be updated. - Specifies the language identifier of the resource to be updated. - Pointer to the resource data to be inserted into the file indicated by hUpdate. - Specifies the size, in bytes, of the resource data at lpData. - Returns TRUE if successful or FALSE otherwise. - - - - Commits or discards changes made prior to a call to UpdateResource. - - A module handle returned by the BeginUpdateResource function, and used by UpdateResource, referencing the file to be updated. - Specifies whether to write the resource updates to the file. If this parameter is TRUE, no changes are made. If it is FALSE, the changes are made: the resource updates will take effect. - Returns TRUE if the function succeeds; FALSE otherwise. - - - - Neutral primary language ID. - - - - - US-English primary language ID. - - - - - Neutral sublanguage ID. - - - - - US-English sublanguage ID. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID is used primarily for EXEs. If an executable has a resource of type RT_MANIFEST, - ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will create a process default activation context for the process. - The process default activation context will be used by all components running in the process. - CREATEPROCESS_MANIFEST_RESOURCE_ID can also used by DLLs. When Windows probe for dependencies, if the dll has - a resource of type RT_MANIFEST, ID CREATEPROCESS_MANIFEST_RESOURCE_ID, Windows will use that manifest as the - dependency. - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID is used primarily for DLLs. It should be used if the dll wants private - dependencies other than the process default. For example, if an dll depends on comctl32.dll version 6.0.0.0. - It should have a resource of type RT_MANIFEST, ID ISOLATIONAWARE_MANIFEST_RESOURCE_ID to depend on comctl32.dll - version 6.0.0.0, so that even if the process executable wants comctl32.dll version 5.1, the dll itself will still - use the right version of comctl32.dll. - - - - - When ISOLATION_AWARE_ENABLED is defined, Windows re-defines certain APIs. For example LoadLibraryExW - is redefined to IsolationAwareLoadLibraryExW. - - - - - Resource manifest type. - - - - - CREATEPROCESS_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_MANIFEST_RESOURCE_ID - - - - - ISOLATIONAWARE_NOSTATICIMPORT_MANIFEST_RESOURCE_ID - - - - - Copies the contents of a source memory block to a destination memory block, and supports overlapping source and destination memory blocks. - - A pointer to the starting address of the copied block's destination. - A pointer to the starting address of the block of memory to copy. - The size of the block of memory to copy, in bytes. - - - - A resource load exception. - - - - - The Win32 exception from a resource enumeration function. - - - - - A new resource load exception. - - Error message. - The inner exception thrown within a single resource. - The outer exception from the Win32 API. - - - - A combined message of the inner and outer exception. - - - - - An embedded SxS manifest. - - - - - Embedded XML manifest. - - - - - Manifest type. - - - - - An existing embedded manifest resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new executable CreateProcess manifest. - - - - - A new executable manifest. - - Manifest type. - - - - Read the resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the resource to a binary stream. - - Binary stream. - - - - Load a manifest resource from an executable file. - - Name of an executable file (.exe or .dll). - Manifest resource type. - - - - Extended menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write the menu template. - - Binary stream. - - - - String representation of the menu in the MENUEX format. - - String representation of the menu. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of extended menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - A command menu item. - - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - An extended popup menu item. - - - - - Sub menu items. - - - - - An extended popup menu item. - - - - - Read an extended popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write the menu item to a binary stream. - - Binary stream. - - - - String representation in the MENUEX format. - - String representation. - - - - A generic resource. - - - - - Menu template. - - - - - A structured menu resource. - - - - - A structured menu resource embedded in an executable module. - - Module handle. - Resource handle. - Type of resource. - Resource name. - Language id. - Resource size. - - - - Read a menu resource. - - Module handle. - Pointer to the beginning of a resource. - Pointer to the end of the resource. - - - - Write the menu resource to a binary stream. - - Binary stream. - - - - String representation of the menu resource in the MENU format. - - String representation of the menu resource. - - - - Standard menu template. - - - - - Menu items. - - - - - Read the menu template. - - Address in memory. - - - - Write menu template to a binary stream. - - Binary stream. - - - - String representation of the menu in the MENU format. - - String representation of the menu. - - - - A menu template header. - - - - - Read the menu template header. - - Address in memory. - - - - Write the menu to a binary stream. - - Binary stream. - - - - A base menu template item. - - - - - Menu item header. - - - - - Menu string. - - - - - Menu text. - - - - - Read the menu item. - - Address in memory. - End of the menu item structure. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - String representation in the MENU format. - - String representation. - - - - A collection of menu items. - - - - - A collection of menu items. - - - - - Read the menu item collection. - - Address in memory. - End of the menu item structure. - - - - Write the menu collection to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A command menu item. - - - - - Command menu id. - - - - - A command menu item. - - - - - Read a command menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - Returns true if the item is a separator. - - - - - String representation in the MENU format. - - Indent. - String representation. - - - - A popup menu item. - - - - - Sub menu items. - - - - - A popup menu item. - - - - - Read a popup menu item. - - Address in memory. - End of the menu item structure. - - - - Write menu item to a binary stream. - - Binary stream. - - - - String representation in the MENU format. - - String representation. - - - - A version resource. - - - - - Resource type. - - - - - Resource name. - - - - - Resource language. - - - - - Loaded binary nodule. - - - - - Pointer to the resource. - - - - - Resource size. - - - - - Version resource size in bytes. - - - - - Language ID. - - - - - Resource type. - - - - - String representation of the resource type. - - - - - Resource name. - - - - - A new resource. - - - - - A structured resource embedded in an executable module. - - Module handle. - Resource handle. - Resource type. - Resource name. - Language ID. - Resource size. - - - - Lock and read the resource. - - Module handle. - Resource handle. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - - - - Load a resource from an executable (.exe or .dll) file. - - An executable (.exe or .dll) file. - Resource name. - Resource type. - Resource language. - - - - Load a resource from an executable (.exe or .dll) module. - - An executable (.exe or .dll) module. - Resource type. - Resource name. - Resource language. - - - - Read a resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - Write the resource to a memory stream. - - Binary stream. - - - - Return resource data. - - Resource data. - - - - Save a resource. - - Name of an executable file (.exe or .dll). - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Language id. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - - - - Delete a resource from an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - - - - Save a resource to an executable (.exe or .dll) file. - - Path to an executable file. - Resource name. - Resource type. - Resource language. - Resource data. - - - - Save a batch of resources to a given file. - - Path to an executable file. - The resources to write. - - - - A resource Id. - There're two types of resource Ids, reserved integer numbers (eg. RT_ICON) and custom string names (eg. "CUSTOM"). - - - - - A resource identifier. - - A integer or string resource id. - - - - A resource identifier. - - A integer resource id. - - - - A well-known resource-type identifier. - - A well known resource type. - - - - A custom resource identifier. - - - - - - Resource Id. - - - If the resource Id is a string, it will be copied. - - - - - String representation of a resource type name. - - - - - An enumerated resource type for built-in resource types only. - - - - - Returns true if the resource is an integer resource. - - - - - Returns true if the resource is an integer resource. - - Resource pointer. - - - - Resource Id in a string format. - - - - - String representation of the resource Id. - - Resource name. - - - - Resource Id hash code. - Resource Ids of the same type have the same hash code. - - Resource Id. - - - - Compares two resource Ids by value. - - Resource Id. - True if both resource Ids represent the same resource. - - - - Resource info manager. - - - - - A dictionary of resources, the key is the resource type, eg. "REGISTRY" or "16" (version). - - - - - A shortcut for available resource types. - - - - - A new resource info. - - - - - Unload the previously loaded module. - - - - - Load an executable or a DLL and read its resources. - - Source filename. - - - - Enumerate resource types. - - Module handle. - Resource type. - Additional parameter. - TRUE if successful. - - - - Enumerate resource names within a resource by type - - Module handle. - Resource type. - Resource name. - Additional parameter. - TRUE if successful. - - - - Create a resource of a given type. - - Module handle. - Pointer to the resource in memory. - Resource type. - Resource name. - Language ID. - Size of resource. - A specialized or a generic resource. - - - - Enumerate resource languages within a resource by name - - Module handle. - Resource type. - Resource name. - Language ID. - Additional parameter. - TRUE if successful. - - - - Save resource to a file. - - Target filename. - - - - Dispose resource info object. - - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - A collection of resources. - - Resource type. - A collection of resources of a given type. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - Enumerates all resources within this resource info collection. - - Resources enumerator. - - - - A resource table header. - - - - - Resource table header. - - - - - Resource table key. - - - - - Resource table key. - - - - - Resource header. - - - - - A new resource table header. - - - - - An resource table header with a specific key. - - resource key - - - - An existing resource table. - - Pointer to resource table data. - - - - Read the resource header, return a pointer to the end of it. - - Top of header. - End of header, after the key, aligned at a 32 bit boundary. - - - - Write the resource table. - - Binary stream. - - - - String representation. - - String representation. - - - - String representation. - - Indent. - String representation. - - - - Resource utilities. - - - - - Align an address to a 4-byte boundary. - - Address in memory. - 4-byte aligned pointer. - - - - Align a pointer to a 4-byte boundary. - - Pointer to an address in memory. - 4-byte aligned pointer. - - - - Pad data to a WORD. - - Binary stream. - New position within the binary stream. - - - - Pad data to a DWORD. - - Binary stream. - New position within the binary stream. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Returns the high WORD from a DWORD value. - - WORD value. - High WORD. - - - - Write a value at a given position. - Used to write a size of data in an earlier located header. - - Binary stream. - Value to write. - Address to write the value at. - - - - Pad bytes. - - Binary stream. - Number of bytes to write. - New position within the stream. - - - - Neutral language ID. - - - - - US-English language ID. - - - - - Make a language ID from a primary language ID (low-order 10 bits) and a sublanguage (high-order 6 bits). - - Primary language ID. - Sublanguage ID. - Microsoft language ID. - - - - Return the primary language ID from a Microsoft language ID. - - Microsoft language ID - primary language ID (low-order 10 bits) - - - - Return the sublanguage ID from a Microsoft language ID. - - Microsoft language ID. - Sublanguage ID (high-order 6 bits). - - - - Returns the memory representation of an object. - - Object type. - Data. - Object's representation in memory. - - - - Get a collection of flags from a flag value. - - Flag collection type. - Flag value. - Collection of flags. - - - - Get a string representation of flags. - - Flag collection type. - Flag vlaue - String representation of flags in the f1 | ... | fn format. - - - - This structure depicts the organization of data in a file-version resource. - It contains version information that can be displayed for a particular language and code page. - http://msdn.microsoft.com/en-us/library/aa908808.aspx - - - - - Resource strings. - - - - - A new string file-version resource. - - - - - An existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - - - - Read an existing string file-version resource. - - Pointer to the beginning of a string file-version resource. - Pointer to the end of the string file-version resource. - - - - Write the string file-version resource to a binary stream. - - Binary stream. - - - - Default (first) string table. - - - - - Indexed string table. - - Key. - A string table at a given index. - - - - String representation of StringFileInfo. - - Indent. - String in the StringFileInfo format. - - - - A string, RT_STRING resource. - Each string resource block has 16 strings, each represented as an ordered pair - (length, text). Length is a WORD that specifies the size, in terms of the number of characters, - in the text that follows. Text follows length and contains the string in Unicode without the - NULL terminating character. There may be no characters in text, in which case length is zero. - - - - - String collection in this resource. - - - - - Returns a string of a given Id. - - String Id. - A string of a given Id. - - - - A new string resource. - - - - - A new string resource of a given block id. - - Block id. - - - - A new string resource of a given block id. - - Block id. - - - - An existing string resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A string with ID, stringId, is located in the block with ID given by the following formula. - http://support.microsoft.com/kb/q196774/ - - - - - String table block id. - - - - - Read the strings. - - Handle to a module. - Pointer to the beginning of the string table. - Address of the end of the string table. - - - - String representation of the strings resource. - - - - - - This structure depicts the organization of data in a file-version resource. It contains language - and code page formatting information for the strings. A code page is an ordered character set. - See http://msdn.microsoft.com/en-us/library/aa909192.aspx for more information. - - - - - Resource strings. - - - - - A new string table. - - - - - A new string table. - - String table key. - - - - An existing string table. - - Pointer to the beginning of the table. - - - - Read a string table. - - Pointer to the beginning of the string table. - Pointer to the end of the string table. - - - - Write the string table to a binary stream. - - Binary stream. - Last unpadded position. - - - - The four most significant digits of the key represent the language identifier. - Each Microsoft Standard Language identifier contains two parts: the low-order 10 bits - specify the major language, and the high-order 6 bits specify the sublanguage. - - - - - The four least significant digits of the key represent the code page for which the data is formatted. - - - - - Returns an entry within the string table. - - Key. - An entry within the string table. - - - - String representation of the string table. - - Indent. - String representation of the strings table. - - - - This structure depicts the organization of data in a file-version resource. It contains a string - that describes a specific aspect of a file, such as a file's version, its copyright notices, - or its trademarks. - http://msdn.microsoft.com/en-us/library/aa909025.aspx - - - - - The value is always stored double-null-terminated. - - - - - When set to true the length in the header will also contain the padding bytes when writing to a stream. - The MSDN reference (http://www.webcitation.org/6zBLYbvww) does not clarify which variant is 'right'. - - - - - String resource header. - - - - - Key. - - - - - String value (removing the double-null-terminator). - - - - - Value. - - - - - A new string resource. - - Key. - - - - An existing string resource. - - Pointer to the beginning of a string resource. - - - - Read a string resource. - - Pointer to the beginning of a string resource. - - - - Write a string resource to a binary stream. - - Binary stream. - - - - User32.dll functions. - - - - - Contains information about an icon or a cursor. - - - - - Specifies whether this structure defines an icon or a cursor. - A value of TRUE specifies an icon; FALSE specifies a cursor. - - - - - Specifies the x-coordinate of a cursor's hot spot. If this structure defines an icon, the hot spot is - always in the center of the icon, and this member is ignored. - - - - - Specifies the y-coordinate of the cursor's hot spot. If this structure defines an icon, the hot spot - is always in the center of the icon, and this member is ignored. - - - - - Specifies the icon bitmask bitmap. - - - - - Handle to the icon color bitmap. - - - - - Retrieve a handle to a device context (DC) for the client area of a specified window or for the entire screen. - - A handle to the window whose DC is to be retrieved. If this value is NULL, GetDC retrieves the DC for the entire screen. - - If the function succeeds, the return value is a handle to the DC for the specified window's client area. - If the function fails, the return value is NULL. - - - - - Releases a device context (DC), freeing it for use by other applications. - - A handle to the window whose DC is to be released. - A handle to the DC to be released. - - The return value indicates whether the DC was released. If the DC was released, the return value is 1. - If the DC was not released, the return value is zero. - - - - - The DIALOGTEMPLATE structure defines the dimensions and style of a dialog box. - This structure, always the first in a standard template for a dialog box, - also specifies the number of controls in the dialog box and therefore specifies - the number of subsequent DIALOGITEMTEMPLATE structures in the template. - - - - - Specifies the style of the dialog box. - - - - - Extended styles for a window. - - - - - Specifies the number of items in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - The DIALOGITEMTEMPLATE structure defines the dimensions and style of a control in a dialog box. - - - - - Specifies the style of the control. - - - - - Extended styles for a window. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the control. - - - - - Specifies the width, in dialog box units, of the control. - - - - - Specifies the height, in dialog box units, of the control. - - - - - Specifies the control identifier. - - - - - An extended dialog box template begins with a DIALOGEXTEMPLATE header that describes - the dialog box and specifies the number of controls in the dialog box. For each - control in a dialog box, an extended dialog box template has a block of data that - uses the DIALOGEXITEMTEMPLATE format to describe the control. - - - - - Specifies the version number of the extended dialog box template. This member must be 1. - - - - - Indicates whether a template is an extended dialog box template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the number of controls in the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - A control entry in an extended dialog template. - - - - - Specifies the help context identifier for the dialog box window. When the system - sends a WM_HELP message, it passes this value in the wContextId member of the - HELPINFO structure. - - - - - Specifies extended windows styles. - - - - - Specifies the style of the dialog box. - - - - - Specifies the x-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the y-coordinate, in dialog box units, of the upper-left corner of the dialog box. - - - - - Specifies the width, in dialog box units, of the dialog box. - - - - - Specifies the height, in dialog box units, of the dialog box. - - - - - Specifies the control identifier. - - - - - Window styles. - http://msdn.microsoft.com/en-us/library/ms632600(VS.85).aspx - - - - - Creates an overlapped window. An overlapped window has a title bar and - a border. Same as the WS_TILED style. - - - - - Creates a pop-up window. This style cannot be used with the WS_CHILD style. - - - - - Creates a child window. A window with this style cannot have - a menu bar. This style cannot be used with the WS_POPUP style. - - - - - Creates a window that is initially minimized. Same as the WS_ICONIC style. - - - - - Creates a window that is initially visible. - - - - - Creates a window that is initially disabled. A disabled window cannot receive - input from the user. - - - - - Clips child windows relative to each other; that is, when a particular - child window receives a WM_PAINT message, the WS_CLIPSIBLINGS style clips - all other overlapping child windows out of the region of the child window - to be updated. If WS_CLIPSIBLINGS is not specified and child windows overlap, - it is possible, when drawing within the client area of a child window, to draw - within the client area of a neighboring child window. - - - - - Excludes the area occupied by child windows when drawing occurs - within the parent window. This style is used when creating the parent window. - - - - - Creates a window that is initially maximized. - - - - - Creates a window that has a title bar (includes the WS_BORDER style). - - - - - Creates a window that has a thin-line border. - - - - - Creates a window that has a border of a style typically used with dialog - boxes. A window with this style cannot have a title bar. - - - - - Creates a window that has a vertical scroll bar. - - - - - Creates a window that has a horizontal scroll bar. - - - - - Creates a window that has a window menu on its title bar. The WS_CAPTION - style must also be specified. - - - - - Creates a window that has a sizing border. Same as the WS_SIZEBOX style. - - - - - Specifies the first control of a group of controls. The group consists of this - first control and all controls defined after it, up to the next control with - the WS_GROUP style. The first control in each group usually has the WS_TABSTOP - style so that the user can move from group to group. The user can subsequently - change the keyboard focus from one control in the group to the next control in - the group by using the direction keys. - - - - - Specifies a control that can receive the keyboard focus when the user presses - the TAB key. Pressing the TAB key changes the keyboard focus to the next - control with the WS_TABSTOP style. - - - - - Dialog styles. - http://msdn.microsoft.com/en-us/library/ms644994(VS.85).aspx - - - - - Specifying this style in the dialog template tells Windows that the dtX and dtY values - of the DIALOGTEMPLATE struct are relative to the screen origin, not the owner of the - dialog box. - - - - - Create a dialog box with the WS_EX_TOPMOST flag. This flag cannot be combined with the - DS_CONTROL style. This flag is obsolete and is included for compatibility with 16-bit - versions of Windows. - - - - - Applies to 16-bit applications only. This style directs edit controls in the dialog - box to allocate memory from the application data segment. Otherwise, edit controls - allocate storage from a global memory object. - - - - - Indicates that the header of the dialog box template contains additional data specifying - the font to use for text in the client area and controls of the dialog box. - - - - - Creates a dialog box with a modal dialog-box frame that can be combined with a title - bar and window menu by specifying the WS_CAPTION and WS_SYSMENU styles. - - - - - Suppresses WM_ENTERIDLE messages that the system would otherwise send to the owner of the - dialog box while the dialog box is displayed. - - - - - Causes the system to use the SetForegroundWindow function to bring the dialog - box to the foreground. - - - - - Gives the dialog box a nonbold font and draws three-dimensional borders around - control windows in the dialog box. - - - - - Causes the dialog box to use the SYSTEM_FIXED_FONT instead of the default SYSTEM_FONT. - This is a monospace font compatible with the System font in 16-bit versions of Windows - earlier than 3.0. - - - - - Creates the dialog box even if errors occur — for example, if a child window cannot be - created or if the system cannot create a special data segment for an edit control. - - - - - Creates a dialog box that works well as a child window of another dialog box, - much like a page in a property sheet. This style allows the user to tab among - the control windows of a child dialog box, use its accelerator keys, and so on. - - - - - Centers the dialog box in the working area; that is, the area not obscured by the tray. - - - - - Centers the dialog box on the mouse cursor. - - - - - Includes a question mark in the title bar of the dialog box. When the user clicks the - question mark, the cursor changes to a question mark with a pointer. If the user then - clicks a control in the dialog box, the control receives a WM_HELP message. The control - should pass the message to the dialog box procedure, which should call the function - using the HELP_WM_HELP command. The help application displays a pop-up window that - typically contains help for the control. - - - - - Indicates that the dialog box should use the system font. - - - - - - - - - - Extended dialog styles. - - - - - Creates a window that has a double border; the window can, optionally, be created - with a title bar by specifying the WS_CAPTION style in the dwStyle parameter. - - - - - Specifies that a child window created with this style does not send the WM_PARENTNOTIFY - message to its parent window when it is created or destroyed. - - - - - Specifies that a window created with this style should be placed above all non-topmost - windows and should stay above them, even when the window is deactivated. To add or remove - this style, use the SetWindowPos function. - - - - - Specifies that a window created with this style accepts drag-drop files. - - - - - Specifies that a window created with this style should not be painted until siblings beneath - the window (that were created by the same thread) have been painted. The window appears - transparent because the bits of underlying sibling windows have already been painted. - - - - - Creates a multiple-document interface (MDI) child window. - - - - - Creates a tool window; that is, a window intended to be used as a floating toolbar. - A tool window has a title bar that is shorter than a normal title bar, and the - window title is drawn using a smaller font. A tool window does not appear in - the taskbar or in the dialog that appears when the user presses ALT+TAB. If a - tool window has a system menu, its icon is not displayed on the title bar. However, - you can display the system menu by right-clicking or by typing ALT+SPACE. - - - - - Specifies that a window has a border with a raised edge. - - - - - Specifies that a window has a border with a sunken edge. - - - - - Includes a question mark in the title bar of the window. When the user clicks the question mark, - the cursor changes to a question mark with a pointer. If the user then clicks a child window, - the child receives a WM_HELP message. The child window should pass the message to the parent - window procedure, which should call the WinHelp function using the HELP_WM_HELP command. The - Help application displays a pop-up window that typically contains help for the child window. - - - - - The window has generic "right-aligned" properties. This depends on the window class. This style has - an effect only if the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment; otherwise, the style is ignored. Using the WS_EX_RIGHT style for static or edit controls - has the same effect as using the SS_RIGHT or ES_RIGHT style, respectively. Using this style with - button controls has the same effect as using BS_RIGHT and BS_RIGHTBUTTON styles. - - - - - Creates a window that has generic left-aligned properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading-order - alignment, the window text is displayed using right-to-left reading-order properties. - For other languages, the style is ignored. - - - - - The window text is displayed using left-to-right reading-order properties. This is the default. - - - - - If the shell language is Hebrew, Arabic, or another language that supports reading order - alignment, the vertical scroll bar (if present) is to the left of the client area. For other - languages, the style is ignored. - - - - - Vertical scroll bar (if present) is to the right of the client area. This is the default. - - - - - The window itself contains child windows that should take part in dialog box navigation. - If this style is specified, the dialog manager recurses into children of this window when - performing navigation operations such as handling the TAB key, an arrow key, or a - keyboard mnemonic. - - - - - Creates a window with a three-dimensional border style intended to be used for items that - do not accept user input. - - - - - Forces a top-level window onto the taskbar when the window is visible. - - - - - Combines the WS_EX_CLIENTEDGE and WS_EX_WINDOWEDGE styles. - - - - - Combines the WS_EX_WINDOWEDGE, WS_EX_TOOLWINDOW, and WS_EX_TOPMOST styles. - - - - - Windows 2000/XP: Creates a layered window. Note that this cannot be used for child - windows. Also, this cannot be used if the window has a class style of either CS_OWNDC - or CS_CLASSDC. - - - - - Windows 2000/XP: A window created with this style does not pass its window layout to its child windows. - - - - - Arabic and Hebrew versions of Windows 98/Me, Windows 2000/XP: Creates a window whose - horizontal origin is on the right edge. Increasing horizontal values advance to the left. - - - - - Windows XP: Paints all descendants of a window in bottom-to-top painting order - using double-buffering. For more information, see Remarks. This cannot be used - if the window has a class style of either CS_OWNDC or CS_CLASSDC. - - - - - Windows 2000/XP: A top-level window created with this style does not become the foreground - window when the user clicks it. The system does not bring this window to the foreground - when the user minimizes or closes the foreground window. - - - - - Possible DIALOGEXITEMTEMPLATE WindowClass ordinals. - - - - - A button. - - - - - An edit box. - - - - - A static control. - - - - - A list box. - - - - - A scroll bar. - - - - - A combo box. - - - - - Static control styles. - A static control specifies the STATIC class, appropriate window style constants, - and a combination of the following static control styles. - http://msdn.microsoft.com/en-us/library/bb760773(VS.85).aspx - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next left-aligned - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and centers the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next centered - line. Words that are longer than the width of the control are truncated. - - - - - Specifies a simple rectangle and right-aligns the text in the rectangle. - The text is formatted before it is displayed. Words that extend past the - end of a line are automatically wrapped to the beginning of the next - right-aligned line. Words that are longer than the width of the control - are truncated. - - - - - Specifies an icon to be displayed in the dialog box. If the control is created - as part of a dialog box, the text is the name of an icon (not a filename) defined - elsewhere in the resource file. If the control is created via CreateWindow or a - related function, the text is the name of an icon (not a filename) defined in the - resource file associated with the module specified by the hInstance parameter to - CreateWindow. The icon can be an animated cursor. - - - - - Specifies a rectangle filled with the current window frame color. - This color is black in the default color scheme. - - - - - Specifies a rectangle filled with the current screen background color. - This color is gray in the default color scheme. - - - - - Specifies a rectangle filled with the current window background color. This color is white - in the default color scheme. - - - - - Specifies a box with a frame drawn in the same color as the window frames. - This color is black in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the screen background (desktop). - This color is gray in the default color scheme. - - - - - Specifies a box with a frame drawn with the same color as the window background. This color is - white in the default color scheme. - - - - - - - - - - Specifies a simple rectangle and displays a single line of left-aligned text in the rectangle. - The text line cannot be shortened or altered in any way. Also, if the control is disabled, - the control does not gray its text. - - - - - Specifies a simple rectangle and left-aligns the text in the rectangle. - Tabs are expanded, but words are not wrapped. Text that extends past the - end of a line is clipped. - - - - - Specifies that the owner of the static control is responsible for drawing - the control. The owner window receives a WM_DRAWITEM message whenever the - control needs to be drawn. - - - - - Specifies that a bitmap is to be displayed in the static control. - The text is the name of a bitmap (not a filename) defined elsewhere in the - resource file. The style ignores the nWidth and nHeight parameters; the control - automatically sizes itself to accommodate the bitmap. - - - - - Specifies that an enhanced metafile is to be displayed in the static control. - The text is the name of a metafile. An enhanced metafile static control has a - fixed size; the metafile is scaled to fit the static control's client area. - - - - - Draws the top and bottom edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the left and right edges of the static control using the EDGE_ETCHED edge style. - - - - - Draws the frame of the static control using the EDGE_ETCHED edge style. - - - - - Windows 2000: A composite style bit that results from using the OR operator on - SS_* style bits. Can be used to mask out valid SS_* bits from a given bitmask. - Note that this is out of date and does not correctly include all valid styles. - Thus, you should not use this style. - - - - - Windows XP or later: Adjusts the bitmap to fit the size of the static control. - For example, changing the locale can change the system font, and thus controls - might be resized. If a static control had a bitmap, the bitmap would no longer - fit the control. This style bit dictates automatic redimensioning of bitmaps - to fit their controls. - - - - - Prevents interpretation of any ampersand characters in the control's text as - accelerator prefix characters. These are displayed with the ampersand removed and - the next character in the string underlined. This static control style may be - included with any of the defined static controls. You can combine SS_NOPREFIX - with other styles. This can be useful when filenames or other strings that may - contain an ampersand must be displayed in a static control in a dialog box. - - - - - Sends the parent window STN_CLICKED, STN_DBLCLK, STN_DISABLE, and STN_ENABLE - notification messages when the user clicks or double-clicks the control. - - - - - Specifies that a bitmap is centered in the static control that contains it. - The control is not resized, so that a bitmap too large for the control will - be clipped. If the static control contains a single line of text, the text - is centered vertically in the client area of the control. - - - - - Specifies that the lower right corner of a static control with the SS_BITMAP - or SS_ICON style is to remain fixed when the control is resized. Only the top - and left sides are adjusted to accommodate a new bitmap or icon. - - - - - Specifies that the actual resource width is used and the icon is loaded using - LoadImage. SS_REALSIZEIMAGE is always used in conjunction with SS_ICON. - - - - - Draws a half-sunken border around a static control. - - - - - Microsoft Windows 2000: Specifies that the static control duplicates the - text-displaying characteristics of a multiline edit control. Specifically, the - average character width is calculated in the same manner as with an edit control, - and the function does not display a partially visible last line. - - - - - Microsoft Windows NT or later: If the end of a string does not fit in the rectangle, - it is truncated and ellipses are added. If a word that is not at the end of the string - goes beyond the limits of the rectangle, it is truncated without ellipses. Using this - style will force the control’s text to be on one line with no word wrap. Compare with - SS_PATHELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Replaces characters in the middle of the string with ellipses so - that the result fits in the specified rectangle. If the string contains backslash (\) - characters, SS_PATHELLIPSIS preserves as much as possible of the text after the last - backslash. Using this style will force the control’s text to be on one line with no - word wrap. Compare with SS_ENDELLIPSIS and SS_WORDELLIPSIS. - - - - - Windows NT or later: Truncates any word that does not fit in the rectangle and adds ellipses. - Using this style will force the control’s text to be on one line with no word wrap. - - - - - - - - - - Push button styles. - http://msdn.microsoft.com/en-us/library/bb775951(VS.85).aspx - - - - - Creates a push button that posts a WM_COMMAND message to the owner window when the - user selects the button. - - - - - Creates a push button that behaves like a BS_PUSHBUTTON style button, but has a distinct - appearance. If the button is in a dialog box, the user can select the button by pressing - the ENTER key, even when the button does not have the input focus. This style is useful - for enabling the user to quickly select the most likely (default) option. - - - - - Creates a small, empty check box with text. By default, the text is displayed to - the right of the check box. To display the text to the left of the check box, - combine this flag with the BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). - - - - - Creates a button that is the same as a check box, except that the check state - automatically toggles between checked and cleared each time the user selects the - check box. - - - - - Creates a small circle with text. By default, the text is displayed to the right of the - circle. To display the text to the left of the circle, combine this flag with the - BS_LEFTTEXT style (or with the equivalent BS_RIGHTBUTTON style). Use radio buttons for - groups of related, but mutually exclusive choices. - - - - - Creates a button that is the same as a check box, except that the box can be grayed - as well as checked or cleared. Use the grayed state to show that the state of the - check box is not determined. - - - - - Creates a button that is the same as a three-state check box, except that the box - changes its state when the user selects it. The state cycles through checked, - indeterminate, and cleared. - - - - - Creates a rectangle in which other controls can be grouped. Any text associated with - this style is displayed in the rectangle's upper left corner. - - - - - Obsolete, but provided for compatibility with 16-bit versions of Windows. Applications - should use BS_OWNERDRAW instead. - - - - - Creates a button that is the same as a radio button, except that when the user selects it, - the system automatically sets the button's check state to checked and automatically sets - the check state for all other buttons in the same group to cleared. - - - - - - - - - - Creates an owner-drawn button. The owner window receives a WM_DRAWITEM message when a visual - aspect of the button has changed. Do not combine the BS_OWNERDRAW style with any other - button styles. - - - - - Microsoft Windows 2000: A composite style bit that results from using the OR operator on - BS_* style bits. It can be used to mask out valid BS_* bits from a given bitmask. - - - - - Places text on the left side of the radio button or check box when combined with a radio button - or check box style. Same as the BS_RIGHTBUTTON style. - - - - - Specifies that the button displays text. - - - - - Specifies that the button displays an icon. - - - - - Specifies that the button displays a bitmap. See the Remarks section for its interaction - with BS_ICON. - - - - - Left-justifies the text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is left justified on the right side - of the check box or radio button. - - - - - Right-justifies text in the button rectangle. However, if the button is a check box or radio - button that does not have the BS_RIGHTBUTTON style, the text is right justified on the right - side of the check box or radio button. - - - - - Centers text horizontally in the button rectangle. - - - - - Places text at the top of the button rectangle. - - - - - Places text at the bottom of the button rectangle. - - - - - Places text in the middle (vertically) of the button rectangle. - - - - - Makes a button (such as a check box, three-state check box, or radio button) look and - act like a push button. The button looks raised when it isn't pushed or checked, and - sunken when it is pushed or checked. - - - - - Wraps the button text to multiple lines if the text string is too long to fit on a - single line in the button rectangle. - - - - - Enables a button to send BN_KILLFOCUS and BN_SETFOCUS notification messages to its - parent window. - - - - - Specifies that the button is two-dimensional; it does not use the default - shading to create a 3-D image. - - - - - Microsoft Windows Vista and Version 6.00. Creates a split button that behaves like a - BS_PUSHBUTTON style button, but also has a distinctive appearance. If the split button - is in a dialog box, the user can select the split button by pressing the ENTER key, even - when the split button does not have the input focus. This style is useful for enabling - the user to quickly select the most likely (default) option. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like a - BS_PUSHBUTTON style button, but the command link button has a green arrow on the left pointing - to the button text. A caption for the button text can be set by sending the BCM_SETNOTE - message to the button. - - - - - Microsoft Windows Vista and Version 6.00. Creates a command link button that behaves like - a BS_PUSHBUTTON style button. If the button is in a dialog box, the user can select the - command link button by pressing the ENTER key, even when the command link button does - not have the input focus. This style is useful for enabling the user to quickly select - the most likely (default) option. - - - - - Edit control styles. - http://msdn.microsoft.com/en-us/library/bb775464(VS.85).aspx - - - - - Aligns text with the left margin. - - - - - Windows 98/Me, Windows 2000/XP: Centers text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Centers text in a multiline edit control. - - - - - Windows 98/Me, Windows 2000/XP: Right-aligns text in a single-line or multiline edit control. - Windows 95, Windows NT 4.0 and earlier: Right aligns text in a multiline edit control. - - - - - Designates a multiline edit control. The default is single-line edit control. - - - - - Converts all characters to uppercase as they are typed into the edit control. - - - - - Converts all characters to lowercase as they are typed into the edit control. - - - - - Displays an asterisk (*) for each character typed into the edit control. - This style is valid only for single-line edit controls. - - - - - Automatically scrolls text up one page when the user presses the ENTER key on - the last line. - - - - - Automatically scrolls text to the right by 10 characters when the user types - a character at the end of the line. When the user presses the ENTER key, - the control scrolls all text back to position zero. - - - - - Negates the default behavior for an edit control. - - - - - Converts text entered in the edit control. - - - - - Prevents the user from typing or editing text in the edit control. - - - - - Specifies that a carriage return be inserted when the user presses the - ENTER key while entering text into a multiline edit control in a dialog box. - If you do not specify this style, pressing the ENTER key has the same effect - as pressing the dialog box's default push button. This style has no effect - on a single-line edit control. - - - - - Allows only digits to be entered into the edit control. - - - - - Defines the header for a menu template. - A complete menu template consists of a header and one or more menu item lists. - - - - - Specifies the version number. This member must be zero. - - - - - Specifies the offset, in bytes, from the end of the header. - The menu item list begins at this offset. Usually, this member is zero, and the menu - item list follows immediately after the header. - - - - - Defines a menu item in a menu template. - - - - - Specifies one or more of the following predefined menu options that control the appearance of the menu item. - TODO - - - - - Defines the header for an extended menu template. - - - - - Template version number. This member must be 1 for extended menu templates. - - - - - Offset of the first MENUEXITEMTEMPLATE structure, relative to the end of - this structure member. If the first item definition immediately follows the - dwHelpId member, this member should be 4. - - - - - Drop-down menu or submenu item. - - - - - Menu item type. This member can be a combination of the type (beginning with MFT) values - listed with the MENUITEMINFO structure. - - - - - Menu item state. This member can be a combination of the state (beginning with MFS) values - listed with the MENUITEMINFO structure. - - - - - Menu item identifier. This is an application-defined value that identifies the menu item. - - - - - Value specifying whether the menu item is the last item in the menu bar, drop-down menu, - submenu, or shortcut menu and whether it is an item that opens a drop-down menu or submenu. - - - - - Specifies one or more of the following predefined menu options that control the - appearance of the menu item. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item is initially inactive and drawn with a gray effect. - - - - - - - - - - - - - - - Indicates that the menu item has a check mark next to it. - - - - - - - - - - - - - - - - - - - - Indicates that the owner window of the menu is responsible for drawing all visual - aspects of the menu item, including highlighted, selected, and inactive states. - This option is not valid for an item in a menu bar. - - - - - Indicates that the item is one that opens a drop-down menu or submenu. - - - - - Indicates that the menu item is placed in a new column. The old and new columns - are separated by a bar. - - - - - Indicates that the menu item is placed in a new column. - - - - - - - - - - - - - - - - - - - - - - - - - Indicates that the menu item has a vertical separator to its left. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Specifies whether the menu item is the last item in the menu bar, drop-down menu, submenu, or shortcut - menu and whether it is an item that opens a drop-down menu or submenu. This member can be zero or more - of these values. - - - - - Defines the last menu item in the menu bar, drop-down menu, submenu, or shortcut menu. - - - - - Defines a item that opens a drop-down menu or submenu. Subsequent structures define menu - items in the corresponding drop-down menu or submenu. - - - - - Defines an accelerator key used in an accelerator table. - http://msdn.microsoft.com/en-us/library/ms646340(VS.85).aspx - - - - - Accelerator flags. - - - - - Accelerator key. This member can be either a virtual-key code or an ASCII character code. - - - - - Accelerator identifier. - - - - - Flags, fVirt field of the Accelerator table structure. - - - - - Virtual key. - - - - - Specifies that no top-level menu item is highlighted when the accelerator is used. - This is useful when defining accelerators for actions such as scrolling that do not - correspond to a menu item. If NOINVERT is omitted, a top-level menu item will be - highlighted (if possible) when the accelerator is used. - - - - - Causes the accelerator to be activated only if the SHIFT key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the CONTROL key is down. - Applies only to virtual keys. - - - - - Causes the accelerator to be activated only if the ALT key is down. - Applies only to virtual keys. - - - - - Virtual key definitions. - - - - - Standard virtual left mouse button. - - - - - Standard virtual right mouse button. - - - - - Ctrl-Break / Ctrl-C. - - - - - Standard virtual middle mouse button. - - - - - - - - - - - - - - - Backspace. - - - - - Tab. - - - - - Delete. - - - - - Return. - - - - - Shift. - - - - - Control. - - - - - Menu. - - - - - Pause. - - - - - Caps lock. - - - - - - - - - - - - - - - - - - - - - - - - - Escape. - - - - - - - - - - - - - - - - - - - - - - - - - Space. - - - - - - - - - - - - - - - End. - - - - - Home. - - - - - Left arrow. - - - - - Up arrow. - - - - - Right arrow. - - - - - Down arrow. - - - - - - - - - - Print Screen. - - - - - - - - - - - - - - - Insert. - - - - - Delete. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - NEC PC-9800 keyboard '=' key on numpad. - - - - - Fujitsu/OASYS keyboard 'Dictionary' key. - - - - - Fujitsu/OASYS keyboard 'Unregister word' key. - - - - - Fujitsu/OASYS keyboard 'Register word' key. - - - - - Fujitsu/OASYS keyboard 'Left OYAYUBI' key. - - - - - Fujitsu/OASYS keyboard 'Right OYAYUBI' key. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ';:' for US - - - - - '+' any country - - - - - ',' any country - - - - - '-' any country - - - - - '.' any country - - - - - '/?' for US - - - - - '`~' for US - - - - - '[{' for US - - - - - '\|' for US - - - - - ']}' for US - - - - - ''"' for US - - - - - - - - - - 'AX' key on Japanese AX kbd - - - - - "<>" or "\|" on RT 102-key kbd. - - - - - Help key on ICO - - - - - 00 key on ICO - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Contains information about an individual font in a font resource group. - - - - - Specifies a user-defined version number for the resource data that tools can - use to read and write resource files. - - - - - Specifies the size of the file, in bytes. - - - - - Contains a 60-character string with the font supplier's copyright information. - - - - - Specifies the type of font file. - - - - - Specifies the point size at which this character set looks best. - - - - - Specifies the vertical resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the horizontal resolution, in dots per inch, at which this character set was digitized. - - - - - Specifies the distance from the top of a character definition cell to the baseline of the - typographical font. - - - - - Specifies the amount of leading inside the bounds set by the dfPixHeight member. Accent marks and - other diacritical characters can occur in this area. - - - - - Specifies the amount of extra leading that the application adds between rows. - - - - - Specifies an italic font if not equal to zero. - - - - - Specifies an underlined font if not equal to zero. - - - - - Specifies a strikeout font if not equal to zero. - - - - - Specifies the weight of the font in the range 0 through 1000. For example, 400 is roman and - 700 is bold. If this value is zero, a default weight is used. - - - - - Specifies the character set of the font. - - - - - Specifies the width of the grid on which a vector font was digitized. For raster fonts, - if the member is not equal to zero, it represents the width for all the characters in the - bitmap. If the member is equal to zero, the font has variable-width characters. - - - - - Specifies the height of the character bitmap for raster fonts or the height of the grid - on which a vector font was digitized. - - - - - Specifies the pitch and the family of the font. - - - - - Specifies the average width of characters in the font (generally defined as the width of - the letter x). This value does not include the overhang required for bold or italic characters. - - - - - Specifies the width of the widest character in the font. - - - - - Specifies the first character code defined in the font. - - - - - Specifies the last character code defined in the font. - - - - - Specifies the character to substitute for characters not in the font. - - - - - Specifies the character that will be used to define word breaks for text justification. - - - - - Specifies the number of bytes in each row of the bitmap. This value is always even so - that the rows start on word boundaries. For vector fonts, this member has no meaning. - - - - - Specifies the offset in the file to a null-terminated string that specifies a device name. - For a generic font, this value is zero. - - - - - Specifies the offset in the file to a null-terminated string that names the typeface. - - - - - This member is reserved. - - - - - This structure depicts the organization of data in a file-version resource. - It contains version information not dependent on a particular language and code page combination. - http://msdn.microsoft.com/en-us/library/aa909193.aspx - - - - - A hardware independent dictionary of language and code page identifier tables. - - - - - A new hardware independent dictionary of language and code page identifier tables. - - - - - An existing hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - - - - Read a hardware independent dictionary of language and code page identifier tables. - - Pointer to the beginning of data. - Pointer to the end of data. - - - - Write the hardware independent dictionary of language and code page identifier tables to a binary stream. - - Binary stream. - - - - The default language and code page identifier table. - - - - - Returns a language and code page identifier table. - - Language ID. - A language and code page identifier table. - - - - String representation of VarFileInfo. - - Indent. - String in the VarFileInfo format. - - - - This structure depicts the organization of data in a file-version resource. It typically contains a - list of language and code page identifier pairs that the version of the application or DLL supports. - http://msdn.microsoft.com/en-us/library/bb202818.aspx - - - - - A dictionary of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - - - - A new table of language and code page identifier pairs. - - Table key. - - - - An existing table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - Read a table of language and code page identifier pairs. - - Pointer to the beginning of the data. - - - - - Write the table of language and code page identifier pairs to a binary stream. - - Binary stream. - Last unpadded position. - - - - Returns a code page identifier for a given language. - - Language ID. - Code page identifier. - - - - String representation of the var table. - - Indent. - String representation of the var table. - - - - VS_VERSIONINFO - This structure depicts the organization of data in a file-version resource. It is the root structure - that contains all other file-version information structures. - http://msdn.microsoft.com/en-us/library/aa914916.aspx - - - - - The resource header. - - - - - A dictionary of resource tables. - - - - - An existing version resource. - - Module handle. - Resource ID. - Resource type. - Resource name. - Language ID. - Resource size. - - - - A new language-netural version resource. - - - - - Read a version resource from a previously loaded module. - - Module handle. - Pointer to the beginning of the resource. - Pointer to the end of the resource. - - - - String representation of the file version. - - - - - Gets or sets a bitmask that specifies the Boolean attributes of the file. - - - - - String representation of the protect version. - - - - - Write this version resource to a binary stream. - - Binary stream. - - - - Returns an entry within this resource table. - - Entry key. - A resource table. - - - - Returns an entry within this resource table. - - Entry index. - A resource table. - - - - Return string representation of the version resource. - - - - - - winver.h, version management functions, types and definitions - - - - - VS_VERSION signature. - - - - - VS_VERSION structure version. - - - - - VS_VERSION file flags mask. - - - - - VS_VERSION file flags. - - - - - The file contains debugging information. - - - - - The file is a prerelease development version, not a final commercial release. - - - - - PThe file has been modified somehow and is not identical to the original file - that shipped with the product. - - - - - The file was not built using standard release procedures. There should be data - in the file's "PrivateBuild" version information string. - - - - - The version information in this structure was not found inside the file, - but instead was created when needed based on the best information available. - Therefore, this structure's information may differ slightly from what the "real" - values are. - - - - - The file was built using standard release procedures, but is somehow different - from the normal file having the same version number. There should be data in the - file's "SpecialBuild" version information string. - - - - - VS_VERSION file OSs. - - - - - The operating system under which the file was designed to run could not be determined. - - - - - The file was designed to run under MS-DOS. - - - - - The file was designed to run under a 16-bit version of OS/2. - - - - - The file was designed to run under a 32-bit version of OS/2. - - - - - The file was designed to run under Windows NT/2000. - - - - - - - - - - The file was designed to run under the 16-bit Windows API. - - - - - The file was designed to be run under a 16-bit version of Presentation Manager. - - - - - The file was designed to be run under a 32-bit version of Presentation Manager. - - - - - The file was designed to run under the 32-bit Windows API. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - VS_VERSION file types. - - - - - The type of file could not be determined. - - - - - The file is an application. - - - - - The file is a Dynamic Link Library (DLL). - - - - - The file is a device driver. dwFileSubtype contains more information. - - - - - The file is a font. dwFileSubtype contains more information. - - - - - The file is a virtual device. - - - - - The file is a static link library. - - - - - File sub-type. - - - - - The type of driver could not be determined. - - - - - The file is a printer driver. - - - - - The file is a keyboard driver. - - - - - The file is a language driver. - - - - - The file is a display driver. - - - - - The file is a mouse driver. - - - - - The file is a network driver. - - - - - The file is a system driver. - - - - - The file is an installable driver. - - - - - The file is a sound driver. - - - - - The file is a communications driver. - - - - - The file is an input method driver. - - - - - The file is a versioned printer driver. - - - - - The file is a raster font. - - - - - The file is a vector font. - - - - - The file is a TrueType font. - - - - diff --git a/packages/WMPLib.1.0.0/.signature.p7s b/packages/WMPLib.1.0.0/.signature.p7s deleted file mode 100644 index 4e15837..0000000 Binary files a/packages/WMPLib.1.0.0/.signature.p7s and /dev/null differ diff --git a/packages/WMPLib.1.0.0/License/license.txt b/packages/WMPLib.1.0.0/License/license.txt deleted file mode 100644 index 72e4d09..0000000 --- a/packages/WMPLib.1.0.0/License/license.txt +++ /dev/null @@ -1,2 +0,0 @@ -Content is created using Microsoft's Runtime DLLs. -All rights belong to Microsoft. \ No newline at end of file diff --git a/packages/WMPLib.1.0.0/WMPLib.1.0.0.nupkg b/packages/WMPLib.1.0.0/WMPLib.1.0.0.nupkg deleted file mode 100644 index dec7283..0000000 Binary files a/packages/WMPLib.1.0.0/WMPLib.1.0.0.nupkg and /dev/null differ diff --git a/packages/WMPLib.1.0.0/lib/AxInterop.WMPLib.dll b/packages/WMPLib.1.0.0/lib/AxInterop.WMPLib.dll deleted file mode 100644 index 85e1c95..0000000 Binary files a/packages/WMPLib.1.0.0/lib/AxInterop.WMPLib.dll and /dev/null differ diff --git a/packages/WMPLib.1.0.0/lib/Interop.WMPLib.dll b/packages/WMPLib.1.0.0/lib/Interop.WMPLib.dll deleted file mode 100644 index b900ba5..0000000 Binary files a/packages/WMPLib.1.0.0/lib/Interop.WMPLib.dll and /dev/null differ diff --git a/packages/dnlib.3.3.2/.signature.p7s b/packages/dnlib.3.3.2/.signature.p7s deleted file mode 100644 index f016b55..0000000 Binary files a/packages/dnlib.3.3.2/.signature.p7s and /dev/null differ diff --git a/packages/dnlib.3.3.2/LICENSE.txt b/packages/dnlib.3.3.2/LICENSE.txt deleted file mode 100644 index 74858b8..0000000 --- a/packages/dnlib.3.3.2/LICENSE.txt +++ /dev/null @@ -1,20 +0,0 @@ -Copyright (C) 2012-2019 de4dot@gmail.com - -Permission is hereby granted, free of charge, to any person obtaining -a copy of this software and associated documentation files (the -"Software"), to deal in the Software without restriction, including -without limitation the rights to use, copy, modify, merge, publish, -distribute, sublicense, and/or sell copies of the Software, and to -permit persons to whom the Software is furnished to do so, subject to -the following conditions: - -The above copyright notice and this permission notice shall be -included in all copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, -EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF -MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. -IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY -CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, -TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE -SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/packages/dnlib.3.3.2/dnlib.3.3.2.nupkg b/packages/dnlib.3.3.2/dnlib.3.3.2.nupkg deleted file mode 100644 index ccd3271..0000000 Binary files a/packages/dnlib.3.3.2/dnlib.3.3.2.nupkg and /dev/null differ diff --git a/packages/dnlib.3.3.2/lib/net35/dnlib.dll b/packages/dnlib.3.3.2/lib/net35/dnlib.dll deleted file mode 100644 index 4837755..0000000 Binary files a/packages/dnlib.3.3.2/lib/net35/dnlib.dll and /dev/null differ diff --git a/packages/dnlib.3.3.2/lib/net35/dnlib.xml b/packages/dnlib.3.3.2/lib/net35/dnlib.xml deleted file mode 100644 index 9c0ad02..0000000 --- a/packages/dnlib.3.3.2/lib/net35/dnlib.xml +++ /dev/null @@ -1,38514 +0,0 @@ - - - - dnlib - - - - - Returns types without getting stuck in an infinite loop - - - - - Gets a list of all types and nested types - - A list of types - - - - Assembly flags from Assembly.Flags column. - - See CorHdr.h/CorAssemblyFlags - - - No flags set - - - The assembly ref holds the full (unhashed) public key. - - - Processor Architecture unspecified - - - Processor Architecture: neutral (PE32) - - - Processor Architecture: x86 (PE32) - - - Processor Architecture: Itanium (PE32+) - - - Processor Architecture: AMD X64 (PE32+) - - - Processor Architecture: ARM (PE32) - - - applies to any platform but cannot run on any (e.g. reference assembly), should not have "specified" set - - - Propagate PA flags to AssemblyRef record - - - Bits describing the processor architecture - - - Bits describing the PA incl. Specified - - - NOT A FLAG, shift count in PA flags <--> index conversion - - - From "DebuggableAttribute". - - - From "DebuggableAttribute". - - - The assembly can be retargeted (at runtime) to an assembly from a different publisher. - - - - - - - - - Bits describing ContentType - - - - A high-level representation of a row in the Assembly table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Assembly.HashAlgId - - - - - - - - From columns Assembly.MajorVersion, Assembly.MinorVersion, Assembly.BuildNumber, - Assembly.RevisionNumber. - - If is null - - - - - - - From column Assembly.Flags - - - - Attributes - - - - From column Assembly.PublicKey - - An empty is created if the caller writes null - - - - - - - Gets the public key token which is calculated from - - - - - From column Assembly.Name - - - - Name - - - - From column Assembly.Locale - - - - Name - - - - - - - - - Initializes - - - - - - - - - - - - - Gets all modules. The first module is always the . - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if is not empty - - - - - Gets the manifest (main) module. This is always the first module in . - null is returned if is empty. - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Finds a module in this assembly - - Name of module - A instance or null if it wasn't found. - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Gets the assembly name with the public key - - - - - Gets the assembly name with the public key token - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable - if possible (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Writes the assembly to a file on disk. If the file exists, it will be truncated. - - Filename - Writer options - - - - Writes the assembly to a stream. - - Destination stream - Writer options - - - - Checks whether this assembly is a friend assembly of - - Target assembly - - - - Adds or updates an existing System.Reflection.AssemblySignatureKeyAttribute - attribute. This attribute is used in enhanced strong naming with key migration. - See http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Identity public key - Identity strong name key pair - Signature public key - - - - Gets the original System.Runtime.Versioning.TargetFrameworkAttribute custom attribute information if possible. - It reads this from the original metadata and doesn't use . - Returns false if the custom attribute isn't present or if it is invalid. - - Framework name - Version - Profile - - - - - - - - - - - - - - - - - - - - - - - An Assembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly name info - If is null - - - - Created from a row in the Assembly table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Assembly row - Row ID - If is null - If is invalid - - - - Hashes some data according to a - - - - - Constructor - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The algorithm to use - - - - - - - Hash data - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The data - The algorithm to use - Hashed data or null if was null - - - - Hash data - - Data - - - - Hash data - - Data - Offset - Length - - - - Hash stream data - - Stream - Number of bytes to hash - Temp buffer - - - - Computes the hash - - - - - Creates a public key token from the hash of some - - A public key is hashed, and the last 8 bytes of the hash, in reverse - order, is used as the public key token - The data - A new instance - - - - Any ALG_CLASS_HASH type in WinCrypt.h can be used by Microsoft's CLI implementation - - - - - - - - - - - - - This is a reserved value in the CLI - - - The only algorithm supported by the CLI - - - - - - - - - - - - - - - - - - - - - - - - - - - - Extension methods - - - - - Gets the field type - - this - Field type or null if none - - - - Gets the return type - - this - Return type or null if none - - - - Gets the parameters - - this - The parameters - - - - Gets the parameter count - - this - Parameter count - - - - Gets the generic parameter count - - this - Generic parameter count - - - - Gets the parameters after the sentinel - - this - Parameters after sentinel or null if none - - - - Gets the locals - - this - All locals - - - - Gets the generic arguments - - this - All generic arguments - - - - Gets the property - - this - The type's property or - false if input isnull - - - - Returns true if it's an integer or a floating point type - - Element type - - - - - Returns the size of the element type in bytes or -1 if it's unknown - - Element type - Size of a pointer - - - - - Checks whether it's a value type - - this - true if it's a value type, false if it's not a value type or - if we couldn't determine whether it's a value type. Eg., it could be a generic - instance type. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Checks whether appears to be the core library (eg. - mscorlib, System.Runtime or corefx). - - If is a reference to a private corlib (eg. System.Private.CoreLib), - this method returns false unless is an - whose manifest (first) module defines System.Object. This check is performed in - the constructor and the result can be found in . - - Note that this method also returns true if it appears to be a 'public' corlib, - eg. mscorlib, etc, even if it internally possibly references a private corlib. - - The assembly - - - - Converts to a instance - - The assembly - A new instance - - - - Converts to a - - The type - true if we should try to figure out whether - is a - A instance or null if - is invalid - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns the base type of . Throws if we can't resolve - a . - - The type - The base type or null if there's no base type - - - - Returns the base type of - - The type - true if we should throw if we can't - resolve a . false if we should ignore the error and - just return null. - The base type or null if there's no base type, or if - is true and we couldn't resolve - a - - - - Gets the scope type, resolves it, and returns the - - Type - A or null if input was null or if we - couldn't resolve the reference. - - - - Gets the scope type, resolves it, and returns the - - Type - A instance. - If the type couldn't be resolved - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also - - Field to resolve - The or null if is - null or if it wasn't possible to resolve it (the field doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception if - it was not possible to resolve it. See also - - Field to resolve - The - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The or null if is - null or if it wasn't possible to resolve it (the method doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception - if it was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The - - - - Returns the definition assembly of a - - Member reference - - - - - Gets the normal visible parameters, doesn't include the hidden 'this' parameter - - this - The normal visible parameters - - - - Gets the normal visible parameter count, doesn't include the hidden 'this' parameter - - this - Normal visible parameter count - - - - Checks whether any normal visible parameter exists, doesn't include the hidden 'this' parameter - - this - true if there's at least one normal visible parameter - - - - Gets a normal visible parameter, doesn't include the hidden 'this' parameter - - this - Normal visible parameter index - - - - - Converts a to a - - The sig - - - - Returns true if it's an integer or a floating point type - - Type - - - - - Gets a if matches a primitive type. - - this - The type - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Log an error message - - this - Sender or null - Message - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an error message - - this - Sender or null - Message - Message arguments - - - - Log a warning message - - this - Sender or null - Message - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a warning message - - this - Sender or null - Message - Message arguments - - - - Log an info message - - this - Sender or null - Message - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an info message - - this - Sender or null - Message - Message arguments - - - - Log a verbose message - - this - Sender or null - Message - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a verbose message - - this - Sender or null - Message - Message arguments - - - - Log a very verbose message - - this - Sender or null - Message - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a very verbose message - - this - Sender or null - Message - Message arguments - - - - Resolves a type - - this - The type - A instance or null if it couldn't be resolved - - - - Resolves a type - - this - The type - A instance - If the type couldn't be resolved - - - - Resolves a type - - this - The type - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Resolves a method or a field - - this - A method/field reference - A or a instance - If the method/field couldn't be resolved - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - If the field couldn't be resolved - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - If the method couldn't be resolved - - - - Resolves a token - - This - The metadata token - A or null if is invalid - - - - Returns , but if it's a nested , - return the non-nested - - this - The scope type - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. - - this - The type ref - An existing or null if it wasn't found. - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing - If type couldn't be found - - - - Checks whether a exists. 's scope (i.e., - module or assembly) is ignored when looking up the type. - - this - The type ref - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by / - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by + - true if the exists, false otherwise - - - - Removes all C optional/required modifiers - - A instance - Input after all modifiers - - - - Removes pinned signature - - The type - Input after pinned signature - - - - Removes all modifiers and pinned sig - - The type - Inputer after modifiers and pinned signature - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Gets the next field or null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the element type - - this - The element type - - - - Gets the full name of the type - - this - Full name of the type - - - - Gets the name of the type - - this - Name of the type - - - - Gets the namespace of the type - - this - Namespace of the type - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - Nothing is resolved. - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Flags used by - - - - - Compare assembly simple name - - - - - Compare assembly version - - - - - Compare assembly public key token - - - - - Compare assembly culture - - - - - Compare content type - - - - - Compare assembly simple name, version, public key token, locale and content type - - - - - Compares two assembly names - - - - - Compares the name, version, public key token, culture and content type - - - - - Compares only the name and the public key token - - - - - Compares only the name - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - Comparison flags - - - - Compares two assembly names - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two assembly names - - First - Second - true if equal, false otherwise - - - - Figures out which of two assembly names is closer to another assembly name - - Requested assembly name - First - Second - -1 if both are equally close, 0 if is closest, 1 if - is closest - - - - Gets the hash code of an assembly name - - Assembly name - The hash code - - - - Stores assembly name information - - - - - Gets/sets the - - - - - Gets/sets the or null if none specified - - - - - Gets/sets the - - - - - Gets/sets the public key or token - - - - - Gets/sets the name - - - - - Gets/sets the culture or null if none specified - - - - - Gets the full name of the assembly - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Default constructor - - - - - Constructor - - An assembly name - - - - Constructor - - The assembly - - - - Constructor - - Assembly name info - - - - - - - A high-level representation of a row in the AssemblyRef table - - - - - An assembly ref that can be used to indicate that it references the current assembly - when the current assembly is not known (eg. a type string without any assembly info - when it references a type in the current assembly). - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - From columns AssemblyRef.MajorVersion, AssemblyRef.MinorVersion, - AssemblyRef.BuildNumber, AssemblyRef.RevisionNumber - - If is null - - - - - - - From column AssemblyRef.Flags - - - - Attributes - - - - From column AssemblyRef.PublicKeyOrToken - - If is null - - - - - - - From column AssemblyRef.Name - - - - Name - - - - From column AssemblyRef.Locale - - - - Culture - - - - From column AssemblyRef.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Same as , except that it uses the PublicKey if available. - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - - - - An AssemblyRef row created by the user and not present in the original .NET file - - - - - Creates a reference to CLR 1.0's mscorlib - - - - - Creates a reference to CLR 1.1's mscorlib - - - - - Creates a reference to CLR 2.0's mscorlib - - - - - Creates a reference to CLR 4.0's mscorlib - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly - - - - Created from a row in the AssemblyRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this AssemblyRef row - Row ID - If is null - If is invalid - - - - Resolves assemblies - - - - - Gets/sets the default - - - - - true if should find an assembly that matches exactly. - false if it first tries to match exactly, and if that fails, it picks an - assembly that is closest to the requested assembly. - - - - - true if resolved .NET framework assemblies can be redirected to the source - module's framework assembly version. Eg. if a resolved .NET 3.5 assembly can be - redirected to a .NET 4.0 assembly if the source module is a .NET 4.0 assembly. This is - ignored if is true. - - - - - If true, all modules in newly resolved assemblies will have their - property set to true. This is - enabled by default since these modules shouldn't be modified by the user. - - - - - true to search the Global Assembly Cache. Default value is true. - - - - - Gets paths searched before trying the standard locations - - - - - Gets paths searched after trying the standard locations - - - - - Default constructor - - - - - Constructor - - Module context for all resolved assemblies - - - - - - - Add a module's assembly to the assembly cache - - The module whose assembly should be cached - true if 's assembly is cached, false - if it's not cached because some other assembly with the exact same full name has - already been cached or if or its assembly is null. - - - - Add an assembly to the assembly cache - - The assembly - true if is cached, false if it's not - cached because some other assembly with the exact same full name has already been - cached or if is null. - - - - Removes a module's assembly from the cache - - The module - true if its assembly was removed, false if it wasn't removed - since it wasn't in the cache, it has no assembly, or was - null - - - - Removes the assembly from the cache - - The assembly - true if it was removed, false if it wasn't removed since it - wasn't in the cache or if was null - - - - Clears the cache and calls on each cached module. - Use to remove any assemblies you added yourself - using before calling this method if you don't want - them disposed. - - - - - Gets the cached assemblies in this resolver. - - The cached assemblies. - - - - Finds an assembly that exactly matches the requested assembly - - Assembly to find - Search paths or null if none - Module context - An instance or null if an exact match - couldn't be found. - - - - Finds the closest assembly from the already cached assemblies - - Assembly to find - The closest or null if none found - - - - Returns true if is inserted in - - Assembly to check - - - - Called before - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Gets all search paths to use for this module - - The module or null if unknown - A list of all search paths to use for this module - - - - Gets all module search paths. This is usually empty unless its assembly has - a .config file specifying any additional private search paths in a - <probing/> element. - - The module or null if unknown - A list of search paths - - - - Gets all private assembly search paths as found in the module's .config file. - - The module or null if unknown - A list of search paths - - - - See CorHdr.h/CorCallingConvention - - - - The managed calling convention - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - generic method instantiation - - - used ONLY for 64bit vararg PInvoke calls - - - Calling convention is bottom 4 bits - - - Generic method - - - Method needs a 'this' parameter - - - 'this' parameter is the first arg if set (else it's hidden) - - - Used internally by the CLR - - - - Base class for sigs with a calling convention - - - - - The calling convention - - - - - Gets/sets the extra data found after the signature - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if there's an implicit this parameter - - - - - true if this contains a - or a . - - - - - Default constructor - - - - - Constructor - - The calling convention - - - - Gets the calling convention - - - - - A field signature - - - - - Gets/sets the field type - - - - - Default constructor - - - - - Constructor - - Field type - - - - Constructor - - Field type - The calling convention (must have Field set) - - - - Clone this - - - - - - - - Method sig base class - - - - - - - - - - - - - - - - - Gets/sets the calling convention - - - - - Gets/sets the return type - - - - - Gets the parameters. This is never null - - - - - Gets/sets the generic param count - - - - - Gets the parameters that are present after the sentinel. Note that this is null - if there's no sentinel. It can still be empty even if it's not null. - - - - - A method signature - - - - - Gets/sets the original token. It's set when reading calli instruction operands - and it's a hint to the module writer if it tries to re-use the same token. - - - - - Creates a static MethodSig - - Return type - - - - Creates a static MethodSig - - Return type - Arg type #1 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static MethodSig - - Return type - Argument types - - - - Creates an instance MethodSig - - Return type - - - - Creates an instance MethodSig - - Return type - Arg type #1 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance MethodSig - - Return type - Argument types - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention - - - - Constructor - - Calling convention - Number of generic parameters - - - - Constructor - - Calling convention - Number of generic parameters - Return type - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A property signature - - - - - Creates a static PropertySig - - Return type - - - - Creates a static PropertySig - - Return type - Arg type #1 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static PropertySig - - Return type - Argument types - - - - Creates an instance PropertySig - - Return type - - - - Creates an instance PropertySig - - Return type - Arg type #1 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance PropertySig - - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention (must have Property set) - - - - Constructor - - true if instance, false if static - - - - Constructor - - true if instance, false if static - Return type - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - true if instance, false if static - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A local variables signature - - - - - All local types. This is never null. - - - - - Default constructor - - - - - Constructor - - Calling convention (must have LocalSig set) - Number of locals - - - - Constructor - - Local type #1 - - - - Constructor - - Local type #1 - Local type #2 - - - - Constructor - - Local type #1 - Local type #2 - Local type #3 - - - - Constructor - - All locals - - - - Constructor - - All locals - - - - Constructor - - All locals (this instance now owns it) - Dummy - - - - Clone this - - - - - An instantiated generic method signature - - - - - Gets the generic arguments (must be instantiated types, i.e., closed types) - - - - - Default constructor - - - - - Constructor - - Calling convention (must have GenericInst set) - Number of generic args - - - - Constructor - - Generic arg #1 - - - - Constructor - - Generic arg #1 - Generic arg #2 - - - - Constructor - - Generic arg #1 - Generic arg #2 - Generic arg #3 - - - - Constructor - - Generic args - - - - Constructor - - Generic args - - - - Clone this - - - - - A high-level representation of a row in the ClassLayout table - - - - - The row id in its table - - - - - - - - - - - From column ClassLayout.PackingSize - - - - - - - - From column ClassLayout.ClassSize - - - - - - - - A ClassLayout row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - PackingSize - ClassSize - - - - Created from a row in the ClassLayout table - - - - - - - - Constructor - - The module which contains this ClassLayout row - Row ID - If is null - If is invalid - - - - A high-level representation of a row in the Constant table - - - - - The row id in its table - - - - - - - - - - - From column Constant.Type - - - - - - - - From column Constant.Value - - - - - - - - A Constant row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Value - - - - Constructor - - Value - Type - - - - Created from a row in the Constant table - - - - - - - - Constructor - - The module which contains this Constant row - Row ID - If is null - If is invalid - - - - Default implementation of - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The owner module - - - - Constructor - - The owner module - Corlib assembly reference or null if a default - assembly reference should be created - - - - - - - Gets the required alignment for the stubs, must be a power of 2 - - Stub type - - - - - Gets the size of a stub, it doesn't have to be a multiple of - - Stub type - - - - - Gets the offset of the code (entry point) relative to the start of the stub - - Stub type - - - - - Gets the RVA of the func field that the stub jumps to - - Reader, positioned at the stub func - PE image - Updated with RVA of func field - - - - - Writes stub relocs, if needed - - Stub type - Reloc directory - The chunk where this stub will be written to - Offset of this stub in - - - - Writes the stub that jumps to the managed function - - Stub type - Writer - Image base - RVA of this stub - RVA of a pointer-sized field that contains the absolute address of the managed function - - - - A custom attribute - - - - - Gets/sets the custom attribute constructor - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - true if the raw custom attribute blob hasn't been parsed - - - - - Gets the raw custom attribute blob or null if the CA was successfully parsed. - - - - - Gets all constructor arguments - - - - - true if is not empty - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Gets the #Blob offset or 0 if unknown - - - - - Constructor - - Custom attribute constructor - Raw custom attribute blob - - - - Constructor - - Custom attribute constructor - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - - - - Constructor - - Custom attribute constructor - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - Original custom attribute #Blob offset or 0 - - - - Constructor - - Custom attribute constructor - Constructor arguments. The list is now owned by this instance. - Named arguments. The list is now owned by this instance. - Original custom attribute #Blob offset or 0 - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - - - - A custom attribute constructor argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Constructor - - Argument type - - - - Constructor - - Argument type - Argument value - - - - Clones this instance and any s and s - referenced from this instance. - - - - - - - - - A custom attribute field/property argument - - - - - true if it's a field - - - - - true if it's a property - - - - - Gets/sets the field/property type - - - - - Gets/sets the property/field name - - - - - Gets/sets the argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Default constructor - - - - - Constructor - - true if field, false if property - - - - Constructor - - true if field, false if property - Field/property type - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - Field/property argument - - - - Clones this instance and any s referenced from this instance. - - - - - - - - - Stores s - - - - - Default constructor - - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Checks whether a custom attribute is present - - Full name of custom attribute type - true if the custom attribute type is present, false otherwise - - - - Removes all custom attributes of a certain type - - Full name of custom attribute type that should be removed - - - - Finds a custom attribute - - Full name of custom attribute type - A or null if it wasn't found - - - - Finds all custom attributes of a certain type - - Full name of custom attribute type - All s of the requested type - - - - Finds a custom attribute - - Custom attribute type - The first found or null if none found - - - - Finds a custom attribute - - Custom attribute type - Attribute type comparison flags - The first found or null if none found - - - - Finds all custom attributes of a certain type - - Custom attribute type - All s of the requested type - - - - Finds all custom attributes of a certain type - - Custom attribute type - Attribute type comparison flags - All s of the requested type - - - - Searches for a type according to custom attribute search rules: first try the - current assembly, and if that fails, try mscorlib - - - - - Constructor - - The module to search first - - - - - - - Thrown by CustomAttributeReader when it fails to parse a custom attribute blob - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Reads custom attributes from the #Blob stream - - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - A new instance - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - A reader positioned at the the first byte of the CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads custom attribute named arguments - - Owner module - A reader positioned at the the first byte of the CA blob - Number of named arguments to read from - Generic parameter context - A list of s or null if some error - occurred. - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - If is not an enum or null - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - A high-level representation of a row in the DeclSecurity table - - - - - The row id in its table - - - - - - - - - - - - - - From column DeclSecurity.Action - - - - - - - - From column DeclSecurity.PermissionSet - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - Gets the blob data or null if there's none - - Blob data or null - - - - Returns the .NET 1.x XML string or null if it's not a .NET 1.x format - - - - - - A DeclSecurity row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The security action - The security attributes (now owned by this) - - - - - - - Created from a row in the DeclSecurity table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this DeclSecurity row - Row ID - If is null - If is invalid - - - - - - - Reads DeclSecurity blobs - - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - Generic parameter context - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - Generic parameter context/// - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - Generic parameter context - A list of s - - - - Reads the new (.NET 2.0+) DeclSecurity blob format - - - - - - Reads the old (.NET 1.x) DeclSecurity blob format - - - - - - See CorHdr.h/CorElementType - - - - - - - System.Void - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Pointer type (*) - - - ByRef type (&) - - - Value type - - - Reference type - - - Type generic parameter - - - Multidimensional array ([*], [,], [,,], ...) - - - Generic instance type - - - Typed byref - - - Value array (don't use) - - - System.IntPtr - - - System.UIntPtr - - - native real (don't use) - - - Function pointer - - - System.Object - - - Single-dimension, zero lower bound array ([]) - - - Method generic parameter - - - Required C modifier - - - Optional C modifier - - - Used internally by the CLR (don't use) - - - Module (don't use) - - - Sentinel (method sigs only) - - - Pinned type (locals only) - - - - A CIL opcode. If the high byte is 0 or if it's , it's a 1-byte opcode, - else it's a two-byte opcode and the highest byte is the first byte of the opcode. - - - - - Extension methods - - - - - Converts a to an - - The code - A or null if it's invalid - - - - Gets the opcode or if is null - - this - - - - - Gets the operand or null if is null - - this - - - - - Gets the offset or 0 if is null - - this - - - - - Gets the sequence point or null if is null - - this - - - - - Resolves a token - - An object - The metadata token - A or null if is invalid - - - - options - - - - - No option is enabled - - - - - Some fields/methods have an unknown declaring type and don't have a context with - that information. If this is enabled, the reader will try to guess it but it doesn't - always work. If you get an , try enabling this option. - - - - - Reads code from a DynamicMethod - - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Generic parameter context - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - Options - - - - Reads the code - - - - - - Returns the created method. Must be called after . - - A new instance - - - - - - - - - - - - - - - - - - - - - - A CIL method exception handler - - - - - First instruction of try block - - - - - One instruction past the end of try block or null if it ends at the end - of the method. - - - - - Start of filter handler or null if none. The end of filter handler is - always . - - - - - First instruction of try handler block - - - - - One instruction past the end of try handler block or null if it ends at the end - of the method. - - - - - The catch type if is - - - - - Type of exception handler clause - - - - - Default constructor - - - - - Constructor - - Exception clause type - - - - Type of exception handler. See CorHdr.h/CorExceptionFlag - - - - - - - - - - - - - - - - - - - - CIL opcode flow control - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A CIL instruction (opcode + operand) - - - - - The opcode - - - - - The opcode operand - - - - - Offset of the instruction in the method body - - - - - PDB sequence point or null if none - - - - - Default constructor - - - - - Constructor - - Opcode - - - - Constructor - - Opcode - The operand - - - - Creates a new instruction with no operand - - The opcode - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with an operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a string operand - - The opcode - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - The opcode - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The opcode - The targets - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The opcode - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The opcode - The field - A new instance - - - - Creates a new instruction with a method operand - - The opcode - The method - A new instance - - - - Creates a new instruction with a token operand - - The opcode - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The opcode - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The opcode - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The opcode - The method local - A new instance - - - - Creates a ldci4 instruction - - Operand value - A new instance - - - - Gets the size in bytes of the instruction - - - - - - Updates with the new stack size - - Current stack size - - - - Updates with the new stack size - - Current stack size - true if the method has a return value, - false otherwise - - - - Calculates stack usage - - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Calculates stack usage - - true if method has a return value - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Checks whether it's one of the leave instructions - - - - - Checks whether it's one of the br instructions - - - - - Checks whether it's one of the brfalse instructions - - - - - Checks whether it's one of the brtrue instructions - - - - - Checks whether it's one of the conditional branch instructions (bcc, brtrue, brfalse) - - - - - Checks whether this is one of the ldc.i4 instructions - - - - - Returns a ldc.i4 instruction's operand - - The integer value - isn't one of the - ldc.i4 opcodes - - - - Checks whether it's one of the ldarg instructions, but does not check - whether it's one of the ldarga instructions. - - - - - Checks whether it's one of the ldloc instructions, but does not check - whether it's one of the ldloca instructions. - - - - - Checks whether it's one of the starg instructions - - - - - Checks whether it's one of the stloc instructions - - - - - Returns the local if it's a ldloc, stloc or ldloca instruction - - The locals - The local or null if it's not a ldloc, stloc or ldloca - instruction or if the local doesn't exist. - - - - Gets the index of the instruction's parameter operand or -1 if the parameter - is missing or if it's not an instruction with a parameter operand. - - - - - Returns a method parameter - - All parameters - A parameter or null if it doesn't exist - - - - Returns an argument type - - Method signature - Declaring type (only needed if it's an instance method) - The type or null if it doesn't exist - - - - Clone this instance. The and fields - are shared by this instance and the created instance. - - - - - - - - Converts instructions to strings - - - - - Converts an instruction to a string - - The instruction - The result - - - - Gets the instruction's operand as a string - - The instruction - The operand as a string - - - - Add an instruction's operand to - - Place result here - The instruction - - - - Add an instruction's operand to - - Place result here - The instruction - A string that will be added before the operand, if there's - an operand. - - - - Thrown when invalid data is detected while parsing a .NET method - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - The inner exception or null if none - - - - Constructor - - - - - - - A collection of s - - - - - Gets the number of locals - - - - - Gets the list of locals - - - - - Gets the N'th local - - The local index - - - - Default constructor - - - - - Constructor - - All locals that will be owned by this instance - - - - Adds a new local and then returns it - - The local that should be added to the list - The input is always returned - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A method local - - - - - Gets/sets the type of the local - - - - - Local index - - - - - Gets the name. This property is obsolete, use to get/set the name stored in the PDB file. - - - - - Gets the attributes. This property is obsolete, use to get/set the attributes stored in the PDB file. - - - - - Constructor - - The type - - - - Constructor - - The type - Name of local - - - - Constructor - - The type - Name of local - Index, should only be used if you don't add it to the locals list - - - - - - - Method body base class - - - - - A native method body - - - - - Gets/sets the RVA of the native method body - - - - - Default constructor - - - - - Constructor - - RVA of method body - - - - CIL (managed code) body - - - - - Size of a small header - - - - - Gets/sets a flag indicating whether the original max stack value should be used. - - - - - Gets/sets the init locals flag. This is only valid if the method has any locals. - - - - - Gets/sets the size in bytes of the method body header. The instructions immediately follow - the header. - - - - - true if it was a small body header ( is 1) - - - - - true if it was a big body header - - - - - Gets/sets max stack value from the fat method header. - - - - - Gets/sets the locals metadata token - - - - - true if is not empty - - - - - Gets the instructions - - - - - true if is not empty - - - - - Gets the exception handlers - - - - - true if is not empty - - - - - Gets the locals - - - - - Gets/sets the PDB method. This is null if no PDB has been loaded or if there's - no PDB info for this method. - - - - - true if is not null - - - - - Gets the total size of the body in the PE file, including header, IL bytes, and exception handlers. - This property returns 0 if the size is unknown. - - - - - Default constructor - - - - - Constructor - - Init locals flag - All instructions. This instance will own the list. - All exception handlers. This instance will own the list. - All locals. This instance will own the locals in the list. - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - - - - Optimizes branches by using the smallest possible branch - - - - - Updates each instruction's offset - - Total size in bytes of all instructions - - - - Reads strings from #US heap - - - - - Reads a string from the #US heap - - String token - A string - - - - Resolves instruction operands - - - - - Reads a .NET method body (header, locals, instructions, exception handlers) - - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Initializes the method header - - Header flags, eg. 2 if it's a tiny method - Max stack - Code size - Local variable signature token - - - - Reads the method body header, locals, all instructions, and the exception handlers (if any) - - true if it worked, and false if something failed - - - - Reads the method header - - - - - Reads the locals - - All locals or null if there are none - - - - Reads all instructions - - - - - - - - - - - - - - - - - - - - - - - Reads all exception handlers - - - - - Creates a CIL body. Must be called after , and can only be - called once. - - A new instance - - - - Method body reader base class - - - - The method reader - - - All parameters - - - All locals - - - All instructions - - - All exception handlers - - - First byte after the end of the code - - - Start offset of method - - - - Gets all parameters - - - - - Gets all locals - - - - - Gets all instructions - - - - - Gets all exception handlers - - - - - Constructor - - - - - Constructor - - The reader - - - - Constructor - - The reader - Method parameters or null if they're not known yet - - - - Sets new locals - - A list of types of all locals or null if none - - - - Sets new locals - - A list of types of all locals or null if none - - - - Reads all instructions - - Number of instructions to read - - - - Reads all instructions - - Size of code - - - - Fixes all branch instructions so their operands are set to an - instead of an offset. - - - - - Finds an instruction - - Offset of instruction - The instruction or null if there's no instruction at . - - - - Finds an instruction and throws if it's not present - - Offset of instruction - The instruction - There's no instruction at - - - - - Reads the next instruction - - - - - Reads the next OpCode from the current position - - - - - Reads the instruction operand (if any) - - The instruction - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Returns true if it's one of the ldarg/starg instructions that have an operand - - The instruction to check - - - - Returns a parameter - - A parameter index - A or null if is invalid - - - - Returns a local - - A local index - A or null if is invalid - - - - Add an exception handler if it appears valid - - The exception handler - true if it was added, false otherwise - - - - Gets the offset of an instruction - - The instruction or null if the offset is the first offset - at the end of the method. - The instruction offset - - - - Restores a 's body with the parsed method instructions - and exception handlers - - The method that gets updated with the instructions, locals, and - exception handlers. - - - - Converts a type address to a . The address can be found in - RuntimeTypeHandle.Value and it's the same address you use with the WinDbg SOS command - !dumpmt. - - - - - Converts to a . - - Address of type - The or null - - - - Instruction utility methods - - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All instructions - All locals - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - All instructions - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - All instructions - - - - Optimizes branches by using the smallest possible branch - - All instructions - - - - Updates each instruction's offset - - All instructions - Total size in bytes of all instructions - - - - A CIL opcode - - - - - The opcode name - - - - - The opcode as a enum - - - - - Operand type - - - - - Flow control info - - - - - Opcode type - - - - - Push stack behavior - - - - - Pop stack behavior - - - - - Gets the value which is compatible with - - - - - Gets the size of the opcode. It's either 1 or 2 bytes. - - - - - Creates a new instruction with no operand - - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with an operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a string operand - - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The targets - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The field - A new instance - - - - Creates a new instruction with a method operand - - The method - A new instance - - - - Creates a new instruction with a token operand - - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The method local - A new instance - - - - - - - Contains all valid CIL opcodes - - - - - All one-byte opcodes - - - - - All two-byte opcodes (first byte is 0xFE) - - - - - CIL opcode type - - - - - - - - - - - - - - - - - - - - - - - CIL opcode operand type - - - - 4-byte relative instruction offset - - - 4-byte field token ( or ) - - - int32 - - - int64 - - - 4-byte method token (, - or ) - - - No operand - - - Never used - - - 64-bit real - - - - - - 4-byte method sig token () - - - 4-byte string token (0x70xxxxxx) - - - 4-byte count N followed by N 4-byte relative instruction offsets - - - 4-byte token (, , - , , , - or ) - - - 4-byte type token (, or - ) - - - 2-byte param/local index - - - 1-byte relative instruction offset - - - 1-byte sbyte () or byte (the rest) - - - 32-bit real - - - 1-byte param/local index - - - - CIL opcode stack behavior - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Event attributes, see CorHdr.h/CorEventAttr - - - - event is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - - A high-level representation of a row in the Event table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Event.EventFlags - - - - - - - - From column Event.Name - - - - Name - - - - From column Event.EventType - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the adder method - - - - - Gets/sets the invoker method - - - - - Gets/sets the remover method - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - - - - Reset , , , - - - - true if there are no methods attached to this event - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the event - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - An Event row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Type - - - - Constructor - - Name - Type - Flags - - - - Created from a row in the Event table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this Event row - Row ID - If is null - If is invalid - - - - - - - A high-level representation of a row in the ExportedType table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - - - - - - - - - - From column ExportedType.Flags - - - - Attributes - - - - From column ExportedType.TypeDefId - - - - - - - - From column ExportedType.TypeName - - - - - - - - From column ExportedType.TypeNamespace - - - - - - - - From column ExportedType.Implementation - - - - - - - - - - Called to initialize - - - - true if it's nested within another - - - - - Gets the declaring type, if any - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit. See also - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this type has been moved to another assembly - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - Source module or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Converts this instance to a - - A new instance - - - - - - - An ExportedType row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - TypeDef ID - Type name - Type namespace - Flags - Implementation - - - - Created from a row in the ExportedType table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this ExportedType row - Row ID - If is null - If is invalid - - - - Field flags, see CorHdr.h/CorFieldAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Field may only be initialized, not written to after init. - - - Value is compile time constant. - - - Field does not have to be serialized when type is remoted. - - - field is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Runtime(metadata internal APIs) should check name encoding. - - - Field has marshalling information. - - - Field has default. - - - Field has RVA. - - - - A high-level representation of a row in the Field table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - From column Field.Flags - - - - Attributes - - - - From column Field.Name - - - - Name - - - - From column Field.Signature - - - - - - - - Gets/sets the field layout offset - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the field RVA - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the initial value. Be sure to set to true if - you write to this field. - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - Gets/sets the - - - - - - - - true if is not null - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - Gets/sets the field type - - - - - Modify field: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the field access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Returns the full name of this field - - - - - Gets the size of this field in bytes or 0 if unknown. - - - - - Gets the size of this field in bytes or 0 if unknown. - - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Size of a pointer - Updated with size - true if is valid, false otherwise - - - - - - - A Field row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Signature - - - - Constructor - - Name - Signature - Flags - - - - Created from a row in the Field table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Field row - Row ID - If is null - If is invalid - - - - File row flags. See CorHdr.h/CorFileFlags - - - - This is not a resource file - - - This is a resource file or other non-metadata-containing file - - - - A high-level representation of a row in the File table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column File.Flags - - - - Attributes - - - - From column File.Name - - - - Name - - - - From column File.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - A File row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name of file - Flags - File hash - - - - Created from a row in the File table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this File row - Row ID - If is null - If is invalid - - - - Redirects .NET framework assembly references from older to newer versions - - - - - Redirects a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - Module using the assembly reference - - - - Tries to redirect a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Module using the assembly reference - Updated with the redirected assembly if successful - - - - - Redirects a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Redirects a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Tries to redirect a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Tries to redirect a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Helps create a name - - - - - Checks whether the assembly name should be included when printing - the full type name. The assembly name isn't required in custom attributes - when the type already exists in the same module as the CA, or if the type - exists in mscorlib. - - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Creates type names, method names, etc. - - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - If false, don't add an assembly name if it's a type in , - if true, don't add an assembly name if it's a type in or the corlib. - true if the assembly name must be included, false otherwise - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeRef - A or null if none found - - - - Gets the scope - - The TypeRef - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeRef - A or null if none found - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeDef - A or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeDef - A or null if none found - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSpec - A or null if none found - - - - Gets the scope type - - The TypeSpec - The scope type or null if none found - - - - Gets the scope - - The TypeSpec - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSpec - A or null if none found - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSig - A or null if none found - - - - Gets the scope - - The TypeSig - The or null if none found - - - - Gets the scope type - - The TypeSig - The scope type or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSig - A or null if none found - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The ExportedType - A or null if none found - - - - Gets the scope type - - The ExportedType - The scope type or null if none found - - - - Gets the scope - - The ExportedType - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The ExportedType - A or null if none found - - - - - - - Constructor - - true if it's for generic types, false if generic methods - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Resolves a generic argument - - Generic variable number - A or null if none was found - - - - Replaces generic type/method var with its generic argument - - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Replaces a generic type/method var with its generic argument (if any). If - isn't a generic type/method var or if it can't - be resolved, it itself is returned. Else the resolved type is returned. - - Type signature - New which is never null unless - is null - - - - A high-level representation of a row in the GenericParam table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner type/method - - - - - - - - Gets the declaring type or null if none or if is - not a - - - - - - - - Gets the declaring method or null if none or if is - not a - - - - - From column GenericParam.Number - - - - - - - - From column GenericParam.Flags - - - - Attributes - - - - From column GenericParam.Name - - - - Name - - - - From column GenericParam.Kind (v1.1 only) - - - - - - - - Gets the generic param constraints - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets variance (non, contra, co) - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the special constraint - - - - - true if there are no special constraints - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - - - - - - - - - - - - - A GenericParam row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic param number - - - - Constructor - - The generic param number - Flags - - - - Constructor - - The generic param number - Flags - Name - - - - Created from a row in the GenericParam table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this GenericParam row - Row ID - If is null - If is invalid - - - - - - - Generic parameter flags. See CorHdr.h/CorGenericParamAttr - - - - - - - - - - - - - - - - - - - - - - type argument must be a reference type - - - type argument must be a value type but not Nullable - - - type argument must have a public default constructor - - - - A high-level representation of a row in the GenericParamConstraint table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner generic param - - - - - - - - From column GenericParamConstraint.Constraint - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - A GenericParamConstraintAssembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The constraint - - - - Created from a row in the GenericParamConstraint table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this GenericParamConstraint row - Row ID - Generic parameter context - If is null - If is invalid - - - - Generic parameter context - - - - - Type context - - - - - Method context - - - - - true if and are both null - - - - - Creates a new instance and initializes the - field to 's - and the field to . - - Method - A new instance - - - - Creates a new instance and initializes the - field to and the field - to null - - Type - A new instance - - - - Constructor - - Type context - - - - Constructor. The field is set to null and NOT to - 's . Use - if you want that behavior. - - Method context - - - - Constructor - - Type context - Method context - - - - Resolves assemblies - - - - - Finds and returns an - - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - The table row can be referenced by a MD token - - - - - Returns the metadata token - - - - - Gets/sets the row ID - - - - - All *MD classes implement this interface. - - - - - Gets the original row ID - - - - - An assembly. Implemented by , and - . - - - - - The assembly version - - - - - Assembly flags - - - - - Public key or public key token - - - - - Locale, aka culture - - - - - Gets the full name of the assembly but use a public key token - - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Implemented by and , which are the only - valid managed entry point tokens. - - - - - Interface to access a module def/ref - - - - - Type of scope - - - - - It's an instance - - - - - It's a instance - - - - - It's a instance - - - - - Implemented by modules and assemblies - - - - - Gets the scope type - - - - - Gets the scope name - - - - - Interface to get the full name of a type, field, or method - - - - - Gets the full name - - - - - Simple name of implementer - - - - - Implemented by all member refs and types - - - - - Gets the owner module - - - - - Methods to check whether the implementer is a type or a method. - - - - - true if it's a type - - - - - true if it's a method - - - - - Implemented by types, fields, methods, properties, events - - - - - Gets the declaring type - - - - - true if it's a or a that's - referencing a field. - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - All member definitions implement this interface: , - , , , - , and . - - - - - Gets the declaring type - - - - - Implemented by the following classes: , - , , , - , , , - and - - - - - Implemented by types and methods - - - - - Gets the number of generic parameters / arguments - - - - - Implemented by fields ( and ) - - - - - Gets/sets the field signature - - - - - Implemented by methods (, and ) - - - - - Method signature - - - - - Implemented by tables that can be a token in the ldtoken instruction - - - - - The table row can be referenced by a coded token - - - - - TypeDefOrRef coded token interface - - - - - The coded token tag - - - - - HasConstant coded token interface - - - - - The coded token tag - - - - - Gets/sets the constant value - - - - - HasCustomAttribute coded token interface - - - - - The coded token tag - - - - - Gets all custom attributes - - - - - true if is not empty - - - - - HasFieldMarshal coded token interface - - - - - The coded token tag - - - - - Gets/sets the marshal type - - - - - true if is not null - - - - - HasDeclSecurity coded token interface - - - - - The coded token tag - - - - - Gets the permission sets - - - - - true if is not empty - - - - - MemberRefParent coded token interface - - - - - The coded token tag - - - - - HasSemantic coded token interface - - - - - The coded token tag - - - - - MethodDefOrRef coded token interface - - - - - The coded token tag - - - - - MemberForwarded coded token interface - - - - - The coded token tag - - - - - Gets/sets the impl map - - - - - true if is not null - - - - - Implementation coded token interface - - - - - The coded token tag - - - - - CustomAttributeType coded token interface - - - - - The coded token tag - - - - - ResolutionScope coded token interface - - - - - The coded token tag - - - - - TypeOrMethodDef coded token interface - - - - - The coded token tag - - - - - Gets the generic parameters - - - - - true if is not empty - - - - - HasCustomDebugInformation interface - - - - - The custom debug information tag - - - - - Gets the custom debug infos - - - - - true if is not empty - - - - - Access to .NET core library's simple types - - - - - Gets a System.Void - - - - - Gets a System.Boolean - - - - - Gets a System.Char - - - - - Gets a System.SByte - - - - - Gets a System.Byte - - - - - Gets a System.Int16 - - - - - Gets a System.UInt16 - - - - - Gets a System.Int32 - - - - - Gets a System.UInt32 - - - - - Gets a System.Int64 - - - - - Gets a System.UInt64 - - - - - Gets a System.Single - - - - - Gets a System.Double - - - - - Gets a System.String - - - - - Gets a System.TypedReference - - - - - Gets a System.IntPtr - - - - - Gets a System.UIntPtr - - - - - Gets a System.Object - - - - - Gets the assembly reference to the core library - - - - - Gets a that references a type in the core library assembly - - Namespace of type (eg. "System") - Name of type - A instance. This instance may be a cached instance. - - - - Custom attribute interface. Implemented by and - - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Interface to decrypt methods - - - - - Gets the method's body - - Method rid - The found in the method's Method row - The method's parameters - Generic parameter context - Updated with the method's if this - method returns true - true if the method body was decrypted, false if the method isn't - encrypted and the default body reader code should be used. - - - - Interface to decrypt strings - - - - - Reads a string - - String token - A string or null if we should read it from the #US heap - - - - events - - - - - An error was detected. An exception should normally be thrown but the error - can be ignored. - - - - - Just a warning and can be ignored. - - - - - A normal message - - - - - A verbose message - - - - - A very verbose message - - - - - Simple logger - - - - - Log something - - Caller or null - Logger event - Format - Arguments - - - - true if this event is ignored. If the event is ignored, the caller can - choose not to call . This is useful if it can take time to - prepare the message. - - The logger event - - - - Dummy logger which ignores all messages, but can optionally throw on errors. - - - - - It ignores everything and doesn't throw anything. - - - - - Throws a on errors, but ignores anything else. - - - - - Constructor - - If non-null, this exception type is thrown on - errors. It must have a public constructor that takes a as the only - argument. - - - - - - - - - - A high-level representation of a row in the ImplMap table - - - - - The row id in its table - - - - - - - - - - - From column ImplMap.MappingFlags - - - - Attributes - - - - From column ImplMap.ImportName - - - - Name - - - - From column ImplMap.ImportScope - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the char set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets best fit - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets throw on unmappable char - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets calling convention - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - true if it's the specified P/Invoke method, else false - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - Treat as Windows - true if it's the specified P/Invoke method, else false - - - - An ImplMap row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Scope - Name - Flags - - - - Created from a row in the ImplMap table - - - - - - - - Constructor - - The module which contains this ImplMap row - Row ID - If is null - If is invalid - - - - options - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s, s and s - whenever possible if the definition is located in this module. - - - - - - - - Don't set this flag. For internal use only. - - - - - Re-maps entities that were renamed in the target module - - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Overrides default behavior of - May be used to use reference assemblies for resolution, for example. - - to create for. - or null to use default 's type resolution - - - - Imports s, s, s - and s as references - - - - - Constructor - - The module that will own all references - - - - Constructor - - The module that will own all references - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - Mapper for renamed entities - - - - Imports a as a . If it's a type that should be - the declaring type of a field/method reference, call instead. - - The type - The imported type or null if is invalid - - - - Imports a as a . Should be called if it's the - declaring type of a method/field reference. See also - - The type - - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a . This will be either - a or a . - - The method - Always verify method signature to make sure the - returned reference matches the metadata in the source assembly - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a - - The field - Always verify field signature to make sure the - returned reference matches the metadata in the source assembly - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as an - - The field - The imported type or null if is invalid - - - - Imports a as an - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - A high-level representation of a row in the InterfaceImpl table - - - - - The row id in its table - - - - - - - - - - - - - - From column InterfaceImpl.Interface - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - An InterfaceImpl row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The interface the type implements - - - - Created from a row in the InterfaceImpl table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this InterfaceImpl row - Row ID - Generic parameter context - If is null - If is invalid - - - - Resolves types, methods, fields - - - - - Resolves types - - - - - Resolves a type - - The type - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves fields and methods - - - - - Resolves a method or a field - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves tokens - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Interface to get the full name of a type - - - - - true if it's a value type - - - - - Returns the name of this type - - - - - Returns the reflection name of this type - - - - - Returns the namespace of this type - - - - - Returns the reflection namespace of this type - - - - - Returns the reflection name of this type. See also . - - - - - Returns the reflection name of this type, and includes the assembly name where the - type is located. It can be passed to to - load the type. - - - - - Gets the assembly where this type is defined - - - - - Gets the scope, which is different from since it - can differentiate between modules within the same assembly. - - - - - Gets the type whose scope is returned by and whose assembly - is returned by . This is always a - , or null. It can also be a - nested . - For example, if this type is a System.String&, then this value is a System.String. - If it's a generic instance type (eg. List<int>), then the generic type is - returned (eg. List<T>). In other words, the first or - that is found (without searching generic arguments) is returned. - - - - - true if it's an integer or a floating point type - - - - - Implemented by types and calling convention signatures. - - - - - true if this contains a or a . - - - - - Finds s - - - - - Finds a - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . 's scope (i.e., module or - assembly) is ignored when looking up the type. - - The type ref - An existing or null if it wasn't found. - - - - Interface to access a local or a parameter - - - - - Gets the variable type - - - - - Gets the 0-based position - - - - - Gets/sets the variable name - - - - - A high-level representation of a row in the ManifestResource table - - - - - The row id in its table - - - - - - - - - - - - - - From column ManifestResource.Offset - - - - - - - - From column ManifestResource.Flags - - - - Attributes - - - - From column ManifestResource.Name - - - - Name - - - - From column ManifestResource.Implementation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - A ManifestResource row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - Implementation - - - - Constructor - - Name - Implementation - Flags - - - - Constructor - - Name - Implementation - Flags - Offset - - - - Created from a row in the ManifestResource table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ManifestResource row - Row ID - If is null - If is invalid - - - - ManifestResource flags. See CorHdr.h/CorManifestResourceFlags - - - - - - - The Resource is exported from the Assembly. - - - The Resource is private to the Assembly. - - - - Reads s - - - - - Reads a from the #Blob heap - - Module - Blob offset - A new instance - - - - Reads a from the #Blob heap - - Module - Blob offset - Generic parameter context - A new instance - - - - Reads a from - - Owner module - Marshal data - A new instance - - - - Reads a from - - Owner module - Marshal data - Generic parameter context - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - Generic parameter context - A new instance - - - - Base class of all marshal types - - - - - The native type - - - - - Gets the - - - - - Constructor - - Native type - - - - - - - Contains the raw marshal blob data - - - - - Gets/sets the raw data - - - - - Constructor - - Raw data - - - - A marshal type - - - - - Gets/sets the size - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - - - - A marshal type - - - - - Gets/sets the variant type - - - - - Gets/sets the user-defined sub type (it's usually null) - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Variant type - - - - Constructor - - User-defined sub type - - - - Constructor - - Variant type - User-defined sub type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the size - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - Constructor - - Size - Element type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the parameter number - - - - - Gets/sets the size of the array - - - - - Gets/sets the flags - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if ntaSizeParamIndexSpecified bit is set, false if it's not - set or if is invalid. - - - - - true if ntaSizeParamIndexSpecified bit is not set, false if it's - set or if is invalid. - - - - - Default constructor - - - - - Constructor - - Element type - - - - Constructor - - Element type - Parameter number - - - - Constructor - - Element type - Parameter number - Number of elements - - - - Constructor - - Element type - Parameter number - Number of elements - Flags - - - - - - - A marshal type - - - - - Gets/sets the GUID string - - - - - Gets/sets the native type name string - - - - - Gets/sets the custom marshaler - - - - - Gets/sets the cookie string - - - - - Default constructor - - - - - Constructor - - GUID string - - - - Constructor - - GUID string - Native type name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - Cookie string - - - - - - - A , or a - marshal type - - - - - Gets/sets the IID parameter index - - - - - true if is valid - - - - - Constructor - - Native type - - - - Constructor - - Native type - IID parameter index - - - - - - - Metadata token - - - - - Mask to get the rid from a raw metadata token - - - - - Max rid value - - - - - Number of bits to right shift a raw metadata token to get the table index - - - - - Returns the table type - - - - - Returns the row id - - - - - Returns the raw token - - - - - Returns true if it's a null token - - - - - Constructor - - Raw token - - - - Constructor - - Raw token - - - - Constructor - - The table type - Row id - - - - Constructor - - The table type - Row id - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Gets the token as a raw 32-bit signed integer - - - - - Gets the token as a raw 32-bit unsigned integer - - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Represents the #Blob stream - - - - - - - - - - - Reads data - - Offset of data - The data or null if invalid offset - - - - Reads data just like , but returns an empty array if - offset is invalid - - Offset of data - The data - - - - Creates a reader that can access a blob - - Offset of blob - A new stream - - - - Creates a reader that can access a blob or returns false on failure - - Offset of blob - Updated with the reader - - - - - Contains all possible coded token classes - - - - TypeDefOrRef coded token - - - HasConstant coded token - - - HasCustomAttribute coded token - - - HasFieldMarshal coded token - - - HasDeclSecurity coded token - - - MemberRefParent coded token - - - HasSemantic coded token - - - MethodDefOrRef coded token - - - MemberForwarded coded token - - - Implementation coded token - - - CustomAttributeType coded token - - - ResolutionScope coded token - - - TypeOrMethodDef coded token - - - HasCustomDebugInformation coded token - - - - Returns all types of tables - - - - - Returns the number of bits that is used to encode table type - - - - - Constructor - - Number of bits used to encode token type - All table types - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - true if successful - - - - Encodes a token - - The token - Coded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Info about one column in a MD table - - - - - Gets the column index - - - - - Returns the column offset within the table row - - - - - Returns the column size - - - - - Returns the column name - - - - - Returns the ColumnSize enum value - - - - - Constructor - - Column index - The column name - Column size - - - - Constructor - - Column index - The column name - Column size - Offset of column - Size of column - - - - Reads the column - - A reader positioned on this column - The column value - - - - Writes a column - - The writer position on this column - The column value - - - - MD table column size - - - - RID into Module table - - - RID into TypeRef table - - - RID into TypeDef table - - - RID into FieldPtr table - - - RID into Field table - - - RID into MethodPtr table - - - RID into Method table - - - RID into ParamPtr table - - - RID into Param table - - - RID into InterfaceImpl table - - - RID into MemberRef table - - - RID into Constant table - - - RID into CustomAttribute table - - - RID into FieldMarshal table - - - RID into DeclSecurity table - - - RID into ClassLayout table - - - RID into FieldLayout table - - - RID into StandAloneSig table - - - RID into EventMap table - - - RID into EventPtr table - - - RID into Event table - - - RID into PropertyMap table - - - RID into PropertyPtr table - - - RID into Property table - - - RID into MethodSemantics table - - - RID into MethodImpl table - - - RID into ModuleRef table - - - RID into TypeSpec table - - - RID into ImplMap table - - - RID into FieldRVA table - - - RID into ENCLog table - - - RID into ENCMap table - - - RID into Assembly table - - - RID into AssemblyProcessor table - - - RID into AssemblyOS table - - - RID into AssemblyRef table - - - RID into AssemblyRefProcessor table - - - RID into AssemblyRefOS table - - - RID into File table - - - RID into ExportedType table - - - RID into ManifestResource table - - - RID into NestedClass table - - - RID into GenericParam table - - - RID into MethodSpec table - - - RID into GenericParamConstraint table - - - RID into Document table - - - RID into MethodDebugInformation table - - - RID into LocalScope table - - - RID into LocalVariable table - - - RID into LocalConstant table - - - RID into ImportScope table - - - RID into StateMachineMethod table - - - RID into CustomDebugInformation table - - - 8-bit byte - - - 16-bit signed int - - - 16-bit unsigned int - - - 32-bit signed int - - - 32-bit unsigned int - - - Index into #Strings stream - - - Index into #GUID stream - - - Index into #Blob stream - - - TypeDefOrRef encoded token - - - HasConstant encoded token - - - HasCustomAttribute encoded token - - - HasFieldMarshal encoded token - - - HasDeclSecurity encoded token - - - MemberRefParent encoded token - - - HasSemantic encoded token - - - MethodDefOrRef encoded token - - - MemberForwarded encoded token - - - Implementation encoded token - - - CustomAttributeType encoded token - - - ResolutionScope encoded token - - - TypeOrMethodDef encoded token - - - HasCustomDebugInformation encoded token - - - - See COMIMAGE_FLAGS_XXX in CorHdr.h in the Windows SDK - - - - - See COMIMAGE_FLAGS_ILONLY in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITREQUIRED in the Windows SDK - - - - - Set if a native header exists (COMIMAGE_FLAGS_IL_LIBRARY) - - - - - See COMIMAGE_FLAGS_STRONGNAMESIGNED in the Windows SDK - - - - - See COMIMAGE_FLAGS_NATIVE_ENTRYPOINT in the Windows SDK - - - - - See COMIMAGE_FLAGS_TRACKDEBUGDATA in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITPREFERRED in the Windows SDK - - - - - Used when a #~ stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - A custom .NET metadata stream - - - - - Constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - .NET metadata stream - - - - - Reader that can access the whole stream. - - NOTE: Always copy this field to a local variable before using it since it must be thread safe. - - - - - null if it wasn't present in the file - - - - - - - - - - - Gets the length of this stream in the metadata - - - - - Gets the stream header - - - - - Gets the name of the stream - - - - - Gets a data reader that can read the full stream - - - - - - Default constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - Called after gets recreated - - - - - - - - Dispose method - - true if called by - - - - Checks whether an index is valid - - The index - true if the index is valid - - - - Check whether an offset is within the stream - - Stream offset - true if the offset is valid - - - - Check whether an offset is within the stream - - Stream offset - Size of data - true if the offset is valid - - - - Base class of #US, #Strings, #Blob, and #GUID classes - - - - - - - - - - - Initializes .NET table row sizes - - - - - Initializes the table sizes - - true if #Strings size >= 0x10000 - true if #GUID size >= 0x10000 - true if #Blob size >= 0x10000 - Count of rows in each table - Count of rows in each table (debug tables) - - - - Creates the table infos - - Major table version - Minor table version - All table infos (not completely initialized) - - - - Creates the table infos - - Major table version - Minor table version - Initialized to max present tables (eg. 42 or 45) - All table infos (not completely initialized) - - - - Used when a #- stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - Converts a logical Field rid to a physical Field rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Method rid to a physical Method rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Param rid to a physical Param rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Event rid to a physical Event rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Property rid to a physical Property rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - Linear searches the table (O(n)) for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - - - - Represents the #GUID stream - - - - - - - - - - - - - - Read a - - Index into this stream - A or null if is 0 or invalid - - - - Heap type. The values are set in stone by MS. Don't change. - - - - #Strings heap - - - #GUID heap - - - #Blob heap - - - #US heap - - - - Represents the IMAGE_COR20_HEADER structure - - - - - Returns true if it has a native header - - - - - Returns the IMAGE_COR20_HEADER.cb field - - - - - Returns the IMAGE_COR20_HEADER.MajorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.MinorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.Metadata field - - - - - Returns the IMAGE_COR20_HEADER.Flags field - - - - - Returns the IMAGE_COR20_HEADER.EntryPointToken/EntryPointTokenRVA field - - - - - Returns the IMAGE_COR20_HEADER.Resources field - - - - - Returns the IMAGE_COR20_HEADER.StrongNameSignature field - - - - - Returns the IMAGE_COR20_HEADER.CodeManagerTable field - - - - - Returns the IMAGE_COR20_HEADER.VTableFixups field - - - - - Returns the IMAGE_COR20_HEADER.ExportAddressTableJumps field - - - - - Returns the IMAGE_COR20_HEADER.ManagedNativeHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Reads metadata table columns - - - - - Reads a column - - The table to read from - Table row id - The column to read - Result - true if was updated, false if - the column should be read from the original table. - - - - Reads table rows - - Raw row - - - - Reads a table row or returns false if the row should be read from the original table - - Row id - The row - - - - - Version strings found in the meta data header - - - - - MS CLR 1.0 version string (.NET 1.0) - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.1 version string (.NET 1.1) - - - - - MS CLR 2.0 version string (.NET 2.0-3.5) - - - - - MS CLR 4.0 version string (.NET 4.0-4.5) - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.1 any version - - - - - MS CLR 2.0 any version - - - - - MS CLR 4.0 any version - - - - - ECMA 2002 version string - - - - - ECMA 2005 version string - - - - - Portable PDB v1.0 - - - - - MDStream flags - - - - #Strings stream is big and requires 4 byte offsets - - - #GUID stream is big and requires 4 byte offsets - - - #Blob stream is big and requires 4 byte offsets - - - - - - - - - Extra data follows the row counts - - - Set if certain tables can contain deleted rows. The name column (if present) is set to "_Deleted" - - - - A MD table (eg. Method table) - - - - - - - - - - - Gets the table - - - - - Gets the name of this table - - - - - Returns total number of rows - - - - - Gets the total size in bytes of one row in this table - - - - - Returns all the columns - - - - - Returns true if there are no valid rows - - - - - Returns info about this table - - - - - Constructor - - The table - Number of rows in this table - Info about this table - - - - Checks whether the row exists - - Row ID - - - - Checks whether the row does not exist - - Row ID - - - - - - - Reads .NET metadata - - - - - true if the compressed (normal) metadata is used, false if the non-compressed - (Edit N' Continue) metadata is used. This can be false even if the table stream - is #~ but that's very uncommon. - - - - - true if this is standalone Portable PDB metadata - - - - - Gets the .NET header - - - - - Gets the version found in the metadata header. The major version number is in the high 16 bits - and the lower version number is in the low 16 bits. - - - - - Gets the version string found in the metadata header - - - - - Gets the - - - - - Gets the metadata header - - - - - Returns the #Strings stream or a default empty one if it's not present - - - - - Returns the #US stream or a default empty one if it's not present - - - - - Returns the #Blob stream or a default empty one if it's not present - - - - - Returns the #GUID stream or a default empty one if it's not present - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Pdb stream or null if it's not a standalone portable PDB file - - - - - Gets all streams - - - - - Gets a list of all the valid TypeDef rids. It's usually every rid in the - TypeDef table, but could be less if a type has been deleted. - - - - - Gets a list of all the valid ExportedType rids. It's usually every rid in the - ExportedType table, but could be less if a type has been deleted. - - - - - Gets the Field rid list - - TypeDef rid - A new instance - - - - Gets the Method rid list - - TypeDef rid - A new instance - - - - Gets the Param rid list - - Method rid - A new instance - - - - Gets the Event rid list - - EventMap rid - A new instance - - - - Gets the Property rid list - - PropertyMap rid - A new instance - - - - Finds all InterfaceImpl rids owned by - - Owner TypeDef rid - A instance containing the valid InterfaceImpl rids - - - - Finds all GenericParam rids owned by in table - - A TypeOrMethodDef table - Owner rid - A instance containing the valid GenericParam rids - - - - Finds all GenericParamConstraint rids owned by - - Owner GenericParam rid - A instance containing the valid GenericParamConstraint rids - - - - Finds all CustomAttribute rids owned by in table - - A HasCustomAttribute table - Owner rid - A instance containing the valid CustomAttribute rids - - - - Finds all DeclSecurity rids owned by in table - - A HasDeclSecurity table - Owner rid - A instance containing the valid DeclSecurity rids - - - - Finds all MethodSemantics rids owned by in table - - A HasSemantic table - Owner rid - A instance containing the valid MethodSemantics rids - - - - Finds all MethodImpl rids owned by - - Owner TypeDef rid - A instance containing the valid MethodImpl rids - - - - Finds a ClassLayout rid - - Owner TypeDef rid - The ClassLayout rid or 0 if is invalid - or if it has no row in the ClassLayout table. - - - - Finds a FieldLayout rid - - Owner Field rid - The FieldLayout rid or 0 if is invalid - or if it has no row in the FieldLayout table. - - - - Finds a FieldMarshal rid - - A HasFieldMarshal table - Owner rid - The FieldMarshal rid or 0 if is invalid - or if it has no row in the FieldMarshal table. - - - - Finds a FieldRVA rid - - Owner Field rid - The FieldRVA rid or 0 if is invalid - or if it has no row in the FieldRVA table. - - - - Finds an ImplMap rid - - A MemberForwarded table - Owner rid - The ImplMap rid or 0 if is invalid - or if it has no row in the ImplMap table. - - - - Finds a NestedClass rid - - Owner TypeDef rid - The NestedClass rid or 0 if is invalid - or if it has no row in the NestedClass table. - - - - Finds an EventMap rid - - Owner TypeDef rid - The EventMap rid or 0 if is invalid - or if it has no row in the EventMap table. - - - - Finds a PropertyMap rid - - Owner TypeDef rid - The PropertyMap rid or 0 if is invalid - or if it has no row in the PropertyMap table. - - - - Finds a Constant rid - - A HasConstant table - Owner rid - The Constant rid or 0 if is invalid - or if it has no row in the Constant table. - - - - Returns the owner TypeDef rid - - A Field rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Method rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Event rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Property rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeOrMethodDef rid - - A GenericParam rid - The owner TypeOrMethodDef rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner GenericParam rid - - A GenericParamConstraint rid - The owner GenericParam rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner Method rid - - A Param rid - The owner Method rid or 0 if is invalid - or if it has no owner. - - - - Gets a list of all nested classes owned by - - A TypeDef rid - A new instance - - - - Gets a list of all non-nested classes. A type is a non-nested type if - returns an empty list. - - A new instance - - - - Finds all LocalScope rids owned by - - Owner Method rid - A instance containing the valid LocalScope rids - - - - Gets the StateMachineMethod rid or 0 if it's not a state machine method - - Owner Method rid - - - - - Finds all CustomDebugInformation rids owned by in table - - A HasCustomDebugInformation table - Owner rid - A instance containing the valid CustomDebugInformation rids - - - - Disposes of this instance - - - - - Common base class for #~ and #- metadata classes - - - - - The PE image - - - - - The .NET header - - - - - The MD header - - - - - The #Strings stream - - - - - The #US stream - - - - - The #Blob stream - - - - - The #GUID stream - - - - - The #~ or #- stream - - - - - The #Pdb stream - - - - - All the streams that are present in the PE image - - - - true if this is standalone Portable PDB metadata - - - - Sorts a table by key column - - - - - Remembers rid and key - - - - - Constructor - - Row ID - Key - - - - Constructor - - The MD table - Index of key column - - - - Binary searches for a row with a certain key - - The key - The row or 0 if not found - - - - Find all rids that contain - - The key - A new instance - - - - Constructor - - The PE image - The .NET header - The MD header - - - - Initializes the metadata, tables, streams - - - - - Creates empty heap objects if they're not present in the metadata - - - - - Called by - - - - - Binary searches the table for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - Finds all rows owned by in table - whose index is - - Table to search - Key column index - Key - A instance - - - - Finds all rows owned by in table - whose index is . Should be called if - could be unsorted. - - Table to search - Key column index - Key - A instance - - - - Dispose method - - true if called by - - - - Low level access to a .NET file's metadata - - - - - Create a instance - - The PE image - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - A new instance - - - - Create a instance - - The PE image - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a standalone portable PDB instance - - Metadata stream - true if we should verify that it's a .NET PE file - A new instance - - - - Represents the .NET metadata header - - IMAGE_COR20_HEADER.Metadata points to this header - - - - Returns the signature (should be 0x424A5342) - - - - - Returns the major version - - - - - Returns the minor version - - - - - Returns the reserved dword (pointer to extra header data) - - - - - Returns the version string length value - - - - - Returns the version string - - - - - Returns the offset of STORAGEHEADER - - - - - Returns the flags (reserved) - - - - - Returns the reserved byte (padding) - - - - - Returns the number of streams - - - - - Returns all stream headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Constructor - - PE file reader pointing to the start of this section - Runtime reader kind - Verify section - Thrown if verification fails - - - - #Pdb stream - - - - - Gets the PDB id - - - - - Gets the entry point token or 0 - - - - - Gets the referenced type system tables in the PE metadata file - - - - - Gets all type system table rows. This array has exactly 64 elements. - - - - - - - - Equality comparer for all raw rows - - - - - Default instance - - - - - Raw contents of an uncompressed Module table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeDef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Field table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Method table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ParamPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Param table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed InterfaceImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MemberRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Constant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomAttribute table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldMarshal table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed DeclSecurity table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ClassLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StandAloneSig table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Event table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Property table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSemantics table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ModuleRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImplMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldRVA table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCLog table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Assembly table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed File table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ExportedType table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ManifestResource table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed NestedClass table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParam table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParamConstraint table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Document table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalVariable table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalConstant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImportScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StateMachineMethod table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Stores a list of rids - - - - - Gets the empty instance - - - - - Creates a new instance - - - - - - - - Creates a new instance - - List of valid rids - - - - - Gets the 'th rid - - Index. Must be < - A rid or 0 if is invalid - - - - Gets the number of rids it will iterate over - - - - - Enumerator - - - - - Gets the current rid - - - - - Disposes this instance - - - - - Moves to the next rid - - - - - - Gets the enumerator - - - - - - Storage flags found in the MD header - - - - - Normal flags - - - - - More data after the header but before the streams. - - The CLR will fail to load the file if this flag (or any other bits) is set. - - - - A metadata stream header - - - - - The offset of the stream relative to the start of the metadata header - - - - - The size of the stream - - - - - The name of the stream - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the #Strings stream - - - - - - - - - - - Reads a - - Offset of string - A instance or null if invalid offset - - - - Reads a . The empty string is returned if - is invalid. - - Offset of string - A instance - - - - The metadata tables - - - - Module table (00h) - - - TypeRef table (01h) - - - TypeDef table (02h) - - - FieldPtr table (03h) - - - Field table (04h) - - - MethodPtr table (05h) - - - Method table (06h) - - - ParamPtr table (07h) - - - Param table (08h) - - - InterfaceImpl table (09h) - - - MemberRef table (0Ah) - - - Constant table (0Bh) - - - CustomAttribute table (0Ch) - - - FieldMarshal table (0Dh) - - - DeclSecurity table (0Eh) - - - ClassLayout table (0Fh) - - - FieldLayout table (10h) - - - StandAloneSig table (11h) - - - EventMap table (12h) - - - EventPtr table (13h) - - - Event table (14h) - - - PropertyMap table (15h) - - - PropertyPtr table (16h) - - - Property table (17h) - - - MethodSemantics table (18h) - - - MethodImpl table (19h) - - - ModuleRef table (1Ah) - - - TypeSpec table (1Bh) - - - ImplMap table (1Ch) - - - FieldRVA table (1Dh) - - - ENCLog table (1Eh) - - - ENCMap table (1Fh) - - - Assembly table (20h) - - - AssemblyProcessor table (21h) - - - AssemblyOS table (22h) - - - AssemblyRef table (23h) - - - AssemblyRefProcessor table (24h) - - - AssemblyRefOS table (25h) - - - File table (26h) - - - ExportedType table (27h) - - - ManifestResource table (28h) - - - NestedClass table (29h) - - - GenericParam table (2Ah) - - - MethodSpec table (2Bh) - - - GenericParamConstraint table (2Ch) - - - (Portable PDB) Document table (30h) - - - (Portable PDB) MethodDebugInformation table (31h) - - - (Portable PDB) LocalScope table (32h) - - - (Portable PDB) LocalVariable table (33h) - - - (Portable PDB) LocalConstant table (34h) - - - (Portable PDB) ImportScope table (35h) - - - (Portable PDB) StateMachineMethod table (36h) - - - (Portable PDB) CustomDebugInformation table (37h) - - - - Info about one MD table - - - - - Returns the table type - - - - - Returns the total size of a row in bytes - - - - - Returns all the columns - - - - - Returns the name of the table - - - - - Constructor - - Table type - Table name - All columns - - - - Constructor - - Table type - Table name - All columns - Row size - - - - .NET metadata tables stream - - - - - Gets/sets the column reader - - - - - Gets/sets the Method table reader - - - - - Gets the reserved field - - - - - Gets the version. The major version is in the upper 8 bits, and the minor version - is in the lower 8 bits. - - - - - Gets - - - - - Gets the reserved log2 rid field - - - - - Gets the valid mask - - - - - Gets the sorted mask - - - - - Gets the extra data - - - - - Gets the MD tables - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - factory - Offset of metadata - Stream header - - - - Constructor - - factory - Offset of metadata - Stream header - Runtime kind - - - - Initializes MD tables - - Type system table rows (from #Pdb stream) - - - - - - - - - - Returns a MD table - - The table type - A or null if table doesn't exist - - - - Checks whether a table exists - - The table type - true if the table exists - - - - Checks whether table is sorted - - The table - - - - Reads a raw Module row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeDef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Field row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Method row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ParamPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Param row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw InterfaceImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MemberRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Constant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomAttribute row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldMarshal row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw DeclSecurity row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ClassLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StandAloneSig row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Event row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Property row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSemantics row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ModuleRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImplMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldRVA row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCLog row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Assembly row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw File row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ExportedType row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ManifestResource row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw NestedClass row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParam row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParamConstraint row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Document row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalVariable row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalConstant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImportScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StateMachineMethod row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a column - - The table - Row ID - Column index in - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Reads a column - - The table - Row ID - Column - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Represents the #US stream - - - - - - - - - - - Reads a unicode string - - Offset of unicode string - A string or null if is invalid - - - - Reads data just like , but returns an empty string if - offset is invalid - - Offset of unicode string - The string - - - - Finds types, fields, methods, etc in a module. If nothing has been added to the module, it's - faster to call ResolveMethodDef(), ResolveTypeRef() etc. - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - Finds all types, fields, etc - - The module to scan - Itself - - - - Methods to load properties to make sure they're initialized - - - - - Read every collection element - - Collection element type - Collection - - - - Load the object instance - - The value (ignored) - - - - A high-level representation of a row in the MemberRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - From column MemberRef.Class - - - - - - - - From column MemberRef.Name - - - - Name - - - - From column MemberRef.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if this is a method reference ( != null) - - - - - true if this is a field reference ( != null) - - - - - Gets/sets the method sig - - - - - Gets/sets the field sig - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - - - - Gets the full name - - - - - Get the declaring type's full name - - Full name or null if there's no declaring type - - - - Resolves the method/field - - A or a instance or null - if it couldn't be resolved. - - - - Resolves the method/field - - A or a instance - If the method/field couldn't be resolved - - - - Resolves the field - - A instance or null if it couldn't be resolved. - - - - Resolves the field - - A instance - If the field couldn't be resolved - - - - Resolves the method - - A instance or null if it couldn't be resolved. - - - - Resolves the method - - A instance - If the method couldn't be resolved - - - - Gets a that can be used as signature context - - Context passed to the constructor - Field/method class owner - - - - - - - - A MemberRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Name of ref - - - - Constructor - - Owner module - Name of field ref - Field sig - - - - Constructor - - Owner module - Name of field ref - Field sig - Owner of field - - - - Constructor - - Owner module - Name of method ref - Method sig - - - - Constructor - - Owner module - Name of method ref - Method sig - Owner of method - - - - Created from a row in the MemberRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MemberRef row - Row ID - Generic parameter context - If is null - If is invalid - - - - Method attributes, see CorHdr.h/CorMethodAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Method may not be overridden. - - - Method virtual. - - - Method hides by name+sig, else just by name. - - - vtable layout mask - Use this mask to retrieve vtable attributes. - - - The default. - - - Method always gets a new slot in the vtable. - - - Overridability is the same as the visibility. - - - Method does not provide an implementation. - - - Method is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Managed method exported via thunk to unmanaged code. - - - Runtime should check name encoding. - - - Method has security associate with it. - - - Method calls another method containing security code. - - - - A high-level representation of a row in the Method table - - - - - The row id in its table - - - - - All parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column Method.RVA - - - - - - - - From column Method.ImplFlags - - - - Implementation attributes - - - - From column Method.Flags - - - - Attributes - - - - From column Method.Name - - - - Name - - - - From column Method.Signature - - - - - - - - From column Method.ParamList - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the method body. See also - - - - - - - - - - - Frees the method body if it has been loaded. This does nothing if - returns false. - - - - Called to initialize - - - - true if can free the method body - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the methods this method implements - - - - - - - Initializes - - - - Gets the export info or null if the method isn't exported to unmanaged code. - - - - - - - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets/sets the CIL method body. See also - - - - - Gets/sets the native method body - - - - - true if there's at least one in - - - - - true if it has a - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets the full name - - - - - Gets/sets the - - - - - Gets the parameters - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - true if the method returns a value (i.e., return type is not ) - - - - - Gets/sets the method semantics attributes. If you remove/add a method to a property or - an event, you must manually update this property or eg. won't - work as expected. - - - - Set when has been initialized - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the method access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the code type - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the static type constructor - - - - - true if this is an instance constructor - - - - - true if this is a static or an instance constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A Method row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Method name - - - - Constructor - - Method name - Method sig - - - - Constructor - - Method name - Method sig - Flags - - - - Constructor - - Method name - Method sig - Impl flags - - - - Constructor - - Method name - Method sig - Impl flags - Flags - - - - Created from a row in the Method table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Method row - Row ID - If is null - If is invalid - - - - - - - - - - Contains the name and ordinal of a method that gets exported to unmanaged code. - - - - - Gets the ordinal or null - - - - - Gets the name. If it's null, and is also null, the name of the method - () is used as the exported name. - - - - - Gets the options - - - - - Constructor - - - - - Constructor - - Name or null to export by ordinal - - - - Constructor - - Ordinal - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - Options - - - - Exported method options - - - - - No bit is set - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - Method impl attributes, see CorHdr.h/CorMethodImpl - - - - Flags about code type. - - - Method impl is IL. - - - Method impl is native. - - - Method impl is OPTIL - - - Method impl is provided by the runtime. - - - Flags specifying whether the code is managed or unmanaged. - - - Method impl is unmanaged, otherwise managed. - - - Method impl is managed. - - - Indicates method is defined; used primarily in merge scenarios. - - - Indicates method sig is not to be mangled to do HRESULT conversion. - - - Reserved for internal use. - - - Method is single threaded through the body. - - - Method may not be inlined. - - - Method should be inlined if possible. - - - Method may not be optimized. - - - Method may contain hot code and should be aggressively optimized. - - - The JIT compiler should look for security mitigation attributes, such as the user-defined System.Runtime.CompilerServices.SecurityMitigationsAttribute. If found, the JIT compiler applies any related security mitigations. Available starting with .NET Framework 4.8. - - - - Describes which method some method implements - - - - - The method body. Usually a but could be a - - - - - The method implements - - - - - Constructor - - Method body - The method implements - - - - Method semantics flags, see CorHdr.h/CorMethodSemanticsAttr - - - - No bit is set - - - Setter for property - - - Getter for property - - - other method for property or event - - - AddOn method for event - - - RemoveOn method for event - - - Fire method for event - - - - A high-level representation of a row in the MethodSpec table - - - - - The row id in its table - - - - - - - - - - - - - - From column MethodSpec.Method - - - - - - - - From column MethodSpec.Instantiation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - Gets/sets the generic instance method sig - - - - - - - - - - - Gets the full name - - - - - - - - A MethodSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic method - - - - Constructor - - The generic method - The instantiated method sig - - - - Created from a row in the MethodSpec table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MethodSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - context - - - - - Gets/sets the assembly resolver. This is never null. - - - - - Gets/sets the resolver. This is never null. - - - - - Default constructor - - - - - Constructor - - Assembly resolver or null - - - - Constructor - - Type/method/field resolver or null - - - - Constructor - - Assembly resolver or null - Type/method/field resolver or null - - - - creation options - - - - - Module context - - - - - PDB reader options - - - - - Set it to A) the path (string) of the PDB file, B) the data (byte[]) of the PDB file or - C) to an of the PDB data. The will - be owned by the module. You don't need to initialize - - - - - If true, will load the PDB file from disk if present, or an embedded portable PDB file - stored in the PE file. The default value is true. - You don't need to initialize . - - - - - corlib assembly reference to use or null if the default one from the opened - module should be used. - - - - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - - Default constructor - - - - - Constructor - - Module context - - - - Constructor - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Constructor - - Module context - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Runtime reader kind - - - - - Microsoft's CLRs (.NET Framework, .NET Core) - - - - - Mono's CLR (Mono, Unity) - - - - - A high-level representation of a row in the Module table - - - - Default characteristics - - - Default DLL characteristics - - - - The row id in its table - - - - - Initialize this in the ctor - - - - - PDB state - - - - - Array of last used rid in each table. I.e., next free rid is value + 1 - - - - Module context - - - - - - - - - - - - - - - - Gets/sets a user value. This is never used by dnlib. This property isn't thread safe. - - - - - - - - - - - Gets/sets Module.Generation column - - - - - - - - Gets/sets Module.Name column - - - - Name - - - - Gets/sets Module.Mvid column - - - - - - - - Gets/sets Module.EncId column - - - - - - - - Gets/sets Module.EncBaseId column - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the module's assembly. To set this value, add this - to . - - - - - - - - Gets a list of all non-nested s. See also - - - - - - - Initializes - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the native entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - Gets/sets the managed entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - - - - - - - - - Called to initialize - - - Called to initialize - - - - - - - Gets/sets the entry point method - - - - - true if is non-zero - - - - - true if is non-null - - - - - true if is non-null - - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the . This is null if there are no - vtable fixups. - - - - - - - - - - Called to initialize - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - - - - Gets/sets the path of the module or an empty string if it wasn't loaded from disk - - - - - - - - Gets the - - - - - Gets the instance - - - - - Gets/sets the module context. This is never null. - - - - - If true, the cache is enabled. The cache is used by - and to find types. -

- IMPORTANT: Only enable the cache if this module's types keep their exact - name, namespace, and declaring type and if no type is either added or - removed from or from any type that is reachable from the - top-level types in (i.e., any type owned by this module). - This is disabled by default. When disabled, all calls to - and will result in a slow O(n) (linear) search. -
- -
- - - true if this is the manifest (main) module - - - - - Gets the global (aka. <Module>) type or null if there are no types - - - - - true if it's the core library module, false if it's not the core library module, - and null if it's not known. - - - - - Gets/sets the Win32 resources - - - - - - - - - - Called to initialize - - - - Gets the . This is null if no PDB file - has been loaded or if no PDB file could be found. - - - - - Module kind - - - - - Gets/sets the characteristics (from PE file header) - - - - - Gets/sets the DLL characteristics (from PE optional header) - - - - - Gets/sets the runtime version which is stored in the metadata header. - See . - - Not thread safe - - - - Gets the WinMD status - - Not thread safe - - - - true if this is a WinMD file - - - - - true if this is a managed WinMD file - - - - - true if this is a pure (non-managed) WinMD file - - - - - Gets the CLR runtime version of the managed WinMD file or null if none. This is - similar to for normal non-WinMD files. - - Not thread safe - - - - Gets the WinMD version or null if none - - Not thread safe - - - - true if is the CLR v1.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.0 string - - - - - true if is the CLR v1.1 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.1 string - - - - - true if is the CLR v1.0 or v1.1 string (only the - major and minor version numbers are checked) - - - - - true if is the CLR v1.0 or v1.1 string - - - - - true if is the CLR v2.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v2.0 string - - - - - true if is the CLR v4.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v4.0 string - - - - - true if is the ECMA 2002 string - - - - - true if is the ECMA 2005 string - - - - - Gets/sets the (from PE header) - - - - - true if is , , ... - - - - - true if is - - - - - true if is , , ... - - - - - true if is , , ... - - - - - true if is , , ... - - - - - Gets/sets the (from .NET header) - - - - - - - - Gets/sets the runtime version number in the COR20 header. The major version is - in the high 16 bits. The minor version is in the low 16 bits. This is normally 2.5 - (0x00020005), but if it's .NET 1.x, it should be 2.0 (0x00020000). If this is - null, the default value will be used when saving the module (2.0 if CLR 1.x, - and 2.5 if not CLR 1.x). - - - - - Gets the tables header version. The major version is in the upper 8 bits and the - minor version is in the lower 8 bits. .NET 1.0/1.1 use version 1.0 (0x0100) and - .NET 2.x and later use version 2.0 (0x0200). 1.0 has no support for generics, - 1.1 has support for generics (GenericParam rows have an extra Kind column), - and 2.0 has support for generics (GenericParam rows have the standard 4 columns). - No other version is supported. If this is null, the default version is - used (1.0 if .NET 1.x, else 2.0). - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - Dispose method - - true if called by - - - - Gets all the types (including nested types) present in this module - - - - - Adds as a non-nested type. If it's already nested, its - will be set to null. - - The to insert - - - - Updates the rid to the next free rid available. It's only updated if - the original rid is 0. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Updates the rid to the next free rid available. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as a - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the module to a stream. - - Destination stream - - - - Writes the module to a stream. - - Destination stream - Writer options - - - - Resets the cache which can be enabled by setting - to true. Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - Creates a new - - PDB file kind - - - - Sets a - - New - - - - Returns the size of a pointer. Assumes it's 32-bit if pointer size is unknown or - if it can be 32-bit or 64-bit. - - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size if it's not known or if it - can be 32-bit or 64-bit - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size - Pointer size if it's prefer-32-bit (should usually be 4) - - - - - - - - - - - - - - - - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable if possible - (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Finds a - - The type - A or null if it wasn't found - - - - Creates a new instance. There should normally only be one - instance shared by all s. - - A new instance - - - - Load everything in this module. All types, fields, asm refs, etc are loaded, all their - properties are read to make sure everything is cached. - - Cancellation token or null - - - - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Gets all s - - - - - Gets all s - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - Generic parameter context - - - - Gets all s - - - - - Finds an assembly reference by name. If there's more than one, pick the one with - the greatest version number. - - Simple name of assembly (eg. "mscorlib") - The found or null if there's no such - assembly reference. - - - - Compare asm refs' version - - First asm ref - New asm ref - - - - - A Module row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - is initialized to a random - Module nam - - - - Constructor - - Module name - Module version ID - - - - Constructor - - Module name - Module version ID - Corlib assembly ref or null - - - - Created from a row in the Module table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Module row - Row ID - If is null - If is invalid - - - - Initialize fields from the raw Module row - - - - - Created from a row in the Module table - - - - The file that contains all .NET metadata - - - - Gets/sets the method decrypter - - - - - Gets/sets the string decrypter - - - - - Returns the .NET metadata interface - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Strings stream - - - - - Returns the #Blob stream - - - - - Returns the #GUID stream - - - - - Returns the #US stream - - - - - - - - - - - - - - - - - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance - - PE image - A new instance - - - - Creates a instance - - PE image - Module context or null - A new instance - - - - Creates a instance - - PE image - Module creation options or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module context or null - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module creation options or null - A new instance - If is null - - - - Creates a instance from a - - The metadata - Module creation options or null - A new instance that now owns - - - - Constructor - - The metadata - Module creation options or null - If is null - - - - Loads symbols using - - PDB symbol reader - - - - Loads symbols from a PDB file - - PDB file name - - - - Loads symbols from a PDB file - - PDB reader options - PDB file name - - - - Loads symbols from a byte array - - PDB data - - - - Loads symbols from a byte array - - PDB reader options - PDB data - - - - Loads symbols from a stream - - PDB file stream which is now owned by us - - - - Loads symbols from a stream - - PDB reader options - PDB file stream which is now owned by us - - - - Loads symbols if a PDB file is available - - - - - Loads symbols if a PDB file is available - - PDB reader options - - - - Finds a mscorlib - - An existing instance or null if it wasn't found - - - - Called when no corlib assembly reference was found - - - - - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasConstant coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasFieldMarshal coded token - A or null if is invalid - - - - Resolves a - - A HasDeclSecurity coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasSemantic coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A MemberForwarded coded token - A or null if is invalid - - - - Resolves an - - An Implementation coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A ResolutionScope coded token - A or null if is invalid - - - - Resolves a - - A TypeOrMethodDef> coded token - A or null if is invalid - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a from the blob - - Table of owner - Row ID of owner - Generic parameter context - A new instance or null if there's no field - marshal for this owner. - - - - Reads a CIL method body - - Method parameters - RVA - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Reads a CIL method body - - Method parameters - RVA - Generic parameter context - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Returns the owner type of a field - - The field - The owner type or null if none - - - - Returns the owner type of a method - - The method - The owner type or null if none - - - - Returns the owner type of an event - - The event - The owner type or null if none - - - - Returns the owner type of a property - - The property - The owner type or null if none - - - - Returns the owner type/method of a generic param - - The generic param - The owner type/method or null if none - - - - Returns the owner generic param of a generic param constraint - - The generic param constraint - The owner generic param or null if none - - - - Returns the owner method of a param - - The param - The owner method or null if none - - - - Reads a module - - File rid - The assembly owning the module we should read - A new instance or null if - is invalid or if it's not a .NET module. - - - - Gets a list of all File rids that are .NET modules. Call - to read one of these modules. - - A new instance - - - - Concatenates the inputs and returns the result if it's a valid path - - Base dir - File name - Full path to the file or null if one of the inputs is invalid - - - - Gets the base directory where this .NET module is located on disk - - Base directory or null if unknown or if an error occurred - - - - Creates a instance - - ManifestResource rid - A new instance - - - - Reads a - - Custom attribute rid - A new instance or null if - is invalid - - - - Reads a - - Custom attribute rid - Generic parameter context - A new instance or null if - is invalid - - - - Reads data somewhere in the address space of the image - - RVA of data - Size of data - All the data or null if or - is invalid - - - - Gets the native entry point or 0 if none - - - - - Gets the managed entry point (a Method or a File) or null if none - - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - Generic parameter context - A new instance - - - - Reads a method body - - Method - Method RVA - Method impl attrs - Generic parameter context - A or null if none - - - - Updates with the PDB info (if any) - - Owner method - Method body - Returns originak value - - - - Reads a string from the #US heap - - String token - A non-null string - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the mixed-mode module to a stream. - - Destination stream - - - - Writes the mixed-mode module to a stream. - - Destination stream - Writer options - - - - Reads data from the #Blob. The following columns are returned: - Field.Signature - Method.Signature - MemberRef.Signature - Constant.Value - CustomAttribute.Value - FieldMarshal.NativeType - DeclSecurity.PermissionSet - StandAloneSig.Signature - Property.Type - TypeSpec.Signature - Assembly.PublicKey - AssemblyRef.PublicKeyOrToken - File.HashValue - MethodSpec.Instantiation - - A token - The value in the #Blob or null if is invalid - - - - Module kind - - - - - Console UI module - - - - - Windows GUI module - - - - - DLL module - - - - - Netmodule (it has no assembly manifest) - - - - - A high-level representation of a row in the ModuleRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - From column ModuleRef.Name - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Gets the definition module, i.e., the module which it references, or null - if the module can't be found. - - - - - Gets the definition assembly, i.e., the assembly of the module it references, or - null if the assembly can't be found. - - - - - - - - - - - A ModuleRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Module name - - - - Created from a row in the ModuleRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ModuleRef row - Row ID - If is null - If is invalid - - - - Native types used by field marshals. See CorHdr.h/CorNativeType - - - - Deprecated - - - void - - - bool - - - int8 - - - unsigned int8 - - - int16 - - - unsigned int16 - - - int32 - - - unsigned int32 - - - int64 - - - unsigned int64 - - - float32 - - - float64 - - - syschar - - - variant - - - currency - - - ptr - - - decimal - - - date - - - bstr - - - lpstr - - - lpwstr - - - lptstr - - - fixed sysstring - - - objectref - - - iunknown - - - idispatch - - - struct - - - interface - - - safearray - - - fixed array - - - int - - - uint - - - nested struct - - - byvalstr - - - ansi bstr - - - tbstr - - - variant bool - - - func - - - as any - - - array - - - lpstruct - - - custom marshaler - - - error - - - iinspectable - - - hstring - - - UTF-8 encoded string - - - first invalid element type - - - Value wasn't present in the blob - - - Raw marshal blob type - - - - A resolver that always fails - - - - - The one and only instance of this type - - - - - - - - - - - - - - Parameter flags. See CorHdr.h/CorParamAttr - - - - Param is [In] - - - Param is [out] - - - Param is a locale identifier - - - Param is a return value - - - Param is optional - - - Param has default value. - - - Param has FieldMarshal. - - - - A high-level representation of a row in the Param table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - Gets the declaring method - - - - - - - - From column Param.Flags - - - - Attributes - - - - From column Param.Sequence - - - - - - - - From column Param.Name - - - - Name - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - A Param row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Sequence - - - - Constructor - - Name - Sequence - Flags - - - - Created from a row in the Param table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Param row - Row ID - If is null - If is invalid - - - - A list of all method parameters - - - - - Gets the owner method - - - - - Gets the number of parameters, including a possible hidden 'this' parameter - - - - - Gets the index of the first parameter that is present in the method signature. - If this is a static method, the value is 0, else it's an instance method so the - index is 1 since the first parameter is the hidden 'this' parameter. - - - - - Gets the N'th parameter - - The parameter index - - - - Gets the method return parameter - - - - - Constructor - - The method with all parameters - 's declaring type - - - - Should be called when the method's declaring type has changed - - Method declaring type - - - - Should be called when the method sig has changed - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - A method parameter - - - - - The hidden 'this' parameter's - - - - - The return type parameter's - - - - - Gets the parameter index. If the method has a hidden 'this' parameter, that parameter - has index 0 and the remaining parameters in the method signature start from index 1. - The method return parameter has index -1. - - - - - Gets the index of the parameter in the method signature. See also - and - - - - - true if it's a normal visible method parameter, i.e., it's not the hidden - 'this' parameter and it's not the method return type parameter. - - - - - true if it's the hidden 'this' parameter - - - - - true if it's the method return type parameter - - - - - Gets the parameter type - - - - - Gets the owner method - - - - - Gets the or null if not present - - - - - true if it has a - - - - - Gets the name from . If is null, - an empty string is returned. - - - - - Constructor - - Parameter index - - - - Constructor - - Parameter index - Parameter type - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - Parameter type - - - - Creates a if it doesn't already exist - - - - - - - - Custom debug info guids - - - - - Implements and uses a as the underlying - stream. - - - - - Constructor - - Source stream - - - - Constructor - - Source stream - Name of original file or null if unknown. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - IMAGE_DEBUG_DIRECTORY - - - - - An address in the image - - - - - Section - - - - - Offset in - - - - - Constructor - - Section - Offset in - - - - Constructor - - Section - Offset in - - - - Returns true if is less than or equal to - - First - Second - - - - - Returns true if is less than - - First - Second - - - - - Returns true if is greater than or equal to - - First - Second - - - - - Returns true if is greater than - - First - Second - - - - - Returns true if is equal to - - First - Second - - - - - Returns true if is not equal to - - First - Second - - - - - Compares this instance with and returns less than 0 if it's - less than , 0 if it's equal to and - greater than 0 if it's greater than - - Other instance - - - - - Compares this to another instance - - The other one - true if they're equal - - - - Compares this to another instance - - The other one - true if they're equal - - - - Gets the hash code - - Hash code - - - - ToString() override - - - - - - Reads a 32-bit offset followed by a 16-bit section and creates a new - - Reader - - - - - Exception that is thrown when encounters an error. - - - - - Constructor - - - - - Constructor - - Exception message - - - - Constructor - - Inner exception - - - - Constructor - - - - - - - A managed PDB reader implementation for .NET modules. - - - - - Read the PDB in the specified stream. - - PDB file data reader - - - - Creates a instance - - - - - Creates a new instance - - PDB context - PDB file stream which is now owned by this method - A new instance or null. - - - - A constant in a method scope, eg. "const int SomeConstant = 123;" - - - - - Gets/sets the name - - - - - Gets/sets the type of the constant - - - - - Gets/sets the value of the constant - - - - - Constructor - - - - - Constructor - - Name of constant - Type of constant - Constant value - - - - - - - - - - Gets all custom debug infos - - - - - ToString() - - - - - - Custom debug info kind - - See CustomDebugInfoKind in Roslyn source code - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unknown - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class of custom debug info added to the PDB file by the compiler - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Unknown custom debug info. If you see an instance of this class, you're using an old dnlib version or - dnlib hasn't been updated to support this new custom debug info kind. - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Gets the data - - - - - Constructor - - Custom debug info kind - Raw custom debug info data - - - - Constructor - - Custom debug info guid - Raw custom debug info data - - - - Contains sizes of using groups - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the using counts - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains a reference to another method that contains the import strings - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - Contains a reference to another method that contains the per-module debug info (assembly reference aliases) - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - State machine hosted local scope info - - - - - true if it's a syntesized local ( and are both null) - - - - - The instruction of the first operation in the scope. Can be null if it's a synthesized local - - - - - The instruction of the first operation outside of the scope or null if it ends at the last instruction in the body. - Can also be null if it's a synthesized local (in which case is also null, see ) - - - - - Constructor - - Start of the scope - First instruction after the end of the scope - - - - Contains local scopes for state machine hoisted local variables. - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the scopes - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the state machine type - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the state machine type - - - - - Constructor - - - - - Constructor - - State machine type - - - - Contains dynamic flags for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the dynamic locals - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Dynamic local info - - - - - Gets the dynamic flags - - - - - Gets/sets the name of the local. The name must have at most 64 characters and no char can be NUL (0x0000). - If null is written, is returned instead. - - - - - true if it's a constant and not a variable ( is null) - - - - - true if it's a variable ( is not null) - - - - - Gets/sets the local. Could be null if there's no local (it's a 'const' local). - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the EnC local variable slot map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLocalSlotMap - - - - - Constructor - - Raw custom debug info data - - - - Contains the EnC lambda map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLambdaAndClosureMap - - - - - Constructor - - Raw custom debug info data - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Tuple element name info - - - - - Gets/sets the name of the local. If null is written, is returned instead. - - - - - Gets/sets the local. It's null if it's a constant, and non-null if it's a variable - - - - - true if it's a constant. Constants have a scope ( and ) - - - - - true if it's a variable. Variables don't have a scope ( and ) - - - - - Gets/sets the start of the scope or null. Only constants have a scope. - - - - - Gets/sets the end of the scope or null if it has no scope or if the scope ends at the end of the body. Only constants have a scope. - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Async method stepping info - - It's internal and translated to a - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the catch handler instruction or null - - - - - Gets all async step infos - - - - - Constructor - - - - - Default namespace - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the default namespace - - - - - Constructor - - - - - Constructor - - Default namespace - - - - Dynamic flags - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the dynamic flags - - - - - Constructor - - - - - Constructor - - Dynamic flags - - - - Contains the source code - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source code blob. - - It's not decompressed and converted to a string because the encoding isn't specified. - - https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#embedded-source-c-and-vb-compilers - - - - - Constructor - - - - - Constructor - - Source code blob - - - - Contains the source link file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source link file contents - - - - - Constructor - - - - - Constructor - - Source link file contents - - - - Contains the source server file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source server file contents - - - - - Constructor - - - - - Constructor - - Source server file contents - - - - Async method info - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the starting method that initiates the async operation - - - - - Gets/sets the instruction for the compiler generated catch handler that wraps an async method. - This can be null. - - - - - Gets all step infos used by the debugger - - - - - Constructor - - - - - Constructor - - Default capacity for - - - - Async step info used by debuggers - - - - - The yield instruction - - - - - Resume method - - - - - Resume instruction (where the debugger puts a breakpoint) - - - - - Constructor - - The yield instruction - Resume method - Resume instruction (where the debugger puts a breakpoint) - - - - Iterator method - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the kickoff method - - - - - Constructor - - - - - Constructor - - Kickoff method - - - - A PDB document - - - - - Gets/sets the document URL - - - - - Gets/sets the language GUID. See - - - - - Gets/sets the language vendor GUID. See - - - - - Gets/sets the document type GUID. See - - - - - Gets/sets the checksum algorithm ID. See - - - - - Gets/sets the checksum - - - - - - - - - - - Gets all custom debug infos - - - - - Default constructor - - - - - Constructor - - A instance - - - - Constructor - - Document URL - Language. See - Language vendor. See - Document type. See - Checksum algorithm ID. See - Checksum - - - - - - - - - - PDB document constants - - - - - PDB file kind - - - - - Windows PDB - - - - - Portable PDB - - - - - Embedded portable PDB - - - - - Import scope - - - - - Constructor - - - - - Gets/sets the parent import scope - - - - - Gets all imports - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - Import kind - - - - - PDB import base class - - - - - Gets the import kind - - - - - Import namespace - - - - - Returns - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - Import assembly, namespace - - - - - Returns - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import type - - - - - Returns - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - Import xml namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import assembly reference alias - - - - - Returns - - - - - Gets the alias - - - - - Constructor - - - - - Constructor - - - - - - Alias assembly reference - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Constructor - - - - - Constructor - - - - - - - Alias namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Alias assembly namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - - Alias type - - - - - Returns - - - - - Gets the alias - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - - A local variable - - - - - Constructor - - - - - Constructor - - - - - - - - Gets/sets the local - - - - - Gets/sets the name - - - - - Gets/sets the attributes - - - - - Gets the index of the local - - - - - true if it should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - - - - - - - Gets all custom debug infos - - - - - Local attributes - - - - - No bit is set - - - - - Local should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - A PDB method - - - - - Gets/sets the root scope. It contains all scopes of the method, using namespaces, variables and constants - - - - - Constructor - - - - - PDB reader options - - - - - No bit is set - - - - - Use the COM Windows PDB reader instead of the managed Windows PDB reader. - - This is NOT recommended since the COM reader can only be called on the same - thread it was created on. It also requires a Windows OS. - - If this is not set, the managed PDB reader will be used. - - This option is only used if it's a Windows PDB file, not if it's a Portable PDB file. - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - Only used if is set and if it's a Windows PDB file - - - - - Don't use diasymreader.dll's PDB reader that is shipped with .NET Framework. - - Only used if is set and if it's a Windows PDB file - - - - - A PDB scope - - - - - Constructor - - - - - Gets/sets the first instruction - - - - - Gets/sets the last instruction. It's null if it ends at the end of the method. - - - - - Gets all child scopes - - - - - true if is not empty - - - - - Gets all locals in this scope - - - - - true if is not empty - - - - - Gets all namespaces (Windows PDBs). Portable PDBs use - - - - - true if is not empty - - - - - Gets/sets the import scope (Portable PDBs). Windows PDBs use - - - - - Gets all constants - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - PDB state for a - - - - - Gets/sets the PDB file kind. You can change it from portable PDB to embedded portable PDB - and vice versa. Converting a Windows PDB to a portable PDB isn't supported. - - - - - Gets/sets the user entry point method. - - - - - Gets all PDB documents - - - - - true if is not empty - - - - - Constructor - - Module - PDB file kind - - - - Constructor - - A instance - Owner module - - - - Adds - - New document - if it wasn't inserted, or the already existing document - if it was already inserted. - - - - Removes - - Document - true if it was removed, false if it wasn't inserted. - - - - Returns an inserted instance or null if it's not been - inserted yet. - - A PDB document - The existing or null if it doesn't exist. - - - - Removes all documents - - - - - - Removes all documents and optionally returns them - - true if all the original s - should be returned. - All s if is true - or null if is false. - - - - Constructor - - Module that resolves assembly and type references - Portable PDB blob stream - - - - PDB sequence point - - - - - PDB document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - Clones this instance - - A new cloned instance - - - - Async step info - - - - - Yield offset - - - - - Breakpoint offset - - - - - Breakpoint method token - - - - - Constructor - - Yield offset - Breakpoint offset - Breakpoint method token - - - - A document - - - - - Gets the URL - - - - - Gets the language - - - - - Gets the language vendor - - - - - Gets the document type - - - - - Gets the checksum algorithm id - - - - - Gets the checksum - - - - - Gets the custom debug infos - - - - - A method - - - - - Gets the method token - - - - - Gets the root scope - - - - - Gets all sequence points - - - - - Reads custom debug info - - Method - Method body - Updated with custom debug info - - - - A namespace - - - - - Gets the name - - - - - Reads symbols from a PDB file - - - - - Called by the owner module before any other methods and properties are called - - Owner module - - - - Gets the PDB file kind - - - - - Gets the user entry point token or 0 if none - - - - - Gets all documents - - - - - Gets a method or returns null if the method doesn't exist in the PDB file - - Method - Edit and continue version. The first version is 1 - - - - - Reads custom debug info - - Token of a instance - Generic parameter context - Updated with custom debug info - - - - Cleans up resources - - - - - A scope - - - - - Gets the method - - - - - Gets the parent scope - - - - - Gets the start offset of the scope in the method - - - - - Gets the end offset of the scope in the method - - - - - Gets all child scopes - - - - - Gets all locals defined in this scope - - - - - Gets all namespaces in this scope - - - - - Gets all custom debug infos - - - - - Gets the import scope or null if none - - - - - Gets all the constants - - Owner module if a signature must be read from the #Blob - Generic parameter context - - - - - Sequence point - - - - - IL offset - - - - - Document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - A variable - - - - - Gets the name - - - - - Gets the attributes - - - - - Gets the index of the variable - - - - - Gets all custom debug infos - - - - - Reads custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Reads custom debug info - - Method - The method's body. Needs to be provided by the caller since we're called from - PDB-init code when the Body property hasn't been initialized yet - Place all custom debug info in this list - Custom debug info from the PDB file - - - - Writes custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Returns the raw custom debug info or null if there was an error - - Metadata - Writer context - Method - Custom debug infos to write - - - - - - - - P/Invoke attributes, see CorHdr.h/CorPinvokeMap - - - - Pinvoke is to use the member name as specified. - - - Use this mask to retrieve the CharSet information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Information about target function. Not relevant for fields. - - - - - - Pinvoke will use native callconv appropriate to target windows platform. - - - - - - - - - - - - In M9, pinvoke will raise exception. - - - - - - - Property attributes, see CorHdr.h/CorPropertyAttr - - - - property is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - Property has default - - - - A high-level representation of a row in the Property table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - From column Property.PropFlags - - - - Attributes - - - - From column Property.Name - - - - Name - - - - From column Property.Type - - - - - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the first getter method. Writing null will clear all get methods. - - - - - Gets/sets the first setter method. Writing null will clear all set methods. - - - - - Gets all getter methods - - - - - Gets all setter methods - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - Reset , , - - - - true if there are no methods attached to this property - - - - - - - - true if is not empty - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - Gets/sets the property sig - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the property - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - A Property row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Property signature - - - - Constructor - - Name - Property signature - Flags - - - - Created from a row in the Property table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this Property row - Row ID - If is null - If is invalid - - - - - - - Represents a public key - - - - - Gets the - - - - - - - - Constructor - - - - - Constructor - - Public key data - - - - Constructor - - Public key data as a hex string or the string "null" - to set public key data to null - - - - - - - - - - Public key / public key token base class - - - - - The key data - - - - - Returns true if is null or empty - - - - - Returns true if is null - - - - - Gets/sets key data - - - - - Gets the - - - - - Constructor - - Key data - - - - Constructor - - Key data as a hex string or the string "null" - to set key data to null - - - - Checks whether a public key or token is null or empty - - Public key or token instance - - - - Returns a - - A or a instance - - - - Compares two s as s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Compares two s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Gets the public key token hash code - - Public key or token - The hash code - - - - Gets the public key token hash code - - Public key token - The hash code - - - - Creates a - - Public key data or null - A new instance or null if - was null - - - - Creates a - - Public key token data or null - A new instance or null if - was null - - - - Gets the raw public key / public key token byte array - - The instance or null - Raw public key / public key token data or null - - - - - - - Represents a public key token - - - - - Gets the - - - - - Constructor - - - - - - - - - - - - - - - - - Recursion counter - - - - - Max recursion count. If this is reached, we won't continue, and will use a default value. - - - - - Gets the recursion counter - - - - - Increments if it's not too high. ALL instance methods - that can be called recursively must call this method and - (if this method returns true) - - true if it was incremented and caller can continue, false if - it was not incremented and the caller must return to its caller. - - - - Must be called before returning to caller if - returned true. - - - - - - - - Extension methods for reflection types, methods, fields - - - - - Checks whether it's a - - The type - - - - Gets a 's - - The type - The type's element type - - - - Returns true if is a generic method, but - not a generic method definition, i.e., a MethodSpec. - - The method - - - - Checks whether a parameter/prop/event type should be treated as if it is really a - generic instance type and not a generic type definition. In the .NET metadata (method - sig), the parameter is a generic instance type, but the CLR treats it as if it's just - a generic type def. This seems to happen only if the parameter type is exactly the same - type as the declaring type, eg. a method similar to: MyType<!0> MyType::SomeMethod(). - - Declaring type of method/event/property - Parameter/property/event type - - - - Checks whether is a type definition and not a type spec - (eg. pointer or generic type instantiation) - - this - - - - Resolve exception base class - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if an assembly couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a type couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a method/field couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Resolves types, methods, fields - - - - - true to project WinMD types to CLR types, eg. Windows.UI.Xaml.Interop.TypeName - gets converted to System.Type before trying to resolve the type. This is enabled - by default. - - - - - Constructor - - The assembly resolver - - - - - - - - - - Type of resource - - - - - It's a - - - - - It's a - - - - - It's a - - - - - Resource base class - - - - - - - - - - - Gets/sets the offset of the resource - - - - - Gets/sets the name - - - - - Gets/sets the flags - - - - - Gets the type of resource - - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - Constructor - - Name - flags - - - - A resource that is embedded in a .NET module. This is the most common type of resource. - - - - - Gets the length of the data - - - - - - - - Constructor - - Name of resource - Resource data - Resource flags - - - - Constructor - - Name of resource - Data reader factory - Offset of resource data - Length of resource data - Resource flags - - - - Gets a data reader that can access the resource - - - - - - - - - A reference to a resource in another assembly - - - - - - - - Gets/sets the assembly reference - - - - - Constructor - - Name of resource - Assembly reference - Resource flags - - - - - - - A resource that is stored in a file on disk - - - - - - - - Gets/sets the file - - - - - Gets/sets the hash - - - - - Gets/sets the file name - - - - - Constructor - - Name of resource - The file - Resource flags - - - - - - - A collection of s - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Finds the index of a resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an embedded resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an assembly linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of a linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds a resource - - Name of resource - The or null if none was found - - - - Finds an embedded resource - - Name of resource - The or null if none was found - - - - Finds an assembly linked resource - - Name of resource - The or null if none was found - - - - Finds a linked resource - - Name of resource - The or null if none was found - - - - Built-in resource data - - - - - Gets the data - - - - - - - - - - - - - - Constructor - - Type of data - Data - - - - - - - - - - Implemented by all resource data - - - - - Gets the type of data - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Writes the data - - Writer - Formatter if needed by implementer - - - - Creates resource data - - - - - Gets the owner module - - - - - Constructor - - Owner module - - - - Gets number of user data types - - - - - Create null data - - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates array data - - Value - - - - - Creates data - - Value - - - - - Creates serialized data - - Serialized data - Type of serialized data - - - - - Creates serialized data - - Serialized data - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - Use without converting it to a - type in an existing assembly reference - - - - - Converts an assembly simple name (eg. mscorlib) to the full name of the assembly, - which includes the version, public key token, etc. Returns null if it's - unknown. - - Simple name of assembly - - - - - Gets all types sorted by - - - - - - Resource element - - - - - Name of resource - - - - - Data of resource - - - - - - - - Resource element set - - - - - Gets the number of elements in the set - - - - - Gets all resource elements - - - - - Adds a new resource to the set, overwriting any existing resource - - - - - - Thrown by - - - - - Constructor - - - - - Constructor - - Message - - - - Constructor - - - - - - - Gets called to create a from serialized data. Returns null - if a default instance should be created. - - ResourceDataFactory - Serialized type - Serialized data - - - - - Reads .NET resources - - - - - Returns true if it's possibly resources file data - - Reader - - - - - Reads a .NET resource - - Owner module - Data of resource - - - - - Reads a .NET resource - - Owner module - Data of resource - Call back that gets called to create a instance. Can be null. - - - - - Type of resource - - - - - null - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - array - - - - - - - - - - Start of user types - - - - - Writes .NET resources - - - - - Write .NET resources - - Owner module - Output stream - .NET resources - - - - Base class of all user data - - - - - Full name including assembly of type - - - - - User type code - - - - - - - - - - - Constructor - - User resource type - - - - - - - Binary data - - - - - Gets the raw data - - - - - Constructor - - User resource type - Raw serialized data - - - - - - - - - - User resource type - - - - - Full name including assembly of type - - - - - User type code - - - - - Constructor - - Full name including assembly of type - User type code - - - - - - - Security action. See CorHdr.h/CorDeclSecurity - - - - Mask allows growth of enum. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Persisted grant set at prejit time - - - Persisted grant set at prejit time - - - Persisted denied set at prejit time - - - Persisted denied set at prejit time - - - - - - - - - - - - Maximum legal value - - - - A DeclSecurity security attribute - - - - - Gets/sets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Creates a from an XML string. - - Owner module - XML - A new instance - - - - Default constructor - - - - - Constructor - - Attribute type - - - - Constructor - - Attribute type - Named arguments that will be owned by this instance - - - - - - - See CorSerializationType/CorHdr.h - - - - - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Single-dimension, zero lower bound array ([]) - - - System.Type - - - Boxed value type - - - A field - - - A property - - - An enum - - - - Compares types - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares fields - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - Compares methods - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares properties - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares events - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares calling convention signatures - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Decides how to compare types, sigs, etc - - - - - Don't compare a type's (assembly/module) scope - - - - - Compares a method/field's declaring type. - - - - - Compares a property's declaring type - - - - - Compares an event's declaring type - - - - - Compares method / field / property / event declaring types - - - - - Compares parameters after a sentinel in method sigs. Should not be enabled when - comparing s against s since it's - not possible to get those sentinel params from a . - - - - - Compares assembly public key token - - - - - Compares assembly version - - - - - Compares assembly locale - - - - - If set, a and an can reference the - global <Module> type. - - - - - Don't compare a method/property's return type - - - - - Type namespaces are case insensitive - - - - - Type names (not namespaces) are case insensitive - - - - - Type names and namespaces are case insensitive - - - - - Method and field names are case insensitive - - - - - Property names are case insensitive - - - - - Event names are case insensitive - - - - - Type namespaces, type names, method names, field names, property names - and event names are all case insensitive - - - - - A field that is can compare equal to - a - - - - - A method that is can compare equal to - a - - - - - A field that is and a method that is - can compare equal to a - - - - - Raw (bit by bit) comparison of signatures. This matches what the CLR does when it - compares signatures. This means that metadata tokens will be compared. - - - - - Ignore required and optional modifiers when comparing s. - They're already ignored when comparing eg. a with a - . - - - - - By default, all module and assembly compares when they're both the system library - (eg. mscorlib or System.Runtime.dll) return true, even if they're really different, - eg. mscorlib (.NET 2.0) vs mscorlib (Windows CE). If this flag is set, the system - library is compared just like any other module/assembly. - - - - - Don't project CLR compatible WinMD references back to the original CLR type/method before comparing - - - - - Don't check type equivalence when comparing types. Starting with .NET 4.0, two different - types can be considered equivalent if eg. a TypeIdentifierAttribute is used. - - - - - When comparing types, don't compare a multi-dimensional array's lower bounds and sizes - - - - - Compares types, signatures, methods, fields, properties, events - - - - - Constructor - - Comparison options - - - - Constructor - - Comparison options - The module which the comparison take place in. - - - - is mapped to , so use - the same hash code for both - - - - - Compare members - - Member #1 - Member #2 - true if same, false otherwise - - - - Gets the hash code of a member - - The member - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares resolution scopes - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares resolution scope and implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares files - - File #1 - File #2 - true if same, false otherwise - - - - Compares a module with a file - - Module - File - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Compares signatures - - Sig #1 - Sig #2 - true if same, false otherwise - - - - Gets the hash code of a sig - - The sig - The hash code - - - - Compares method/property sigs - - Method/property #1 - Method/property #2 - true if same, false otherwise - - - - Gets the hash code of a method/property sig - - The method/property sig - The hash code - - - - Compares field sigs - - Field sig #1 - Field sig #2 - true if same, false otherwise - - - - Gets the hash code of a field sig - - The field sig - The hash code - - - - Compares local sigs - - Local sig #1 - Local sig #2 - true if same, false otherwise - - - - Gets the hash code of a local sig - - The local sig - The hash code - - - - Compares generic method instance sigs - - Generic inst method #1 - Generic inst method #2 - true if same, false otherwise - - - - Gets the hash code of a generic instance method sig - - The generic inst method sig - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares MemberRefs - - MemberRef #1 - MemberRef #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRef - - The MemberRef - The hash code - - - - Compares MethodSpecs - - MethodSpec #1 - MethodSpec #2 - true if same, false otherwise - - - - Gets the hash code of a MethodSpec - - The MethodSpec - The hash code - - - - Compares MemberRefParents - - MemberRefParent #1 - MemberRefParent #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRefParent - - The MemberRefParent - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Checks whether it's FnPtr&, FnPtr*, FnPtr[], or FnPtr[...] - - The type - - - - Compares types - - Type #1 - Type #2 - true if we should treat - as a generic instance type - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Gets the hash code of a type - - The type - true if we should treat - as a generic instance type - The hash code - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Gets the hash code of a list with only generic method parameters () - - Number of generic method parameters - Hash code - - - - Gets the hash code of a TypeDef type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares a file and a module - - File - Module - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares method declaring types - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares generic method args, making sure only - contains s. - - Number of generic method args in method #1 - Generic method args in method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a MethodBase - - The MethodBase - The hash code - - - - Gets the hash code of a parameter list - - The type list - Declaring type of method that owns parameter - The hash code - - - - Compares calling conventions - - Calling convention - Method - - - - - Compares return types - - Return type #1 - MethodBase - true if same, false otherwise - - - - Compares parameter lists - - Type list #1 - Type list #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares parameter types - - Parameter type #1 - Parameter #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - - - - Helps resolve types - - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if - is invalid - - - - Converts the address of a to a - - - Address of . This is also known as the - method table and has the same value as - A or null if not supported - - - - Reads signatures from the #Blob stream - - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Constructor - - Reader module - #Blob stream offset of signature - Generic parameter context - - - - Constructor - - Token resolver - A instance - The signature data - Generic parameter context - - - - Reads the signature - - A new instance or null if invalid signature - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads the next type - - A new instance or null if invalid element type - - - - A high-level representation of a row in the StandAloneSig table - - - - - The row id in its table - - - - - - - - - - - - - - From column StandAloneSig.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the method sig - - - - - Gets/sets the locals sig - - - - - - - - A StandAloneSig row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A locals sig - - - - Constructor - - A method sig - - - - Created from a row in the StandAloneSig table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this StandAloneSig row - Row ID - Generic parameter context - If is null - If is invalid - - - - Thrown if the strong name key or public key is invalid - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Type of signature algorithm. See WinCrypt.h in the Windows SDK - - - - - RSA signature algorithm - - - - - A public key - - - - - Gets/sets the signature algorithm - - - - - Gets/sets the hash algorithm - - - - - Gets/sets the modulus - - - - - Gets/sets the public exponent - - - - - Default constructor - - - - - Constructor - - Modulus - Public exponent - - - - Constructor - - Modulus - Public exponent - Hash algorithm - - - - Constructor - - Modulus - Public exponent - Hash algorithm - Signature algorithm - - - - Constructor - - Public key - - - - Constructor - - Public key data - Strong name key is invalid - - - - Constructor - - Public key file - Strong name key is invalid - - - - Constructor - - Public key stream - Strong name key is invalid - - - - Constructor - - Public key reader - Strong name key is invalid - - - - Creates a public key blob - - - - - - - - Stores a strong name key pair - - - - - Gets the public key - - - - - Gets the strong name signature size in bytes - - - - - Gets the public key hash algorithm. It's usually - - - - - Gets the public exponent - - - - - Gets the modulus - - - - - Gets prime1 - - - - - Gets prime2 - - - - - Gets exponent1 - - - - - Gets exponent2 - - - - - Gets the coefficient - - - - - Gets the private exponent - - - - - Constructor - - Strong name key data - Strong name key is invalid - - - - Constructor - - Strong name key file - Strong name key is invalid - - - - Constructor - - Strong name key stream - Strong name key is invalid - - - - Constructor - - Strong name key reader - Strong name key is invalid - - - - Creates a strong name key with a new hash algorithm - - Algorithm - - - - - Creates an instance - - - - - Creates a strong name blob - - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature as a hex string - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature - - - - Strong name signs an assembly. It supports normal strong name signing and the new - (.NET 4.5) enhanced strong name signing. - - - - - Constructor - - .NET PE file stream - - - - Constructor - - .NET PE file stream - Offset in of the first byte of - the PE file. - - - - Calculates the strong name signature and writes it to the stream. The signature - is also returned. - - Strong name key used for signing - Offset (relative to the start of the PE file) of the strong - name signature. - The strong name signature - - - - Calculates and returns the strong name signature - - Strong name key used for signing - Offset (relative to start of PE file) of the strong - name signature. - The strong name signature - - - - Strong name hashes the .NET file - - Hash algorithm - Strong name sig offset (relative to start of .NET PE file) - Size of strong name signature - The strong name hash of the .NET file - - - - Returns the strong name signature - - Strong name key - Hash algorithm - Strong name hash of the .NET PE file - Strong name signature - - - - System.Runtime.InteropServices.TypeIdentifierAttribute helper code used by - - - - - TypeDef and ExportedType flags. See CorHdr.h/CorTypeAttr - - - - Use this mask to retrieve the type visibility information. - - - Class is not public scope. - - - Class is public scope. - - - Class is nested with public visibility. - - - Class is nested with private visibility. - - - Class is nested with family visibility. - - - Class is nested with assembly visibility. - - - Class is nested with family and assembly visibility. - - - Class is nested with family or assembly visibility. - - - Use this mask to retrieve class layout information - - - Class fields are auto-laid out - - - Class fields are laid out sequentially - - - Layout is supplied explicitly - - - Use this mask to retrieve class semantics information. - - - Use this mask to retrieve class semantics information. - - - Type is a class. - - - Type is an interface. - - - Class is abstract - - - Class is concrete and may not be extended - - - Class name is special. Name describes how. - - - Class / interface is imported - - - The class is Serializable. - - - The type is a Windows Runtime type - - - Use StringFormatMask to retrieve string information for native interop - - - LPTSTR is interpreted as ANSI in this class - - - LPTSTR is interpreted as UNICODE - - - LPTSTR is interpreted automatically - - - A non-standard encoding specified by CustomFormatMask - - - Use this mask to retrieve non-standard encoding information for native interop. The meaning of the values of these 2 bits is unspecified. - - - Initialize the class any time before first static field access. - - - This ExportedType is a type forwarder. - - - Flags reserved for runtime use. - - - Runtime should check name encoding. - - - Class has security associate with it. - - - - A high-level representation of a row in the TypeDef table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - Gets/sets the owner module - - - - - - - - - - Called to initialize - - - - From column TypeDef.Flags - - - - Attributes - - - - From column TypeDef.Name - - - - Name - - - - From column TypeDef.Namespace - - - - Name - - - - From column TypeDef.Extends - - - - - - - - - - Called to initialize - - - Reset - - - - From column TypeDef.FieldList - - - - - - - Initializes - - - - From column TypeDef.MethodList - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets the interfaces - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets/sets the class layout - - - - - - - - - - Called to initialize - - - - - - - Gets/sets the enclosing type. It's null if this isn't a nested class. - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - Called to initialize - - - - Gets all the nested types - - - - - - - Initializes - - - - Gets all events - - - - - - - Initializes - - - - Gets all properties - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets/sets the packing size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - Gets/sets the class size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - - - - true if it's an enum - - - - - true if it's a delegate (it derives from ) - - - - - true if this is a nested type (it has a declaring type) - - - - - - - - Checks whether this type has opted into equivalence - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the global (aka. <Module>) type - - - - - Gets a list of all nested types and all their nested types - - - - - Gets an enum's underlying type or null if none. Should only be called - if this is an enum. - - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. Private scope methods/fields are not returned. - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. - - A method/field reference - Method/field signature comparison options - A or a instance or null - if it couldn't be resolved. - - - - Finds a method. Private scope methods are not returned. - - Method name - Method signature - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The first method that matches or null if none found - - - - Finds a method by name - - Name of method - The or null if not found - - - - Finds all methods by name - - Name of method - All methods with that name - - - - Finds the class constructor (aka type initializer). It's the method named .cctor - - The class constructor or null if none found - - - - Finds the class constructor (aka type initializer). It's the method named .cctor. - If it doesn't exist, it is created, inserted into and returned. - The created .cctor will have just one RET instruction. - - The class constructor - - - - Finds all instance constructors (not class constructors) - - All instance constructors - - - - Finds all static and instance constructors - - All static and instance constructors - - - - Finds the default instance constructor (the one with no arguments) - - The default instance constructor or null if none - - - - Finds a field. Private scope fields are not returned. - - Field name - Field signature - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The first field that matches or null if none found - - - - Finds a field by name - - Name of field - The or null if not found - - - - Finds all fields by name - - Name of field - All fields with that name - - - - Finds an event - - Name of event - Type of event - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - The module that needs to find the event or null - A or null if not found - - - - Finds an event by name - - Name of event - The or null if not found - - - - Finds all events by name - - Name of event - All events with that name - - - - Finds a property - - Name of property - Property signature - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - The module that needs to find the property or null - A or null if not found - - - - Finds a prop by name - - Name of prop - The or null if not found - - - - Finds all props by name - - Name of prop - All props with that name - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - The method or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - The field or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - Event type - The event or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - The event or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The module that needs to find the property or null - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - The property or null if it wasn't found - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - true if we should remove all - empty properties and events. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets all fields named - - Field name - A list of 0 or more fields with name - - - - Gets the first field named - - Field name - The field or null if none found - - - - FInd a method implementation method - - Method - - - - - - - - A TypeDef row created by the user and not present in the original .NET file - - - - - Constructor - - Name - - - - Constructor - - Namespace - Name - - - - Constructor - - Name - Base class or null if it's an interface - - - - Constructor - - Namespace - Name - Base class or null if it's an interface - - - - Created from a row in the TypeDef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeDef row - Row ID - If is null - If is invalid - - - - Gets all methods overrides - - The method - Generic parameter context - A list (possibly empty) of all methods overrides - - - - Initializes all . Only those s - that are property or event handlers get updated. - - - - - Initializes a property's special methods - - The property - Updated with a list of all get methods - Updated with a list of all set methods - Updated with a list of all other methods - - - - Initializes an event's special methods - - The event - Updated with the addOn method or null if none - Updated with the fire method or null if none - Updated with the removeOn method or null if none - Updated with a list of all other methods - - - - - - - - - - - - - - - - - - - Finds s - - - - - true if the cache is enabled. false if the cache - is disabled and a slower O(n) lookup is performed. - - - - - Constructor - - All root types. All their nested types are also included. - If is null - - - - Constructor - - All root types - true if all nested types that are reachable - from should also be included. - If is null - - - - Resets the cache (clears all cached elements). Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - - - - - - - Gets the next or null if there are no more left - - The next or null if none - - - - Gets the next or null if there are no more left. - The cache is updated with the returned before the method - returns. - - The next or null if none - - - - - - - Various helper methods for classes to prevent infinite recursion - - - - - Checks whether contains a or a - . - - Calling convention signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Field signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Method or property signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Local signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Generic method signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Thrown by when it fails to parse a type name - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Helps create types - - - - - Finds a 's when the original assembly - info is missing from the full type name. - - A non-nested - 's or null - - - - Parses a type name and creates an - - - - Owner module - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Increment recursion counter - - If this method has been called too many times - - - - Decrement recursion counter - - - - - - - - Dispose method - - true if called by - - - - Reads a including any possible nested s. - - Character separating nested types - A new instance, which could be nested. - - - - Reads a namespace and name and creates a TypeRef. Does not read any nested types. - - A new instance - - - - Peeks the next char. -1 if no more chars. - - - - - Gets the next char or -1 if no more chars - - - - - Gets the next ID char or -1 if no more ID chars - - true if white space should be ignored - - - - Parses reflection type names. Grammar http://msdn.microsoft.com/en-us/library/yfsftwz6.aspx - - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses an assembly name - - Full assembly name - A new instance or null if parsing failed - - - - Parses an assembly name - - Full assembly name - Generic parameter context - A new instance or null if parsing failed - - - - - - - A high-level representation of a row in the TypeRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - From column TypeRef.ResolutionScope - - - - - - - - - - Called to initialize - - - - From column TypeRef.Name - - - - Name - - - - From column TypeRef.Namespace - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if it's nested within another - - - - - - - - - - - Gets the declaring type, if any - - - - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Gets the top-most (non-nested) - - Input - The non-nested or null - - - - - - - A TypeRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - Type name - - - - Constructor - - Owner module - Type namespace - Type name - - - - Constructor - - Owner module - Type namespace - Type name - Resolution scope (a , - , or ) - - - - Created from a row in the TypeRef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeRef row - Row ID - If is null - If is invalid - - - - Type sig base class - - - - - Returns the wrapped element type. Can only be null if it was an invalid sig or - if it's a - - - - - Gets the element type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a or a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if this contains a or a - . - - - - - - - - Base class for element types that are last in a type sig, ie., - , , , - , - - - - - - - - Wraps a - - - - - Gets the the TypeDefOrRef - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Constructor - - A , or - a - - - - A core library type - - - - - Gets the element type - - - - - Constructor - - The type which must be a or a - . and null are not allowed. - The type's element type - - - - Base class for class/valuetype element types - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Generic method/type var base class - - - - - true if it has an owner or - - - - - true if it has an owner ( is - not null) - - - - - true if it has an owner ( is - not null) - - - - - Gets the owner type or null if the owner is a or if it - has no owner. - - - - - Gets the owner method or null if the owner is a or if it - has no owner. - - - - - Gets the generic param number - - - - - Gets the corresponding or null if none exists. - - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - Owner method/type or null - - - - Returns true if it's a MVar element type - - - - - Returns true if it's a Var element type - - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner type or null - - - - Constructor - - Generic parameter number - Owner type or null - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner method or null - - - - Constructor - - Generic parameter number - Owner method or null - - - - Represents a - - - - - - - - Represents a - - - - - - - - Gets the signature - - - - - Gets the - - - - - Constructor - - The method signature - - - - Represents a - - - - - - - - Gets the generic type - - - - - Gets the generic arguments (it's never null) - - - - - Default constructor - - - - - Constructor - - The generic type - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Generic argument #1 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - Generic argument #3 - - - - Constructor - - The generic type - Generic arguments - - - - Constructor - - The generic type - Generic arguments - - - - Base class of non-leaf element types - - - - - - - - Constructor - - Next sig - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Array base class - - - - - Constructor - - Array type - - - - true if it's a multi-dimensional array (i.e., ), - and false if it's a single-dimensional array (i.e., ) - - - - - - true if it's a single-dimensional array (i.e., ), - and false if it's a multi-dimensional array (i.e., ) - - - - - - Gets/sets the rank (number of dimensions). This can only be set if - is true - - - - - Gets all sizes. If it's a , then it will be an empty temporary - list that is re-created every time this method is called. - - A list of sizes - - - - Gets all lower bounds. If it's a , then it will be an empty - temporary list that is re-created every time this method is called. - - A list of lower bounds - - - - Represents a - - - - - - - - - Gets/sets the rank (max value is 0x1FFFFFFF) - - - - - Gets all sizes (max elements is 0x1FFFFFFF) - - - - - Gets all lower bounds (max elements is 0x1FFFFFFF) - - - - - Constructor - - Array type - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - - - - - - - Represents a (single dimension, zero lower bound array) - - - - - - - - - - - - Constructor - - The next element type - - - - - - - - - - Base class for modifier type sigs - - - - - Returns the modifier type - - - - - Constructor - - Modifier type - The next element type - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Gets/sets the size - - - - - Constructor - - The next element type - Size of the array - - - - Represents a - - - - - - - - Gets/sets the index - - - - - Constructor - - Index - The next element type - - - - A high-level representation of a row in the TypeSpec table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column TypeSpec.Signature - - - - - Gets/sets the extra data that was found after the signature - - - - - - - - - - - - - Called to initialize - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - A TypeSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A type sig - - - - Created from a row in the TypeSpec table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - Compares s - - - - - The default instance - - - - - - - - - - - A UTF-8 encoded string where the original data is kept in memory to avoid conversions - when the data is not really valid UTF-8 encoded data - - When comparing strings, a byte compare is performed. The reason is that this - is what the CLR does when comparing strings in the #Strings stream. - - - - An empty - - - - - Gets the value as a UTF8 decoded string. Only use it for display purposes, - not for serialization. - - - - - Gets the original encoded data. Don't modify this data. - - - - - Gets the length of the this as a . I.e., it's the same as - String.Length. - - - - - - Gets the length of the raw data. It's the same as Data.Length - - - - - - Checks whether is null or if its data is null. - - The instance to check - true if null or empty, false otherwise - - - - Checks whether is null or if its data is null or the - data is zero length. - - The instance to check - true if null or empty, false otherwise - - - Implicit conversion from to - - - Implicit conversion from to - - - - Converts it to a - - The UTF-8 string instace or null - A or null if is null - - - - Converts it to a or an empty string if is null - - The UTF-8 string instace or null - A (never null) - - - - Gets the hash code of a - - Input - - - - - - - Compares two instances (case sensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - true if equals, false otherwise - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - Constructor - - UTF-8 data that this instance now owns - - - - Constructor - - The string - - - - Compares two instances - - First - Second - true if equals, false otherwise - - - - - - - - - - Checks whether exists in this string - - Value to find - true if exists in string or is the - empty string, else false - - - - Checks whether matches the end of this string - - Value - - - - - Checks whether matches the end of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the end of this string - - Value - Comparison type - - - - - Checks whether matches the beginning of this string - - Value - - - - - Checks whether matches the beginning of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the beginning of this string - - Value - Comparison type - - - - - Compares this instance with - - Other string - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Returns the index of the first character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Returns the index of the last character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Inserts string at a index - - Start index - Value to insert - A new instance with the inserted at position - - - - - Removes all characters starting from position - - Start index - A new instance - - - - Removes characters starting from position - - - Start index - Number of characters to remove - A new instance - - - - Replaces all characters with - - Character to find - Character to replace all - A new instance - - - - Replaces all sub strings with - - Sub string to find - Sub string to replace all - A new instance - - - - Returns a sub string of this string starting at offset - - Start index - A new instance - - - - Returns a sub string of this string starting at offset . - Length of sub string is . - - Start index - Length of sub string - A new instance - - - - Returns the lower case version of this string - - A new instance - - - - Returns the lower case version of this string - - Culture info - A new instance - - - - Returns the lower case version of this string using the invariant culture - - A new instance - - - - Returns the upper case version of this string - - A new instance - - - - Returns the upper case version of this string - - Culture info - A new instance - - - - Returns the upper case version of this string using the invariant culture - - A new instance - - - - Removes all leading and trailing whitespace characters - - A new instance - - - - - - - - - - Compares byte arrays - - - - - Default instance - - - - - - - - - - - Returns an assembly name string - - Simple assembly name - Version or null - Culture or null - Public key / public key token or null - Assembly attributes - An assembly name string - - - - Convert a byte[] to a - - All bytes - true if output should be in upper case hex - as a hex string - - - - Converts a hex string to a byte[] - - A string with an even number of hex characters - converted to a byte[] or null - if is invalid - - - - Converts a character to a hex digit - - Hex character - 0x00-0x0F if successful, -1 if is not - a valid hex digit - - - - Compares two byte arrays - - Byte array #1 - Byte array #2 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two byte arrays are equal - - First - Second - true if same, false otherwise - - - - Gets the hash code of a byte array - - Byte array - The hash code - - - - Compares two versions - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two versions are the same - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - true if same, false otherwise - - - - Creates a new instance with no undefined version values (eg. - the build and revision values won't be -1). - - A instance - A new instance - - - - Parses a version string - - Version string - A new or null if - is an invalid version - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Gets the hash code of a locale - - Value - The hash code - - - - Align up - - Value - Alignment - - - - Align up - - Value - Alignment - - - - Variant type (VT_XXX in the Windows SDK) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This wasn't present in the blob - - - - All native vtables - - - - - Gets/sets the RVA of the vtable fixups - - - - - Gets all s - - - - - Default constructor - - - - - Constructor - - Module - - - - - - - - - - See COR_VTABLE_XXX in CorHdr.h - - - - - 32-bit vtable slots - - - - - 64-bit vtable slots - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - One VTable accessed by native code - - - - - Gets/sets the of this vtable - - - - - Gets/sets the flags - - - - - true if each vtable slot is 32 bits in size - - - - - true if each vtable slot is 64 bits in size - - - - - Gets the vtable methods - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - RVA of this vtable - Flgas - Number of methods in vtable - - - - Constructor - - RVA of this vtable - Flgas - Vtable methods - - - - - - - - - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD member reference to a CLR member reference. Returns - null if it's not a CLR compatible WinMD member reference. - - Owner module or null - Member reference - - - - - Converts WinMD method to a CLR member reference. Returns - null if it's not a CLR compatible WinMD method - - Owner module or null - Method - - - - - WinMD status - - - - - This is not a WinMD file - - - - - This is a pure WinMD file (not managed) - - - - - This is a managed WinMD file (created by eg. winmdexp.exe) - - - - - Writes data - - - - - Gets the current position - - - - - Constructor - - Destination array - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes - - - - Writes bytes - - Bytes - Source index - Number of bytes to write - - - - #Blob heap - - - - - - - - Populates blobs from an existing (eg. to preserve - blob offsets) - - The #Blob stream with the original content - - - - Adds data to the #Blob heap - - The data - The offset of the data in the #Blob heap - - - - Adds data to the #Blob heap, but does not re-use an existing position - - The data - The offset of the data in the #Blob heap - - - - - - - - - - - - - - - - - - - Stores a byte array - - - - - - - - - - - Gets the data - - - - - Constructor - - The data. It will be owned by this instance and can't be modified by - other code if this instance is inserted as a key in a dictionary (because - return value will be different if you modify the array). If - it's never inserted as a key in a dictionary, then the contents can be modified, - but shouldn't be resized after has been called. - - - - - - - - - - - - - - - - - - - - - - Checksum algorithm - - - - - SHA-1 - - - - - SHA-256 - - - - - SHA-384 - - - - - SHA-512 - - - - - Contains a list of s - - - - - Default constructor - - - - - Add a - - The chunk to add or null if none - Chunk alignment - - - - Remove a - - The chunk to remove or null if none - Alignment of the chunk, or null if the chunk cannot be removed. - - - - Base class of chunk list types - - Chunk type - - - All chunks - - - true if has been called - - - - Helper struct - - - - Data - - - Alignment - - - - Constructor - - Chunk - Alignment - - - - Equality comparer for - - - - - Constructor - - Compares the chunk type - - - - - - - - - - - - - - - - - - - - - - - - - - - - Helps write custom attributes - - - - - Writes s - - - - - Writes a custom attribute - - Helper class - The custom attribute - Custom attribute blob - - - - Writes custom attribute named arguments - - Helper class - Named arguments - The named args blob - - - - Write a value - - The ctor arg type, field type, or property type - The value to write - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - - - - A chunk - - - - - - - - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Gets the data reader - - - - - Replaces the old data with new data. The new data must be the same size as the old data if - has been called. That method gets called after - event - - - - - - - - - - - - - - - - - - Copies existing data to a new metadata heap - - - - - Gets the name of the heap - - - - - Constructor - - The stream whose data will be copied to the new metadata file - - - - Constructor - - Heap name - Heap content - - - - - - - - - - Writes data - - - - - Gets/sets the position - - - - - Constructor - - Destination stream - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes to write - - - - Writes bytes - - Bytes to write - Index to start copying from - Number of bytes to copy - - - - Writes a compressed - - Value - - - - Writes a compressed - - - - - - Gets the size of a compressed , see - - Value - - - - - Debug directory entry - - - - - Gets the header - - - - - Gets the data - - - - - Constructor - - Data - - - - Debug directory chunk - - - - Default debug directory alignment - - - - - - - - - - Constructor - - - - - Adds data - - Data - - - - - Adds data - - Data - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - - - - - - - - - - - - - Writes DeclSecurity blobs - - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - A DeclSecurity blob - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A DeclSecurity blob - - - - Extension methods - - - - - Write zeros - - this - Number of zeros - - - - Writes all data to and verifies that all bytes were written - - this - Destination - Not all bytes were written - - - - Writes a data directory - - Writer - The data - - - - #GUID heap - - - - - - - - Adds a guid to the #GUID heap - - The guid - The index of the guid in the #GUID heap - - - - - - - - - - - - - - - - - - - Base class of most heaps - - - - - true if has been called - - - - - - - - - - - - - - - - - true if offsets require 4 bytes instead of 2 bytes. - - - - - - - - - - - - - - - - - Gets the raw length of the heap - - Raw length of the heap - - - - - - - Writes all data to at its current location. - - Destination - - - - - - - Data that gets written to the file - - - - - Gets the file offset. This is valid only after has been called. - - - - - Gets the RVA. This is valid only after has been called. - - - - - Called when the file offset and RVA are known - - File offset of this chunk - RVA of this chunk - - - - Gets the raw file length of this chunk. Must only be called after - has been called. - - Length of this chunk - - - - Gets the virtual size of this chunk. Must only be called after - has been called. - - Virtual size of this chunk - - - - Writes all data to at its current location. It's only - called after and have been called. - You cannot assume that 's file position is the same as this - chunk's file position. - - Destination - - - - Implemented by s that can reuse the old data location in the original PE file - - - - - Returns true if this chunk fits in the old location - - Original RVA of data - Size of the original location - - - - - .NET Heap interface - - - - - Gets the name of the heap - - - - - Checks whether the heap is empty - - - - - Called when the heap should be set to read-only mode - - - - - Options to - - - - - Default major runtime version - - - - - Default minor runtime version - - - - - Major runtime version - - - - - Minor runtime version - - - - - Flags - - - - - Entry point or null. Either a Method/File token or an RVA. - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Major runtime version (default is ) - Minor runtime version (default is ) - Flags - - - - .NET header - - - - - Gets/sets the - - - - - Gets/sets the .NET resources - - - - - Gets/sets the strong name signature - - - - - - - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Import address table chunk - - - - - Gets/sets the - - - - - - - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Import directory chunk - - - - - Gets/sets the - - - - - Gets the RVA of _CorDllMain/_CorExeMain in the import lookup table - - - - - Gets RVA of _CorExeMain/_CorDllMain in the IAT - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets/sets the name of the dll which should be imported. - - - - - Gets/sets the name of the entry point of the imported dll. - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Interface to get and set raw heap data. Implemented by the offset heaps: #Strings, - #GUID, #Blob, and #US. - - Type of cooked data - - - - Gets the size of the data as raw data when written to the heap - - The data - Size of the data as raw data when written to the heap - - - - Overrides what value should be written to the heap. - - Offset of value. Must match an offset returned by - - The new raw data. The size must match the raw size exactly. - - - - Gets all inserted raw data and their offsets. The returned array - is owned by the caller. - - An enumerable of all raw data and their offsets - - - - Gets notified of errors. The default handler should normally throw since the written data - will probably be invalid. Any error can be ignored. - - - - - Called when an error is detected (eg. a null pointer or other invalid value). The error - can be ignored but the written data won't be valid. - - Error message - - - - Writes the .sdata blob. We could write the data in any order, but we write the data in the same order as ILASM - - PE timestamp - - - - Writes field marshal blobs - - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - A field marshal blob or null if is - null - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A field marshal blob or null if is - null - - - - - - - Calculates max stack usage by using a simple pass over all instructions. This value - can be placed in the fat method header's MaxStack field. - - - - - Gets max stack value - - All instructions - All exception handlers - Max stack value - - - - Gets max stack value - - All instructions - All exception handlers - Updated with max stack value - true if no errors were detected, false otherwise - - - - MD table interface - - - - - Gets the table type - - - - - true if the table is empty - - - - - Gets the number of rows in this table - - - - - Gets/sets a value indicating whether it's sorted - - - - - true if has been called - - - - - Gets/sets the - - - - - Called when the table can't be modified any more - - - - - Creates rows in a table. Rows can optionally be shared to create a compact table. - - The raw row type - - - - - - - - - - - - - - - - - - - - - - Gets the value with rid - - The row ID - - - - Constructor - - The table type - Equality comparer - - - - - - - Adds a row. If the row already exists, returns a rid to the existing one, else - it's created and a new rid is returned. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Creates a new row even if this row already exists. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Re-adds all added rows. Should be called if rows have been modified after being - inserted. - - - - - Reset the table. - - - - - Writes s - - - - - Writes a Module table - - Writer - Metadata - Table - - - - Writes a TypeRef table - - Writer - Metadata - Table - - - - Writes a TypeDef table - - Writer - Metadata - Table - - - - Writes a FieldPtr table - - Writer - Metadata - Table - - - - Writes a Field table - - Writer - Metadata - Table - - - - Writes a MethodPtr table - - Writer - Metadata - Table - - - - Writes a Method table - - Writer - Metadata - Table - - - - Writes a ParamPtr table - - Writer - Metadata - Table - - - - Writes a Param table - - Writer - Metadata - Table - - - - Writes a InterfaceImpl table - - Writer - Metadata - Table - - - - Writes a MemberRef table - - Writer - Metadata - Table - - - - Writes a Constant table - - Writer - Metadata - Table - - - - Writes a CustomAttribute table - - Writer - Metadata - Table - - - - Writes a FieldMarshal table - - Writer - Metadata - Table - - - - Writes a DeclSecurity table - - Writer - Metadata - Table - - - - Writes a ClassLayout table - - Writer - Metadata - Table - - - - Writes a FieldLayout table - - Writer - Metadata - Table - - - - Writes a StandAloneSig table - - Writer - Metadata - Table - - - - Writes a EventMap table - - Writer - Metadata - Table - - - - Writes a EventPtr table - - Writer - Metadata - Table - - - - Writes a Event table - - Writer - Metadata - Table - - - - Writes a PropertyMap table - - Writer - Metadata - Table - - - - Writes a PropertyPtr table - - Writer - Metadata - Table - - - - Writes a Property table - - Writer - Metadata - Table - - - - Writes a MethodSemantics table - - Writer - Metadata - Table - - - - Writes a MethodImpl table - - Writer - Metadata - Table - - - - Writes a ModuleRef table - - Writer - Metadata - Table - - - - Writes a TypeSpec table - - Writer - Metadata - Table - - - - Writes a ImplMap table - - Writer - Metadata - Table - - - - Writes a FieldRVA table - - Writer - Metadata - Table - - - - Writes a ENCLog table - - Writer - Metadata - Table - - - - Writes a ENCMap table - - Writer - Metadata - Table - - - - Writes a Assembly table - - Writer - Metadata - Table - - - - Writes a AssemblyProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyOS table - - Writer - Metadata - Table - - - - Writes a AssemblyRef table - - Writer - Metadata - Table - - - - Writes a AssemblyRefProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyRefOS table - - Writer - Metadata - Table - - - - Writes a File table - - Writer - Metadata - Table - - - - Writes a ExportedType table - - Writer - Metadata - Table - - - - Writes a ManifestResource table - - Writer - Metadata - Table - - - - Writes a NestedClass table - - Writer - Metadata - Table - - - - Writes a GenericParam table - - Writer - Metadata - Table - - - - Writes a MethodSpec table - - Writer - Metadata - Table - - - - Writes a GenericParamConstraint table - - Writer - Metadata - Table - - - - Writes a Document table - - Writer - Metadata - Table - - - - Writes a MethodDebugInformation table - - Writer - Metadata - Table - - - - Writes a LocalScope table - - Writer - Metadata - Table - - - - Writes a LocalVariable table - - Writer - Metadata - Table - - - - Writes a LocalConstant table - - Writer - Metadata - Table - - - - Writes a ImportScope table - - Writer - Metadata - Table - - - - Writes a StateMachineMethod table - - Writer - Metadata - Table - - - - Writes a CustomDebugInformation table - - Writer - Metadata - Table - - - - flags - - - - - Preserves all rids in the TypeRef table - - - - - Preserves all rids in the TypeDef table - - - - - Preserves all rids in the Field table - - - - - Preserves all rids in the Method table - - - - - Preserves all rids in the Param table - - - - - Preserves all rids in the MemberRef table - - - - - Preserves all rids in the StandAloneSig table - - - - - Preserves all rids in the Event table - - - - - Preserves all rids in the Property table - - - - - Preserves all rids in the TypeSpec table - - - - - Preserves all rids in the MethodSpec table - - - - - Preserves all method rids, i.e., Method, MemberRef and - MethodSpec rids. - - - - - Preserves all rids in the following tables: TypeRef, TypeDef, - Field, Method, Param, MemberRef, StandAloneSig, - Event, Property, TypeSpec, MethodSpec - - - - - Preserves all offsets in the #Strings heap (the original #Strings heap will be saved - in the new file). Type names, field names, and other non-user strings are stored - in the #Strings heap. - - - - - Preserves all offsets in the #US heap (the original #US heap will be saved - in the new file). User strings (referenced by the ldstr instruction) are stored in - the #US heap. - - - - - Preserves all offsets in the #Blob heap (the original #Blob heap will be saved - in the new file). Custom attributes, signatures and other blobs are stored in the - #Blob heap. - - - - - Preserves the extra data that is present after the original signature in the #Blob - heap. This extra data shouldn't be present but might be present if an obfuscator - has added this extra data and is eg. using it to decrypt stuff. - - - - - Preserves as much as possible - - - - - The original method body's max stack field should be used and a new one should not - be calculated. - - - - - Always create the #GUID heap even if it's empty - - - - - Always create the #Strings heap even if it's empty - - - - - Always create the #US heap even if it's empty - - - - - Always create the #Blob heap even if it's empty - - - - - Sort the InterfaceImpl table the same way Roslyn sorts it. Roslyn doesn't sort it - according to the ECMA spec, see https://github.com/dotnet/roslyn/issues/3905 - - - - - Don't write method bodies - - - - - Don't write .NET resources - - - - - Don't write field data - - - - - Serialized type names stored in custom attributes are optimized if the types - exist in the core library (eg. mscorlib/System.Private.CoreLib). - Instead of storing type-name + assembly-name, only type-name is stored. This results in - slightly smaller assemblies. -
-
- If it's a type in the current module, the type name is optimized and no assembly name is stored in the custom attribute. -
-
- This is disabled by default. It's safe to enable if the reference core assembly - is the same as the runtime core assembly (eg. it's mscorlib.dll and .NET Framework, - but not .NET Core / .NET Standard). -
-
- - - Metadata heaps event args - - - - - Gets the metadata writer - - - - - Gets all heaps - - - - - Constructor - - Metadata writer - All heaps - - - - options - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Various options - - - - - Extra heaps to add to the metadata. Also see and - - - - - Raised after all heaps have been added. The caller can sort the list if needed - - - - - Preserves the original order of heaps, and optionally adds all custom heaps to . - - Original module with the heaps - If true, all custom streams are added to - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Meta data header options - - - - Constructor - - Meta data header options - Flags - - - - Portable PDB metadata kind - - - - - No debugging metadata - - - - - Standalone / embedded portable PDB metadata - - - - - Metadata writer event args - - - - - Gets the metadata writer - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Metadata writer progress event args - - - - - Gets the metadata writer - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - .NET meta data - - - - - Raised at various times when writing the metadata - - - - - Raised when the progress is updated - - - - - Gets/sets the logger - - - - - Gets the module - - - - - Gets the constants - - - - - Gets the method body chunks - - - - - Gets the .NET resources - - - - - Gets the MD header - - - - - Gets the tables heap. Access to this heap is not recommended, but is useful if you - want to add random table entries. - - - - - Gets the #Strings heap. Access to this heap is not recommended, but is useful if you - want to add random strings. - - - - - Gets the #US heap. Access to this heap is not recommended, but is useful if - you want to add random user strings. - - - - - Gets the #GUID heap. Access to this heap is not recommended, but is useful if you - want to add random GUIDs. - - - - - Gets the #Blob heap. Access to this heap is not recommended, but is useful if you - want to add random blobs. - - - - - Gets the #Pdb heap. It's only used if it's portable PDB metadata - - - - - Gets all exported methods - - - - - The public key that should be used instead of the one in . - - - - - Creates a instance - - Module - Constants list - Method bodies list - .NET resources list - Options - Debug metadata kind - A new instance - - - - - - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - If true, use the original Field RVAs. If it has no RVA, assume it's a new - field value and create a new Field RVA. - - - - - Gets the number of methods that will be written. - - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the - - Method - The or null if is - null or not a method defined in this module. - - - - Gets a method's local variable signature token - - Method - Locals sig token or 0 - - - - Gets the where the resource data will be stored - - Embedded resource - A instance or null if - is invalid - - - - Gets the where the initial value is stored - - Field - A instance or null if - is invalid - - - - Called when an error is detected - - Error message - Optional message arguments - - - - Called to warn of something - - Warning message - Optional message arguments - - - - Raises - - Event - - - - Raises the progress event - - Base event - Sub progress - - - - Creates the .NET metadata tables - - - - - Updates each Method row's RVA column if it has any code - - - - - Updates the FieldRVA rows - - - - - Initializes all TypeDef, Field, Method, Event, - Property and Param rows. Other tables that are related to these six - tables are also updated. No custom attributes are written yet, though. Method bodies - aren't written either. - - - - - Writes TypeDef, Field, Method, Event, - Property and Param custom attributes and custom debug infos. - - - - - Adds the tokens of all methods in all vtables, if any - - - - - Adds the entry point. It's only needed if it's a since if it's - a , it will have already been added. - - - - - Sorts all unsorted tables except GenericParamConstraint and CustomAttribute - - - - - Initializes the GenericParamConstraint table - - - - - Inserts all custom attribute / custom debug info rows in the tables and sort them - - - - - Writes all method bodies - - - - - Checks whether a list is empty or whether it contains only nulls - - Any type - The list - true if the list is empty or if it contains only nulls, false otherwise - - - - - - - - - - Adds a - - Method signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - FIeld signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a NestedType row - - Nested type - Declaring type - - - - Adds a Module row - - Module - Its new rid - - - - Adds a ModuleRef row - - Module ref - Its new rid - - - - Adds an AssemblyRef row - - Assembly ref - Its new rid - - - - Adds an Assembly row - - Assembly - The public key that should be used - Its new rid - - - - Adds generic parameters - - New token of owner - All generic params - - - - Adds a generic param - - New token of owner - Generic paramater - - - - Adds generic parameter constraints - - New rid of owner generic param - Its constraints - - - - Adds a generic parameter constraint - - New rid of owner generic param - Generic parameter constraint - - - - Adds a InterfaceImpl row - - New rid of owner - All interfaces - - - - Adds a FieldLayout row - - Owner field - - - - Adds a FieldMarshal row - - New owner token - Owner - - - - Adds a FieldRVA row - - The field - - - - Adds a ImplMap row - - New owner token - Owner - - - - Adds a Constant row - - New owner token - Owner - - - - Adds a DeclSecurity row - - New owner token - All DeclSecurity rows - - - - Adds MethodSemantics rows - - Event - - - - Adds MethodSemantics rows - - Property - - - - Adds a ClassLayout row - - Type - - - - Adds a File row - - File - Its new rid - - - - Adds a ExportedType row - - Exported type - Its new rid - - - - Gets a #Blob offset of a type signature - - Type sig - Extra data to append the signature if - is true. - #Blob offset - - - - Gets a #Blob offset of a calling convention signature - - Signature - #Blob offset - - - - Adds a CustomAttribute row - - Owner table - New owner rid - Onwer - - - - Adds a CustomDebugInformation row - - Owner table - New owner rid - Onwer - - - - Writes the portable PDB to . - - Output stream - Entry point token - Updated with the offset of the 20-byte PDB ID. The caller is responsible for initializing it with the PDB ID - - - - - - - - - - - - - Called before any other methods - - - - - Gets all s that should be saved in the meta data - - - - - Initializes TypeDef rids and creates raw rows, but does not initialize - any columns. - - - - - Allocates Field, Method, Property, Event, Param: - rid and raw row, but doesn't initialize the raw row. - Initializes TypeDef columns: FieldList, MethodList. - Initializes Method column: ParamList. - Initializes and . - - - - - Adds a . Its custom attributes are also added. - - Type reference - Its new rid - - - - Adds a . Its custom attributes are also added. - - Type spec - Its new rid - - - - Adds a . Its custom attributes are also added. - - Member ref - Its new rid - - - - Adds a . Its custom attributes are also added. - - Stand alone sig - Its new rid - - - - Adds a . Its custom attributes are also added. - - Method spec - Its new rid - - - - Called before sorting the CustomAttribute table. This is the last time anything - can be inserted into this table. - - - - - Called after everything has been initialized. The sub class can initialize more - rows if necessary or do nothing. After this method has been called, nothing else - can be added. - - - - - Should be called before all chunks get an RVA - - - - - - - - - - - - - - - - - Sorts the s - - All s - A sorted list - - - - All events - - - - - Creating the tables has just begun - - - - - Before allocating all TypeDef RIDs - - - - - Before allocating all MemberDef RIDs - - - - - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Before sorting most tables - - - - - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - All resources are about to be added to the .NET resources table - - - - - All resources have been added to the .NET resources table - - - - - All method bodies are about to be written - - - - - All method bodies have been written. Their RVAs are still not known. - - - - - All tables are now sorted, including the CustomAttribute table. - - - - - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - options - - - - - Default version string - - - - - Default header signature - - - - - MD header signature. Default value is - - - - - Major version. Default is 1. MS' CLR supports v0.x (x >= 19) and v1.1, nothing else. - - - - - Minor version. Default is 1. - - - - - Reserved and should be 0. - - - - - Version string. Default is . It's stored as a - zero-terminated UTF-8 string. Length should be <= 255 bytes. - - - - - Storage flags should be 0 - - - - - Reserved and should be 0 - - - - - Creates portable PDB v1.0 options - - - - - - Meta data header. IMAGE_COR20_HEADER.Metadata points to this header. - - - - - - - - - - - Gets/sets the heaps - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Method body chunk - - - - - - - - - - - Gets the code - - - - - Gets the extra sections (exception handlers) or null - - - - - Gets the token of the locals - - - - - true if it's a fat body - - - - - true if it's a tiny body - - - - - true if there's an extra section - - - - - Constructor - - Code - - - - Constructor - - Code - Extra sections or null - - - - Constructor - - Code - Extra sections or null - Token of locals - - - - Gets the approximate size of the method body (code + exception handlers) - - - - - - - - - - - - - - - - - - - - - - - Stores all method body chunks - - - - - - - - - - - Gets the number of bytes saved by re-using method bodies - - - - - Constructor - - true if bodies can be shared - - - - Adds a and returns the one that has been cached - - The method body - The cached method body - - - Removes the specified method body from this chunk - The method body - if the method body is removed - - - - - - - - - - - - - - - - Returns tokens of token types, strings and signatures - - - - - Gets the token of - - A token type or a string or a signature - The token - - - - Gets a StandAloneSig token - - All locals - The original token or 0 if none - A StandAloneSig token or 0 if is - empty. - - - - Writes CIL method bodies - - - - - Gets the code as a byte array. This is valid only after calling . - The size of this array is not necessarily a multiple of 4, even if there are exception - handlers present. See also - - - - - Gets the extra sections (exception handlers) as a byte array or null if there - are no exception handlers. This is valid only after calling - - - - - Gets the token of the locals - - - - - Constructor - - Helps this instance - The CIL method body - - - - Constructor - - Helps this instance - The CIL method body - Keep the original max stack value that has been initialized - in - - - - Writes the method body - - - - - Gets the code and (possible) exception handlers in one array. The exception handlers - are 4-byte aligned. - - The code and any exception handlers - - - - - - - - - - - - - - - - - - - - - - - - - Base class of all CIL method body writers - - - - - - - - - - - true if there was at least one error - - - - - Constructor - - All instructions - All exception handlers - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Gets max stack value - - - - - Gets the offset of an instruction - - The instruction - The offset or 0 if is null or not - present in the list of all instructions. - - - - Initializes instruction offsets and returns the total code size - - Size of code - - - - Gets the size of an instruction - - The instruction - Size of the instruction in bytes - - - - Writes all instructions to at its current offset - - The instruction writer - Number of bytes written - - - - Gets the current offset in the instruction stream. This offset is relative to - the first written instruction. - - The instruction writer - Current offset, relative to the first written instruction - - - - Writes an instruction - - The instruction writer - The instruction - - - - Writes an instruction's opcode - - The instruction writer - The instruction - - - - Writes an instruction's operand - - The instruction writer - The instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - options - - - - - Constructor - - The module - - - - Writes a .NET PE file. See also - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .sdata section - - - - - Gets the .rsrc section or null if none - - - - - Gets the .reloc section - - - - - Gets the PE headers - - - - - Gets the IAT or null if there's none - - - - - Gets the .NET header - - - - - Gets the import directory or null if there's none - - - - - Gets the startup stub or null if there's none - - - - - Gets the reloc directory or null if there's none - - - - - Constructor - - The module - - - - Constructor - - The module - Options or null - - - - - - - - - - Module writer event args - - - - - Gets the writer ( or ) - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Module writer progress event args - - - - - Gets the writer ( or ) - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - Content ID - - - - - Gets the GUID - - - - - Gets the timestamp - - - - - Constructor - - Guid - Timestamp - - - - Event handler - - Event args type - Sender - Event args - - - - PDB writer options - - - - - No bit is set - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - This is only used if it's a Windows PDB file. - - - - - Don't use diasymreader.dll's PDB writer that is shipped with .NET Framework. - - This is only used if it's a Windows PDB file. - - - - - Create a deterministic PDB file and add a debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Hash the PDB file and add a PDB checksum debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Common module writer options base class - - - - - Raised at various times when writing the file. The listener has a chance to modify - the file, eg. add extra metadata, encrypt methods, etc. - - - - - Raised when the progress is updated - - - - - Gets/sets the logger. If this is null, any errors result in a - being thrown. To disable this behavior, either - create your own logger or use . - - - - - Gets/sets the writer logger. If this is null, use - . - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - If true, Win32 resources aren't written to the output - - - - - Gets/sets the Win32 resources. If this is null, use the module's - Win32 resources if any. - - - - - true to delay sign the assembly. Initialize to the - public key to use, and don't initialize . To generate the - public key from your strong name key file, execute sn -p mykey.snk mypublickey.snk - - - - - Gets/sets the strong name key. When you enhance strong name sign an assembly, - this instance's HashAlgorithm must be initialized to its public key's HashAlgorithm. - You should call - to initialize this property if you use normal strong name signing. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - Gets/sets the new public key that should be used. If this is null, use - the public key generated from . If it is also null, - use the module's Assembly's public key. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - true if method bodies can be shared (two or more method bodies can share the - same RVA), false if method bodies can't be shared. Don't enable it if there - must be a 1:1 relationship with method bodies and their RVAs. - This is enabled by default and results in smaller files. - - - - - true if the PE header CheckSum field should be updated, false if the - CheckSum field isn't updated. - - - - - true if it's a 64-bit module, false if it's a 32-bit or AnyCPU module. - - - - - Gets/sets the module kind - - - - - true if it should be written as an EXE file, false if it should be - written as a DLL file. - - - - - Set it to true to enable writing a PDB file. Default is false (a PDB file - won't be written to disk). - - - - - PDB writer options. This property is ignored if is false. - - - - - PDB file name. If it's null a PDB file with the same name as the output assembly - will be created but with a PDB extension. must be true or - this property is ignored. - - - - - PDB file name stored in the debug directory, or null to use - - - - - PDB stream. If this is initialized, then you should also set - to the name of the PDB file since the file name must be written to the PE debug directory. - must be true or this property is ignored. - - - - - Gets the PDB content id (portable PDBs). The argument is the PDB stream with the PDB ID zeroed out, - and the 2nd argument is the default timestamp. - This property is ignored if a deterministic PDB file is created or if the PDB checksum is calculated. - - - - - PDB checksum algorithm - - - - - true if an .mvid section should be added to the assembly. Not used by native module writer. - - - - - Constructor - - The module - - - - Initializes and - for normal strong name signing. - - Module - Signature strong name key pair - - - - Initializes and - for enhanced strong name signing (without key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - - - - Initializes and - for enhanced strong name signing (with key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - Identity strong name key pair - Identity public key - - - - Module writer base class - - - - Default alignment of all constants - - - Default alignment of all method bodies - - - Default alignment of all .NET resources - - - Default alignment of the .NET metadata - - - Default Win32 resources alignment - - - Default strong name signature alignment - - - Default COR20 header alignment - - - See - - - See - - - See - - - See - - - See - - - See - - - Offset where the module is written. Usually 0. - - - Debug directory - - - - Strong name signature - - - - - Returns the module writer options - - - - - Gets the destination stream - - - - - Gets the constants - - - - - Gets the method bodies - - - - - Gets the .NET resources - - - - - Gets the .NET metadata - - - - - Gets the Win32 resources or null if there's none - - - - - Gets the strong name signature or null if there's none - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Gets the debug directory or null if there's none - - - - - true if this is a , false if - this is a . - - - - - null if we're not writing a PDB - - - - - Writes the module to a file - - File name. The file will be truncated if it exists. - - - - Writes the module to a - - Destination stream - - - - Returns the module that is written - - - - - Writes the module to . Event listeners and - have been initialized when this method is called. - - Number of bytes written - - - - Creates the strong name signature if the module has one of the strong name flags - set or wants to sign the assembly. - - - - - Creates the .NET metadata chunks (constants, method bodies, .NET resources, - the metadata, and Win32 resources) - - - - - - Gets the Win32 resources that should be written to the new image or null if none - - - - - Calculates and of all s - - All chunks - Starting file offset - Starting RVA - File alignment - Section alignment - - - - Writes all chunks to - - The writer - All chunks - File offset of first chunk - File alignment - - - - Strong name sign the assembly - - Strong name signature offset - - - - Creates the debug directory if a PDB file should be written - - - - - Write the PDB file. The caller should send the PDB events before and after calling this - method. - - - - - Gets the timestamp stored in the PE header - - - - - - Raises a writer event - - Event - - - - - - - - - - Logs an error message - - Format - Format args - - - - Logs a warning message - - Format - Format args - - - - All / events - - - - - Writing has just begun - - - - - All PE sections have been created - - - - - All chunks have been created - - - - - All chunks have been added to their sections - - - - - Original event: . - Creating the metadata tables has just begun - - - - - Original event: . - Before allocating all TypeDef RIDs - - - - - Original event: . - Before allocating all MemberDef RIDs - - - - - Original event: . - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - Original event: . - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Original event: . - Before sorting most tables - - - - - Original event: . - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Original event: . - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - Original event: . - All resources are about to be added to the .NET resources table - - - - - Original event: . - All resources have been added to the .NET resources table - - - - - Original event: . - All method bodies are about to be written - - - - - Original event: . - All method bodies have been written. Their RVAs are still not known. - - - - - Original event: . - All tables are now sorted, including the CustomAttribute table. - - - - - Original event: . - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - This event occurs before the PDB file is written. This event occurs even if no PDB file - will be written. - - - - - The PDB file has been written. This event occurs even if no PDB file has been written. - - - - - This event occurs just before all RVAs and file offsets of the chunks are calculated. - - - - - File offsets and RVAs of all chunks are now known. This includes method body and - field RVAs. Nothing has been written to the destination stream yet. - - - - - This event occurs before all chunks are written to the destination stream, and after - all RVAs and file offsets are known. - - - - - All chunks have been written to the destination stream. - - - - - This event occurs before the strong name signature is calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs after the strong name signature has been calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs before the checksum in the PE header is updated. This event - occurs even if the checksum isn't updated. - - - - - This event occurs after the checksum in the PE header has been updated. This event - occurs even if the checksum isn't updated. - - - - - Writing has ended - - - - - Thrown when the module writer encounters an unrecoverable error - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - options - - - - - If true, any extra data after the PE data in the original file is also saved - at the end of the new file. Enable this option if some protector has written data to - the end of the file and uses it at runtime. - - - - - If true, keep the original Win32 resources - - - - - Constructor - - Module - true to optimize the image size so it's as small as possible. - Since the file can contain native methods and other native data, we re-use the - original file when writing the new file. If is true, - we'll try to re-use the old method body locations in the original file and - also try to fit the new metadata in the old metadata location. - - - - A module writer that supports saving mixed-mode modules (modules with native code). - The original image will be re-used. See also - - - - The original .NET module - - - All options - - - - Any extra data found at the end of the original file. This is null if there's - no extra data or if is - false. - - - - The original PE sections and their data - - - Original PE image - - - New sections we've added and their data - - - New .text section where we put some stuff, eg. .NET metadata - - - The new COR20 header - - - - New .rsrc section where we put the new Win32 resources. This is null if there - are no Win32 resources or if - is true - - - - - Offset in of the PE checksum field. - - - - - Original PE section - - - - PE section - - - PE section data - - - - Constructor - - PE section - - - - - - - - - - Gets the module - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s - - - - - Gets the original PE sections and their data - - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Constructor - - The module - Options or null - - - - - - - - - - Gets the raw section data of the image. The sections are saved in - . - - - - - Creates the PE header "section" - - - - - Saves any data that is appended to the original PE file - - - - - true if image is 64-bit - - - - - Updates the PE header and COR20 header fields that need updating. All sections are - also updated, and the new ones are added. - - - - - Converts to a file offset in the destination stream - - RVA - - - - Gets the entry point - - Updated with entry point (either a token or RVA of native method) - true if it's a managed entry point or there's no entry point, - false if it's a native entry point - - - - .NET resources - - - - - - - - - - - Gets offset of next resource. This offset is relative to the start of - the .NET resources and is always aligned. - - - - - Constructor - - Alignment of all resources - - - - Adds a resource - - The resource data - The resource data - - - - - - - - - - - - - - - - Does not preserve metadata tokens - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Pdb heap - - - - - - - - Gets the PDB ID. This is always 20 bytes in size. - - - - - Gets/sets the entry point token - - - - - Gets the offset of the 20-byte PDB ID - - - - - Gets/sets the referenced type system tables - - - - - Gets the type system table rows. This table has 64 elements. - - - - - Constructor - - - - - - - - - - - options - - - - - Default DLL characteristics - - - - - Default subsystem value - - - - - Default major linker version. Roslyn C# defaults to 0x30, and Roslyn VB defaults to 0x50. - - - - - Default minor linker version - - - - - IMAGE_FILE_HEADER.Machine value - - - - - IMAGE_FILE_HEADER.TimeDateStamp value - - - - - IMAGE_FILE_HEADER.PointerToSymbolTable value - - - - - IMAGE_FILE_HEADER.NumberOfSymbols value - - - - - IMAGE_FILE_HEADER.Characteristics value. bit - is ignored and set/cleared depending on whether it's a EXE or a DLL file. - - - - - IMAGE_OPTIONAL_HEADER.MajorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.ImageBase value - - - - - IMAGE_OPTIONAL_HEADER.SectionAlignment value - - - - - IMAGE_OPTIONAL_HEADER.FileAlignment value - - - - - IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.Win32VersionValue value - - - - - IMAGE_OPTIONAL_HEADER.Subsystem value - - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackCommit value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit value - - - - - IMAGE_OPTIONAL_HEADER.LoaderFlags value - - - - - IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes value - - - - - Creates a new time date stamp using current time - - A new time date stamp - - - - DOS and PE headers - - - - - Gets/sets the native entry point - - - - - Gets/sets the COR20 header - - - - - Gets/sets the IAT - - - - - Gets/sets the - - - - - Gets/sets the Win32 resources - - - - - Gets/sets the relocation directory - - - - - Gets/sets the debug directory - - - - - Gets the image base - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets the section alignment - - - - - Gets the file alignment - - - - - Gets/sets the s - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Calculates the PE checksum and writes it to the checksum field - - Writer - Length of PE file - - - - A PE section - - - - - Gets the name - - - - - Gets the Characteristics - - - - - true if this is a code section - - - - - true if this is an initialized data section - - - - - true if this is an uninitialized data section - - - - - Constructor - - Section name - Section characteristics - - - - Writes the section header to at its current position. - Returns aligned virtual size (aligned to ) - - Writer - File alignment - Section alignment - Current - - - - Preserves metadata tokens - - - - - Its real rid - - - - - Its logical rid or real rid. If the ptr table exists (eg. MethodPtr), then it's - an index into it, else it's the real rid. - - - - - Gets total number of defs in the list. It does not necessarily return - the table size. Use for that. - - - - - Gets the number of rows that need to be created in the table - - - - - Returns true if the ptr table (eg. MethodPtr) is needed - - - - - Sorts the table - - Comparer - - - - Adds a def. must be called after adding the last def. - - The def - Collection position - - - - Must be called after 'ing the last def - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reserves rows in TypeRef, MemberRef, StandAloneSig, - TypeSpec and MethodSpec where we will store the original rows - to make sure they get the same rid. Any user created rows will be stored at - the end of each table. - - - - - Adds any non-referenced rows that haven't been added yet but are present in - the original file. If there are any non-referenced rows, it's usually a sign - that an obfuscator has encrypted one or more methods or that it has added - some rows it uses to decrypt something. - - - - - - - - Re-uses all Field rows which aren't owned by any type due to the fields - having been deleted by the user. The reason we must do this is that the - FieldPtr and Field tables must be the same size. - - - - - Re-uses all Method rows which aren't owned by any type due to the methods - having been deleted by the user. The reason we must do this is that the - MethodPtr and Method tables must be the same size. - - - - - Re-uses all Param rows which aren't owned by any type due to the params - having been deleted by the user. The reason we must do this is that the - ParamPtr and Param tables must be the same size. - This method must be called after since - this method will create more methods at the end of the Method table. - - - - - Re-uses all Event rows which aren't owned by any type due to the events - having been deleted by the user. The reason we must do this is that the - EventPtr and Event tables must be the same size. - - - - - Re-uses all Property rows which aren't owned by any type due to the properties - having been deleted by the user. The reason we must do this is that the - PropertyPtr and Property tables must be the same size. - - - - - Creates a dummy TypeDef at the end of the TypeDef table that will own - dummy methods and fields. These dummy methods and fields are only created if the size - of the ptr table is less than the size of the non-ptr table (eg. size MethodPtr table - is less than size Method table). The only reason the ptr table would be smaller than - the non-ptr table is when some field/method has been deleted and we must preserve - all method/field rids. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Relocations directory - - - - - - - - - - - Constructor - - Machine - - - - - - - - - - - - - - - - Adds a relocation - - RVA of location - - - - Adds a relocation - - Chunk or null. If it's null, is the RVA - Offset relative to the start of , or if is null, this is the RVA - - - - Length of section - - - - - Section characteristics - - - - - Constructor - - Length of section - Section characteristics - - - - Calculates the optional header section sizes - - - - - Helps map s to tokens - - - - - Returns a TypeDefOrRef encoded token - - A TypeDefOrRef type - - - - Writes signatures - - - - - Write a signature - - Helper - The type - The signature as a byte array - - - - Write a signature - - Helper - The signature - The signature as a byte array - - - - - - - Stores the instruction that jumps to _CorExeMain/_CorDllMain - - - - - Gets/sets the - - - - - Gets/sets the - - - - - - - - - - - Gets the address of the JMP instruction - - - - - Constructor - - Reloc directory - Machine - Error logger - - - - - - - - - - - - - - - - #Strings heap - - - - - - - - Populates strings from an existing (eg. to preserve - string offsets) - - The #Strings stream with the original content - - - - Adds a string to the #Strings heap. The returned value is not necessarily an offset in - the #Strings heap. Call to get the offset. - - The string - The offset id. This is not a #Strings offset. Call to get the #Strings offset - - - - Gets the offset of a string in the #Strings heap. This method can only be called after - all strings have been added. - - Offset id returned by - - - - - Adds a string to the #Strings heap, but does not re-use an existing position - - The string - The offset of the string in the #Strings heap - - - - - - - - - - - - - - - - - - - Strong name signature chunk - - - - - - - - - - - Constructor - - Size of strong name signature - - - - - - - - - - - - - - - - options - - - - - Should be 0 - - - - - Major version number. Default is 2. Valid versions are v1.0 (no generics), - v1.1 (generics are supported), or v2.0 (recommended). - - - - - Minor version number. Default is 0. - - - - - Force #- or #~ stream. Default value is null and recommended because the correct - tables stream will be used. true will force #- (Edit N' Continue) - stream, and false will force #~ (normal compressed) stream. - - - - - Extra data to write - - - - - true if there are deleted s, s, - s, s, s and/or - s. - - - - - Creates portable PDB v1.0 options - - - - - - Contains all .NET tables - - - - - - - - - - - All tables - - - - - - - - - - - true if the Edit 'N Continue name will be used (#-) - - - - - true if any rows have been deleted (eg. a deleted TypeDef, Method, Field, etc. - Its name has been renamed to _Deleted). - - - - - true if #Strings heap size > 0xFFFF - - - - - true if #GUID heap size > 0xFFFF - - - - - true if #Blob heap size > 0xFFFF - - - - - Constructor - - Metadata owner - Options - - - - - - - - - - - - - - - - Calculates the length. This will set all MD tables to read-only. - - - - - - - - - - - Re-uses existing chunks to save space - - Chunk type - - - - Default constructor - - - - - Constructor - - Compares the chunk type - - - - - - - Adds a if not already present - - The chunk to add or null if none - Chunk alignment - The original input if it wasn't present, or the cached one - - - - #US heap - - - - - - - - Populates strings from an existing (eg. to preserve - string tokens) - - The #US stream with the original content - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - - - - - - - - - - - - - - - - Writes Win32 resources - - - - - - - - - - - Constructor - - Win32 resources - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - 's name. must have been - called. - - The name of a - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a 's name. - must have been called. - - The name of a - The file offset or 0 if is invalid - - - - Returns the of a 's name. - must have been called. - - The name of a - The RVA or 0 if is invalid - - - - - - - - - - - - - - - - A that reads from a byte array - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since a has nothing that must be cleaned up - - - - - Thrown by a when it can't read data or if the caller tries to set an invalid offset - - - - - Reads data - - - - - Gets the start offset of the data - - - - - Gets the end offset of the data, not inclusive - - - - - Gets the total length of the data - - - - - Gets the current offset. This is between and (inclusive) - - - - - Gets/sets the position relative to - - - - - Gets the number of bytes that can be read without throwing an exception - - - - - Constructor - - Stream - Start offset of data - Length of data - - - - Resets the reader so it points to the start of the data - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a UTF-16 encoded - - Number of characters to read - - - - - Reads bytes - - Destination pointer - Number of bytes to read - - - - Reads bytes - - Destination array - Destination index - Number of bytes to read - - - - Reads bytes - - Number of bytes to read - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a serialized UTF-8 string - - - - - - Reads a serialized string - - Encoding - - - - - Returns all data without updating the current position - - - - - - Returns the remaining data - - - - - - Reads all bytes until a terminating byte or returns null if wasn't found. - If found, the current offset is incremented by the length of the returned data - - Terminating byte value - - - - - Reads a zero-terminated UTF-8 string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - - - - - Reads a zero-terminated string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - Encoding - - - - - Reads a UTF-8 encoded string - - Number of bytes to read (not characters) - - - - - Reads a string - - Number of bytes to read (not characters) - Encoding - - - - - Creates a that can access this content. The caller doesn't have to dispose of the returned stream. - - - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Creates s that can read its data. - - This factory class is thread safe and its data can be read by on any thread. - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a data reader that can read all data - - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Stream - Offset of data - Length of data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Disposes of this instance - - - - - This class is used by a . The instance - verifies that all input are valid before calling any methods in this class. - This class is thread safe. - - - - - Reads bytes - - Offset of data - Destination pointer - Number of bytes to read - - - - Reads bytes - - Offset of data - Destination array - Destination index - Number of bytes to read - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a UTF-16 encoded - - Offset of data - Number of characters to read - - - - - Reads a string - - Offset of data - Length of string in bytes - Encoding - - - - - Gets the data offset of a byte or returns false if the byte wasn't found - - Offset of data - End offset of data (not inclusive) - Byte value to search for - Offset of the byte if found - - - - - Creates s - - - - - Creates a that reads from native memory - - Pointer to data - - - - - Creates a that reads from a byte array - - Data - - - - - Represents a file offset - - - - - Extension methods - - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Base class for classes needing to implement IFileSection - - - - - The start file offset of this section - - - - - Size of the section - - - - - - - - - - - Set to 's current position - - The reader - - - - Set according to 's current position - - The reader - - - - Represents a section in a file - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Creates s that read memory mapped data - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Cleans up and frees all allocated memory - - - - - true if memory mapped I/O is enabled - - - - - Call this to disable memory mapped I/O. This must only be called if no other code is - trying to access the memory since that could lead to an exception. - - - - - Creates s that read native memory - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Pointer to data - Length of data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since this instance doesn't own the native memory - - - - - IMAGE_FILE_HEADER.Characteristics flags - - - - Relocation info stripped from file. - - - File is executable (i.e. no unresolved externel references). - - - Line nunbers stripped from file. - - - Local symbols stripped from file. - - - Agressively trim working set - - - App can handle >2gb addresses - - - - - - Bytes of machine word are reversed. - - - 32 bit word machine. - - - Debugging info stripped from file in .DBG file - - - If Image is on removable media, copy and run from the swap file. - - - If Image is on Net, copy and run from the swap file. - - - System File. - - - File is a DLL. - - - File should only be run on a UP machine - - - Bytes of machine word are reversed. - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics - - - - - - - - - - - - - - - - - - - Image can handle a high entropy 64-bit virtual address space. - - - DLL can move. - - - Code Integrity Image - - - Image is NX compatible - - - Image understands isolation and doesn't want it - - - Image does not use SEH. No SE handler may reside in this image - - - Do not bind this image. - - - Image should execute in an AppContainer - - - Driver uses WDM model - - - Image supports Control Flow Guard. - - - - - - - Interface for PE optional header classes - - - - - Returns the Magic field - - - - - Returns the MajorLinkerVersion field - - - - - Returns the MinorLinkerVersion field - - - - - Returns the SizeOfCode field - - - - - Returns the SizeOfInitializedData field - - - - - Returns the SizeOfUninitializedData field - - - - - Returns the AddressOfEntryPoint field - - - - - Returns the BaseOfCode field - - - - - Returns the BaseOfData field - - - - - Returns the ImageBase field - - - - - Returns the SectionAlignment field - - - - - Returns the FileAlignment field - - - - - Returns the MajorOperatingSystemVersion field - - - - - Returns the MinorOperatingSystemVersion field - - - - - Returns the MajorImageVersion field - - - - - Returns the MinorImageVersion field - - - - - Returns the MajorSubsystemVersion field - - - - - Returns the MinorSubsystemVersion field - - - - - Returns the Win32VersionValue field - - - - - Returns the SizeOfImage field - - - - - Returns the SizeOfHeaders field - - - - - Returns the CheckSum field - - - - - Returns the Subsystem field - - - - - Returns the DllCharacteristics field - - - - - Returns the SizeOfStackReserve field - - - - - Returns the SizeOfStackCommit field - - - - - Returns the SizeOfHeapReserve field - - - - - Returns the SizeOfHeapCommit field - - - - - Returns the LoaderFlags field - - - - - Returns the NumberOfRvaAndSizes field - - - - - Returns the DataDirectories field. This array contains exactly 16 elements. - - - - - Represents the IMAGE_DATA_DIRECTORY PE section - - - - - Returns the IMAGE_DATA_DIRECTORY.VirtualAddress field - - - - - Returns the IMAGE_DATA_DIRECTORY.Size field - - - - - Default constructor - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - A IMAGE_DEBUG_DIRECTORY - - - - - Gets the characteristics (reserved) - - - - - Gets the timestamp - - - - - Gets the major version - - - - - Gets the minor version - - - - - Gets the type - - - - - Gets the size of data - - - - - RVA of the data - - - - - File offset of the data - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Image debug type, see IMAGE_DEBUG_TYPE_* in winnt.n - - - - - Contains PDB info - - - - - It's a deterministic (reproducible) PE file - - - - - Embedded portable PDB data - - - - - Checksum of the PDB file. 0 or more entries allowed. - - - - - Represents the IMAGE_DOS_HEADER PE section - - - - - File offset of the NT headers - - - - - Constructor - - PE file reader - Verify section - Thrown if verification fails - - - - Represents the IMAGE_FILE_HEADER PE section - - - - - Returns the IMAGE_FILE_HEADER.Machine field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSections field - - - - - Returns the IMAGE_FILE_HEADER.TimeDateStamp field - - - - - Returns the IMAGE_FILE_HEADER.PointerToSymbolTable field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSymbols field - - - - - Returns the IMAGE_FILE_HEADER.SizeOfOptionalHeader field - - - - - Returns the IMAGE_FILE_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the IMAGE_NT_HEADERS PE section - - - - - Returns the IMAGE_NT_HEADERS.Signature field - - - - - Returns the IMAGE_NT_HEADERS.FileHeader field - - - - - Returns the IMAGE_NT_HEADERS.OptionalHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Creates an IImageOptionalHeader - - PE file reader pointing to the start of the optional header - Verify section - The created IImageOptionalHeader - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER (32-bit) PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER64 PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.BaseOfCode field - - - - - Returns 0 since BaseOfData is not present in IMAGE_OPTIONAL_HEADER64 - - - - - Returns the IMAGE_OPTIONAL_HEADER64.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_SECTION_HEADER PE section - - - - - Returns the human readable section name, ignoring everything after - the first nul byte - - - - - Returns the IMAGE_SECTION_HEADER.Name field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualSize field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualAddress field - - - - - Returns the IMAGE_SECTION_HEADER.SizeOfRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Converts s to/from s - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Interface to access a PE image - - - - - true if image layout is the same as the raw PE image layout, false - if it's the same layout as a PE image loaded by the OS PE loader. - - - - - true if some of the memory where the image is located could be unavailable. - This could happen if it's been loaded by the OS loader. - - - - - The filename or null if the data is not from a file - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Returns the debug directories - - - - - Gets/sets the Win32 resources. This is null if there are no Win32 resources. - - - - - Gets the factory - - - - - Creates a from to the end of the image - - Offset of data - - - - - Creates a - - Offset of data - Length of data - - - - - Creates a from to the end of the image - - RVA of data - - - - - Creates a - - RVA of data - Length of data - - - - - Creates a that can read the whole image - - - - - - Interface to access a PE image - - - - - Call this to disable memory mapped I/O if it was used to open the file. This must only - be called if no other code is trying to access the memory since that could lead to an - exception. - - - - - true if memory mapped I/O is enabled - - - - - Extension methods - - - - - Finds a - - this - Type - Name - Language ID - The or null if none found - - - - Calculates a PE checksum - - PE image stream positioned at the MZ bytes - Length of image - Offset of checksum - PE checksum - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Converts a to/from an - - - - - Converts a to an - - The PEInfo context - The file offset to convert - The RVA - - - - Converts an to a - - The PEInfo context - The RVA to convert - The file offset - - - - IMAGE_FILE_HEADER.Machine enum - - - - Unknown machine - - - x86 - - - MIPS little-endian, 0x160 big-endian - - - MIPS little-endian - - - MIPS little-endian - - - MIPS little-endian WCE v2 - - - Alpha_AXP - - - SH3 little-endian - - - - - - SH3E little-endian - - - SH4 little-endian - - - SH5 - - - ARM Little-Endian - - - ARM Thumb/Thumb-2 Little-Endian - - - ARM Thumb-2 Little-Endian - - - - - - IBM PowerPC Little-Endian - - - - - - IA-64 - - - - - - - - - - - - - - - Infineon - - - - - - EFI Byte Code - - - x64 - - - M32R little-endian - - - - - - - - - - Extensions - - - - - Checks if is a 64-bit machine - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Image layout - - - - - Use this if the PE file has a normal structure (eg. it's been read from a file on disk) - - - - - Use this if the PE file has been loaded into memory by the OS PE file loader - - - - - Accesses a PE file - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - Data reader factory - Image layout - Verify PE file data - - - - Constructor - - Name of the file - true if we should map it as an executable - Verify PE file data - - - - Constructor - - Name of the file - Verify PE file data - - - - Constructor - - Name of the file - - - - Constructor - - The PE file data - Filename or null - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Verify PE file data - - - - Constructor - - The PE file data - Filename or null - Verify PE file data - - - - Constructor - - The PE file data - - - - Constructor - - The PE file data - Filename or null - - - - Constructor - - Address of PE image - Length of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - - - - Constructor - - Address of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Verify PE file data - - - - Constructor - - Address of PE image - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reads all PE sections from a PE stream - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify sections - Thrown if verification fails - - - - Returns the first that has data at file offset - - - The file offset - - - - - Returns the first that has data at RVA - - - The RVA - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Returns size of image rounded up to - - It calculates the size itself, and does not return - Size of image in bytes - - - - Represents an RVA (relative virtual address) - - - - - IMAGE_OPTIONAL_HEADER.Subsystem - - - - Unknown subsystem. - - - Image doesn't require a subsystem. - - - Image runs in the Windows GUI subsystem. - - - Image runs in the Windows character subsystem. - - - image runs in the OS/2 character subsystem. - - - image runs in the Posix character subsystem. - - - image is a native Win9x driver. - - - Image runs in the Windows CE subsystem. - - - - - - - - - - - - - - - - - - - - - - dnlib settings - - - - - true if dnlib is thread safe. (THREAD_SAFE was defined during compilation) - - - - - Cancellation token interface - - - - - Throws a if the operation should be canceled - - - - - Simple class using Monitor.Enter() and Monitor.Exit() - and just like ReaderWriterLockSlim it prevents recursive locks. It doesn't support - multiple readers. A reader lock is the same as a writer lock. - - - - - Creates a new instance of this class - - - - - - Constructor - - - - - Enter read mode - - - - - Exit read mode - - - - - Enter write mode - - - - - Exit write mode - - - - - Interface to access a lazily initialized list - - Type to store in list - - - - Gets notified of list events - - List value - - - - Called before a new value is lazily added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list. It can be modified by - the callee. - - - - Called before a new value is added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list - - - - Called before a value is removed from the list. If all elements are removed, - is called, and this method is not called. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index of value - The value that will be removed - - - - Called after the list has been resized (eg. an element has been added/removed). It's not - called when an element is replaced. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the change occurred. - - - - Called before the whole list is cleared. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - - - - Implements a that is lazily initialized - - Type to store in list - - - - Stores a simple value - - - - - true if it has been initialized, false otherwise - - - - - Default constructor - - - - - Constructor that should be used when new elements are inserted into - - User data - - - - Gets the value - - Index in the list - - - - Sets the value - - Index in the list - New value - - - - - - - - - - - - - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - - - - Implements a that is lazily initialized - - Type to store in list - Type of the context passed to the read-value delegate - - - - Stores data and keeps track of the original index and whether the data has been - initialized or not. - - - - - - - - - - - - - - Constructor that should only be called when is initialized. - - Original index of this element - LazyList instance - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Constructor - - Initial length of the list - List listener - Context passed to - Delegate instance that returns original values - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid in rare cases. It must never return - null. - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - Generic parameter context - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid. It must never return null. - - - - Lazily returns the original value if the user hasn't overwritten the value - - Value type - - - - Sets the lock that protects the data - - - - - Set a delegate instance that will return the original value - - - - - Gets/sets the value - - The getter returns the original value if the value hasn't been initialized. - - - - Returns true if the value has been initialized - - - - - Returns true if the value was set by the user - - - - - A resource blob - - - - - Gets the data reader - - - - - - Gets/sets the code page - - - - - Gets/sets the reserved field - - - - - Constructor - - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - Code page - Reserved value - - - - A Win32 resource directory (see IMAGE_RESOURCE_DIRECTORY in the Windows SDK) - - - - See - - - See - - - See - - - See - - - See - - - See - - - - Gets/sets the characteristics - - - - - Gets/sets the time date stamp - - - - - Gets/sets the major version number - - - - - Gets/sets the minor version number - - - - - Gets all directory entries - - - - - Gets all resource data - - - - - Constructor - - Name - - - - Finds a by name - - Name - A or null if it wasn't found - - - - Finds a by name - - Name - A or null if it wasn't found - - - - A Win32 resource directory created by the user - - - - - Constructor - - Name - - - - A Win32 resource directory created from a PE file - - - - - To make sure we don't get stuck in an infinite loop, don't allow more than this - many sub directories. - - - - Owner - - - Directory depth. When creating more 's, - the instances get this value + 1 - - - - Info about all 's we haven't created yet - - - - - Info about all 's we haven't created yet - - - - Offset of resource directory / data - - - - Constructor - - Starts from 0. If it's big enough, we'll stop reading more data. - Name - Resources - Reader positioned at the start of this resource directory - - - - Reads the directory header and initializes and - . - - - - - - Reads a string - - Reader - Offset of string - The string or null if we could not read it - - - - Base class of and - - - - - Gets/sets the name - - - - - Constructor - - Name - - - - - - - A Win32 resource name. It can be either an integer or a string. - - - - - true if is valid - - - - - true if is valid - - - - - The ID. It's only valid if is true - - - - - The name. It's only valid if is true - - - - - Constructor - - ID - - - - Constructor - - Name - - - Converts input to a - - - Converts input to a - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Win32 resources base class - - - - - Gets/sets the root directory - - - - - Finds a - - Type - The or null if none found - - - - Finds a - - Type - Name - The or null if none found - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - - - - Dispose method - - true if called by - - - - Win32 resources class created by the user - - - - - - - - Win32 resources class created from a PE file - - - - - Converts data RVAs to file offsets in - - - - - This reader only reads the raw data. The data RVA is found in the data header and - it's first converted to a file offset using . This file - offset is where we'll read from using this reader. - - - - - This reader only reads the directory entries and data headers. The data is read - by - - - - - - - - Gets the resource reader - - - - - Constructor - - / converter - Reader for the whole Win32 resources section (usually - the .rsrc section). It's used to read 's and - 's but not the actual data blob. - Offset of resource section - Length of resource section - true if this instance can dispose of - Data reader (it's used after converting an - to a ) - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Constructor - - The PE image - - - - Constructor - - The PE image - Reader for the whole Win32 resources section (usually - the .rsrc section) or null if we should create one from the resource data - directory in the optional header - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Creates a new data reader - - RVA of data - Size of data - - - - - - - diff --git a/packages/dnlib.3.3.2/lib/net45/dnlib.dll b/packages/dnlib.3.3.2/lib/net45/dnlib.dll deleted file mode 100644 index c43c9b6..0000000 Binary files a/packages/dnlib.3.3.2/lib/net45/dnlib.dll and /dev/null differ diff --git a/packages/dnlib.3.3.2/lib/net45/dnlib.xml b/packages/dnlib.3.3.2/lib/net45/dnlib.xml deleted file mode 100644 index 9c0ad02..0000000 --- a/packages/dnlib.3.3.2/lib/net45/dnlib.xml +++ /dev/null @@ -1,38514 +0,0 @@ - - - - dnlib - - - - - Returns types without getting stuck in an infinite loop - - - - - Gets a list of all types and nested types - - A list of types - - - - Assembly flags from Assembly.Flags column. - - See CorHdr.h/CorAssemblyFlags - - - No flags set - - - The assembly ref holds the full (unhashed) public key. - - - Processor Architecture unspecified - - - Processor Architecture: neutral (PE32) - - - Processor Architecture: x86 (PE32) - - - Processor Architecture: Itanium (PE32+) - - - Processor Architecture: AMD X64 (PE32+) - - - Processor Architecture: ARM (PE32) - - - applies to any platform but cannot run on any (e.g. reference assembly), should not have "specified" set - - - Propagate PA flags to AssemblyRef record - - - Bits describing the processor architecture - - - Bits describing the PA incl. Specified - - - NOT A FLAG, shift count in PA flags <--> index conversion - - - From "DebuggableAttribute". - - - From "DebuggableAttribute". - - - The assembly can be retargeted (at runtime) to an assembly from a different publisher. - - - - - - - - - Bits describing ContentType - - - - A high-level representation of a row in the Assembly table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Assembly.HashAlgId - - - - - - - - From columns Assembly.MajorVersion, Assembly.MinorVersion, Assembly.BuildNumber, - Assembly.RevisionNumber. - - If is null - - - - - - - From column Assembly.Flags - - - - Attributes - - - - From column Assembly.PublicKey - - An empty is created if the caller writes null - - - - - - - Gets the public key token which is calculated from - - - - - From column Assembly.Name - - - - Name - - - - From column Assembly.Locale - - - - Name - - - - - - - - - Initializes - - - - - - - - - - - - - Gets all modules. The first module is always the . - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if is not empty - - - - - Gets the manifest (main) module. This is always the first module in . - null is returned if is empty. - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Finds a module in this assembly - - Name of module - A instance or null if it wasn't found. - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Gets the assembly name with the public key - - - - - Gets the assembly name with the public key token - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable - if possible (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Writes the assembly to a file on disk. If the file exists, it will be truncated. - - Filename - Writer options - - - - Writes the assembly to a stream. - - Destination stream - Writer options - - - - Checks whether this assembly is a friend assembly of - - Target assembly - - - - Adds or updates an existing System.Reflection.AssemblySignatureKeyAttribute - attribute. This attribute is used in enhanced strong naming with key migration. - See http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Identity public key - Identity strong name key pair - Signature public key - - - - Gets the original System.Runtime.Versioning.TargetFrameworkAttribute custom attribute information if possible. - It reads this from the original metadata and doesn't use . - Returns false if the custom attribute isn't present or if it is invalid. - - Framework name - Version - Profile - - - - - - - - - - - - - - - - - - - - - - - An Assembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly name info - If is null - - - - Created from a row in the Assembly table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Assembly row - Row ID - If is null - If is invalid - - - - Hashes some data according to a - - - - - Constructor - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The algorithm to use - - - - - - - Hash data - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The data - The algorithm to use - Hashed data or null if was null - - - - Hash data - - Data - - - - Hash data - - Data - Offset - Length - - - - Hash stream data - - Stream - Number of bytes to hash - Temp buffer - - - - Computes the hash - - - - - Creates a public key token from the hash of some - - A public key is hashed, and the last 8 bytes of the hash, in reverse - order, is used as the public key token - The data - A new instance - - - - Any ALG_CLASS_HASH type in WinCrypt.h can be used by Microsoft's CLI implementation - - - - - - - - - - - - - This is a reserved value in the CLI - - - The only algorithm supported by the CLI - - - - - - - - - - - - - - - - - - - - - - - - - - - - Extension methods - - - - - Gets the field type - - this - Field type or null if none - - - - Gets the return type - - this - Return type or null if none - - - - Gets the parameters - - this - The parameters - - - - Gets the parameter count - - this - Parameter count - - - - Gets the generic parameter count - - this - Generic parameter count - - - - Gets the parameters after the sentinel - - this - Parameters after sentinel or null if none - - - - Gets the locals - - this - All locals - - - - Gets the generic arguments - - this - All generic arguments - - - - Gets the property - - this - The type's property or - false if input isnull - - - - Returns true if it's an integer or a floating point type - - Element type - - - - - Returns the size of the element type in bytes or -1 if it's unknown - - Element type - Size of a pointer - - - - - Checks whether it's a value type - - this - true if it's a value type, false if it's not a value type or - if we couldn't determine whether it's a value type. Eg., it could be a generic - instance type. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Checks whether appears to be the core library (eg. - mscorlib, System.Runtime or corefx). - - If is a reference to a private corlib (eg. System.Private.CoreLib), - this method returns false unless is an - whose manifest (first) module defines System.Object. This check is performed in - the constructor and the result can be found in . - - Note that this method also returns true if it appears to be a 'public' corlib, - eg. mscorlib, etc, even if it internally possibly references a private corlib. - - The assembly - - - - Converts to a instance - - The assembly - A new instance - - - - Converts to a - - The type - true if we should try to figure out whether - is a - A instance or null if - is invalid - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns the base type of . Throws if we can't resolve - a . - - The type - The base type or null if there's no base type - - - - Returns the base type of - - The type - true if we should throw if we can't - resolve a . false if we should ignore the error and - just return null. - The base type or null if there's no base type, or if - is true and we couldn't resolve - a - - - - Gets the scope type, resolves it, and returns the - - Type - A or null if input was null or if we - couldn't resolve the reference. - - - - Gets the scope type, resolves it, and returns the - - Type - A instance. - If the type couldn't be resolved - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also - - Field to resolve - The or null if is - null or if it wasn't possible to resolve it (the field doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception if - it was not possible to resolve it. See also - - Field to resolve - The - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The or null if is - null or if it wasn't possible to resolve it (the method doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception - if it was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The - - - - Returns the definition assembly of a - - Member reference - - - - - Gets the normal visible parameters, doesn't include the hidden 'this' parameter - - this - The normal visible parameters - - - - Gets the normal visible parameter count, doesn't include the hidden 'this' parameter - - this - Normal visible parameter count - - - - Checks whether any normal visible parameter exists, doesn't include the hidden 'this' parameter - - this - true if there's at least one normal visible parameter - - - - Gets a normal visible parameter, doesn't include the hidden 'this' parameter - - this - Normal visible parameter index - - - - - Converts a to a - - The sig - - - - Returns true if it's an integer or a floating point type - - Type - - - - - Gets a if matches a primitive type. - - this - The type - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Log an error message - - this - Sender or null - Message - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an error message - - this - Sender or null - Message - Message arguments - - - - Log a warning message - - this - Sender or null - Message - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a warning message - - this - Sender or null - Message - Message arguments - - - - Log an info message - - this - Sender or null - Message - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an info message - - this - Sender or null - Message - Message arguments - - - - Log a verbose message - - this - Sender or null - Message - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a verbose message - - this - Sender or null - Message - Message arguments - - - - Log a very verbose message - - this - Sender or null - Message - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a very verbose message - - this - Sender or null - Message - Message arguments - - - - Resolves a type - - this - The type - A instance or null if it couldn't be resolved - - - - Resolves a type - - this - The type - A instance - If the type couldn't be resolved - - - - Resolves a type - - this - The type - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Resolves a method or a field - - this - A method/field reference - A or a instance - If the method/field couldn't be resolved - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - If the field couldn't be resolved - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - If the method couldn't be resolved - - - - Resolves a token - - This - The metadata token - A or null if is invalid - - - - Returns , but if it's a nested , - return the non-nested - - this - The scope type - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. - - this - The type ref - An existing or null if it wasn't found. - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing - If type couldn't be found - - - - Checks whether a exists. 's scope (i.e., - module or assembly) is ignored when looking up the type. - - this - The type ref - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by / - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by + - true if the exists, false otherwise - - - - Removes all C optional/required modifiers - - A instance - Input after all modifiers - - - - Removes pinned signature - - The type - Input after pinned signature - - - - Removes all modifiers and pinned sig - - The type - Inputer after modifiers and pinned signature - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Gets the next field or null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the element type - - this - The element type - - - - Gets the full name of the type - - this - Full name of the type - - - - Gets the name of the type - - this - Name of the type - - - - Gets the namespace of the type - - this - Namespace of the type - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - Nothing is resolved. - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Flags used by - - - - - Compare assembly simple name - - - - - Compare assembly version - - - - - Compare assembly public key token - - - - - Compare assembly culture - - - - - Compare content type - - - - - Compare assembly simple name, version, public key token, locale and content type - - - - - Compares two assembly names - - - - - Compares the name, version, public key token, culture and content type - - - - - Compares only the name and the public key token - - - - - Compares only the name - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - Comparison flags - - - - Compares two assembly names - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two assembly names - - First - Second - true if equal, false otherwise - - - - Figures out which of two assembly names is closer to another assembly name - - Requested assembly name - First - Second - -1 if both are equally close, 0 if is closest, 1 if - is closest - - - - Gets the hash code of an assembly name - - Assembly name - The hash code - - - - Stores assembly name information - - - - - Gets/sets the - - - - - Gets/sets the or null if none specified - - - - - Gets/sets the - - - - - Gets/sets the public key or token - - - - - Gets/sets the name - - - - - Gets/sets the culture or null if none specified - - - - - Gets the full name of the assembly - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Default constructor - - - - - Constructor - - An assembly name - - - - Constructor - - The assembly - - - - Constructor - - Assembly name info - - - - - - - A high-level representation of a row in the AssemblyRef table - - - - - An assembly ref that can be used to indicate that it references the current assembly - when the current assembly is not known (eg. a type string without any assembly info - when it references a type in the current assembly). - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - From columns AssemblyRef.MajorVersion, AssemblyRef.MinorVersion, - AssemblyRef.BuildNumber, AssemblyRef.RevisionNumber - - If is null - - - - - - - From column AssemblyRef.Flags - - - - Attributes - - - - From column AssemblyRef.PublicKeyOrToken - - If is null - - - - - - - From column AssemblyRef.Name - - - - Name - - - - From column AssemblyRef.Locale - - - - Culture - - - - From column AssemblyRef.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Same as , except that it uses the PublicKey if available. - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - - - - An AssemblyRef row created by the user and not present in the original .NET file - - - - - Creates a reference to CLR 1.0's mscorlib - - - - - Creates a reference to CLR 1.1's mscorlib - - - - - Creates a reference to CLR 2.0's mscorlib - - - - - Creates a reference to CLR 4.0's mscorlib - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly - - - - Created from a row in the AssemblyRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this AssemblyRef row - Row ID - If is null - If is invalid - - - - Resolves assemblies - - - - - Gets/sets the default - - - - - true if should find an assembly that matches exactly. - false if it first tries to match exactly, and if that fails, it picks an - assembly that is closest to the requested assembly. - - - - - true if resolved .NET framework assemblies can be redirected to the source - module's framework assembly version. Eg. if a resolved .NET 3.5 assembly can be - redirected to a .NET 4.0 assembly if the source module is a .NET 4.0 assembly. This is - ignored if is true. - - - - - If true, all modules in newly resolved assemblies will have their - property set to true. This is - enabled by default since these modules shouldn't be modified by the user. - - - - - true to search the Global Assembly Cache. Default value is true. - - - - - Gets paths searched before trying the standard locations - - - - - Gets paths searched after trying the standard locations - - - - - Default constructor - - - - - Constructor - - Module context for all resolved assemblies - - - - - - - Add a module's assembly to the assembly cache - - The module whose assembly should be cached - true if 's assembly is cached, false - if it's not cached because some other assembly with the exact same full name has - already been cached or if or its assembly is null. - - - - Add an assembly to the assembly cache - - The assembly - true if is cached, false if it's not - cached because some other assembly with the exact same full name has already been - cached or if is null. - - - - Removes a module's assembly from the cache - - The module - true if its assembly was removed, false if it wasn't removed - since it wasn't in the cache, it has no assembly, or was - null - - - - Removes the assembly from the cache - - The assembly - true if it was removed, false if it wasn't removed since it - wasn't in the cache or if was null - - - - Clears the cache and calls on each cached module. - Use to remove any assemblies you added yourself - using before calling this method if you don't want - them disposed. - - - - - Gets the cached assemblies in this resolver. - - The cached assemblies. - - - - Finds an assembly that exactly matches the requested assembly - - Assembly to find - Search paths or null if none - Module context - An instance or null if an exact match - couldn't be found. - - - - Finds the closest assembly from the already cached assemblies - - Assembly to find - The closest or null if none found - - - - Returns true if is inserted in - - Assembly to check - - - - Called before - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Gets all search paths to use for this module - - The module or null if unknown - A list of all search paths to use for this module - - - - Gets all module search paths. This is usually empty unless its assembly has - a .config file specifying any additional private search paths in a - <probing/> element. - - The module or null if unknown - A list of search paths - - - - Gets all private assembly search paths as found in the module's .config file. - - The module or null if unknown - A list of search paths - - - - See CorHdr.h/CorCallingConvention - - - - The managed calling convention - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - generic method instantiation - - - used ONLY for 64bit vararg PInvoke calls - - - Calling convention is bottom 4 bits - - - Generic method - - - Method needs a 'this' parameter - - - 'this' parameter is the first arg if set (else it's hidden) - - - Used internally by the CLR - - - - Base class for sigs with a calling convention - - - - - The calling convention - - - - - Gets/sets the extra data found after the signature - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if there's an implicit this parameter - - - - - true if this contains a - or a . - - - - - Default constructor - - - - - Constructor - - The calling convention - - - - Gets the calling convention - - - - - A field signature - - - - - Gets/sets the field type - - - - - Default constructor - - - - - Constructor - - Field type - - - - Constructor - - Field type - The calling convention (must have Field set) - - - - Clone this - - - - - - - - Method sig base class - - - - - - - - - - - - - - - - - Gets/sets the calling convention - - - - - Gets/sets the return type - - - - - Gets the parameters. This is never null - - - - - Gets/sets the generic param count - - - - - Gets the parameters that are present after the sentinel. Note that this is null - if there's no sentinel. It can still be empty even if it's not null. - - - - - A method signature - - - - - Gets/sets the original token. It's set when reading calli instruction operands - and it's a hint to the module writer if it tries to re-use the same token. - - - - - Creates a static MethodSig - - Return type - - - - Creates a static MethodSig - - Return type - Arg type #1 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static MethodSig - - Return type - Argument types - - - - Creates an instance MethodSig - - Return type - - - - Creates an instance MethodSig - - Return type - Arg type #1 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance MethodSig - - Return type - Argument types - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention - - - - Constructor - - Calling convention - Number of generic parameters - - - - Constructor - - Calling convention - Number of generic parameters - Return type - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A property signature - - - - - Creates a static PropertySig - - Return type - - - - Creates a static PropertySig - - Return type - Arg type #1 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static PropertySig - - Return type - Argument types - - - - Creates an instance PropertySig - - Return type - - - - Creates an instance PropertySig - - Return type - Arg type #1 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance PropertySig - - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention (must have Property set) - - - - Constructor - - true if instance, false if static - - - - Constructor - - true if instance, false if static - Return type - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - true if instance, false if static - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A local variables signature - - - - - All local types. This is never null. - - - - - Default constructor - - - - - Constructor - - Calling convention (must have LocalSig set) - Number of locals - - - - Constructor - - Local type #1 - - - - Constructor - - Local type #1 - Local type #2 - - - - Constructor - - Local type #1 - Local type #2 - Local type #3 - - - - Constructor - - All locals - - - - Constructor - - All locals - - - - Constructor - - All locals (this instance now owns it) - Dummy - - - - Clone this - - - - - An instantiated generic method signature - - - - - Gets the generic arguments (must be instantiated types, i.e., closed types) - - - - - Default constructor - - - - - Constructor - - Calling convention (must have GenericInst set) - Number of generic args - - - - Constructor - - Generic arg #1 - - - - Constructor - - Generic arg #1 - Generic arg #2 - - - - Constructor - - Generic arg #1 - Generic arg #2 - Generic arg #3 - - - - Constructor - - Generic args - - - - Constructor - - Generic args - - - - Clone this - - - - - A high-level representation of a row in the ClassLayout table - - - - - The row id in its table - - - - - - - - - - - From column ClassLayout.PackingSize - - - - - - - - From column ClassLayout.ClassSize - - - - - - - - A ClassLayout row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - PackingSize - ClassSize - - - - Created from a row in the ClassLayout table - - - - - - - - Constructor - - The module which contains this ClassLayout row - Row ID - If is null - If is invalid - - - - A high-level representation of a row in the Constant table - - - - - The row id in its table - - - - - - - - - - - From column Constant.Type - - - - - - - - From column Constant.Value - - - - - - - - A Constant row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Value - - - - Constructor - - Value - Type - - - - Created from a row in the Constant table - - - - - - - - Constructor - - The module which contains this Constant row - Row ID - If is null - If is invalid - - - - Default implementation of - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The owner module - - - - Constructor - - The owner module - Corlib assembly reference or null if a default - assembly reference should be created - - - - - - - Gets the required alignment for the stubs, must be a power of 2 - - Stub type - - - - - Gets the size of a stub, it doesn't have to be a multiple of - - Stub type - - - - - Gets the offset of the code (entry point) relative to the start of the stub - - Stub type - - - - - Gets the RVA of the func field that the stub jumps to - - Reader, positioned at the stub func - PE image - Updated with RVA of func field - - - - - Writes stub relocs, if needed - - Stub type - Reloc directory - The chunk where this stub will be written to - Offset of this stub in - - - - Writes the stub that jumps to the managed function - - Stub type - Writer - Image base - RVA of this stub - RVA of a pointer-sized field that contains the absolute address of the managed function - - - - A custom attribute - - - - - Gets/sets the custom attribute constructor - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - true if the raw custom attribute blob hasn't been parsed - - - - - Gets the raw custom attribute blob or null if the CA was successfully parsed. - - - - - Gets all constructor arguments - - - - - true if is not empty - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Gets the #Blob offset or 0 if unknown - - - - - Constructor - - Custom attribute constructor - Raw custom attribute blob - - - - Constructor - - Custom attribute constructor - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - - - - Constructor - - Custom attribute constructor - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - Original custom attribute #Blob offset or 0 - - - - Constructor - - Custom attribute constructor - Constructor arguments. The list is now owned by this instance. - Named arguments. The list is now owned by this instance. - Original custom attribute #Blob offset or 0 - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - - - - A custom attribute constructor argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Constructor - - Argument type - - - - Constructor - - Argument type - Argument value - - - - Clones this instance and any s and s - referenced from this instance. - - - - - - - - - A custom attribute field/property argument - - - - - true if it's a field - - - - - true if it's a property - - - - - Gets/sets the field/property type - - - - - Gets/sets the property/field name - - - - - Gets/sets the argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Default constructor - - - - - Constructor - - true if field, false if property - - - - Constructor - - true if field, false if property - Field/property type - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - Field/property argument - - - - Clones this instance and any s referenced from this instance. - - - - - - - - - Stores s - - - - - Default constructor - - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Checks whether a custom attribute is present - - Full name of custom attribute type - true if the custom attribute type is present, false otherwise - - - - Removes all custom attributes of a certain type - - Full name of custom attribute type that should be removed - - - - Finds a custom attribute - - Full name of custom attribute type - A or null if it wasn't found - - - - Finds all custom attributes of a certain type - - Full name of custom attribute type - All s of the requested type - - - - Finds a custom attribute - - Custom attribute type - The first found or null if none found - - - - Finds a custom attribute - - Custom attribute type - Attribute type comparison flags - The first found or null if none found - - - - Finds all custom attributes of a certain type - - Custom attribute type - All s of the requested type - - - - Finds all custom attributes of a certain type - - Custom attribute type - Attribute type comparison flags - All s of the requested type - - - - Searches for a type according to custom attribute search rules: first try the - current assembly, and if that fails, try mscorlib - - - - - Constructor - - The module to search first - - - - - - - Thrown by CustomAttributeReader when it fails to parse a custom attribute blob - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Reads custom attributes from the #Blob stream - - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - A new instance - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - A reader positioned at the the first byte of the CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads custom attribute named arguments - - Owner module - A reader positioned at the the first byte of the CA blob - Number of named arguments to read from - Generic parameter context - A list of s or null if some error - occurred. - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - If is not an enum or null - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - A high-level representation of a row in the DeclSecurity table - - - - - The row id in its table - - - - - - - - - - - - - - From column DeclSecurity.Action - - - - - - - - From column DeclSecurity.PermissionSet - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - Gets the blob data or null if there's none - - Blob data or null - - - - Returns the .NET 1.x XML string or null if it's not a .NET 1.x format - - - - - - A DeclSecurity row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The security action - The security attributes (now owned by this) - - - - - - - Created from a row in the DeclSecurity table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this DeclSecurity row - Row ID - If is null - If is invalid - - - - - - - Reads DeclSecurity blobs - - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - Generic parameter context - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - Generic parameter context/// - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - Generic parameter context - A list of s - - - - Reads the new (.NET 2.0+) DeclSecurity blob format - - - - - - Reads the old (.NET 1.x) DeclSecurity blob format - - - - - - See CorHdr.h/CorElementType - - - - - - - System.Void - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Pointer type (*) - - - ByRef type (&) - - - Value type - - - Reference type - - - Type generic parameter - - - Multidimensional array ([*], [,], [,,], ...) - - - Generic instance type - - - Typed byref - - - Value array (don't use) - - - System.IntPtr - - - System.UIntPtr - - - native real (don't use) - - - Function pointer - - - System.Object - - - Single-dimension, zero lower bound array ([]) - - - Method generic parameter - - - Required C modifier - - - Optional C modifier - - - Used internally by the CLR (don't use) - - - Module (don't use) - - - Sentinel (method sigs only) - - - Pinned type (locals only) - - - - A CIL opcode. If the high byte is 0 or if it's , it's a 1-byte opcode, - else it's a two-byte opcode and the highest byte is the first byte of the opcode. - - - - - Extension methods - - - - - Converts a to an - - The code - A or null if it's invalid - - - - Gets the opcode or if is null - - this - - - - - Gets the operand or null if is null - - this - - - - - Gets the offset or 0 if is null - - this - - - - - Gets the sequence point or null if is null - - this - - - - - Resolves a token - - An object - The metadata token - A or null if is invalid - - - - options - - - - - No option is enabled - - - - - Some fields/methods have an unknown declaring type and don't have a context with - that information. If this is enabled, the reader will try to guess it but it doesn't - always work. If you get an , try enabling this option. - - - - - Reads code from a DynamicMethod - - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Generic parameter context - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - Options - - - - Reads the code - - - - - - Returns the created method. Must be called after . - - A new instance - - - - - - - - - - - - - - - - - - - - - - A CIL method exception handler - - - - - First instruction of try block - - - - - One instruction past the end of try block or null if it ends at the end - of the method. - - - - - Start of filter handler or null if none. The end of filter handler is - always . - - - - - First instruction of try handler block - - - - - One instruction past the end of try handler block or null if it ends at the end - of the method. - - - - - The catch type if is - - - - - Type of exception handler clause - - - - - Default constructor - - - - - Constructor - - Exception clause type - - - - Type of exception handler. See CorHdr.h/CorExceptionFlag - - - - - - - - - - - - - - - - - - - - CIL opcode flow control - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A CIL instruction (opcode + operand) - - - - - The opcode - - - - - The opcode operand - - - - - Offset of the instruction in the method body - - - - - PDB sequence point or null if none - - - - - Default constructor - - - - - Constructor - - Opcode - - - - Constructor - - Opcode - The operand - - - - Creates a new instruction with no operand - - The opcode - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with an operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a string operand - - The opcode - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - The opcode - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The opcode - The targets - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The opcode - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The opcode - The field - A new instance - - - - Creates a new instruction with a method operand - - The opcode - The method - A new instance - - - - Creates a new instruction with a token operand - - The opcode - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The opcode - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The opcode - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The opcode - The method local - A new instance - - - - Creates a ldci4 instruction - - Operand value - A new instance - - - - Gets the size in bytes of the instruction - - - - - - Updates with the new stack size - - Current stack size - - - - Updates with the new stack size - - Current stack size - true if the method has a return value, - false otherwise - - - - Calculates stack usage - - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Calculates stack usage - - true if method has a return value - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Checks whether it's one of the leave instructions - - - - - Checks whether it's one of the br instructions - - - - - Checks whether it's one of the brfalse instructions - - - - - Checks whether it's one of the brtrue instructions - - - - - Checks whether it's one of the conditional branch instructions (bcc, brtrue, brfalse) - - - - - Checks whether this is one of the ldc.i4 instructions - - - - - Returns a ldc.i4 instruction's operand - - The integer value - isn't one of the - ldc.i4 opcodes - - - - Checks whether it's one of the ldarg instructions, but does not check - whether it's one of the ldarga instructions. - - - - - Checks whether it's one of the ldloc instructions, but does not check - whether it's one of the ldloca instructions. - - - - - Checks whether it's one of the starg instructions - - - - - Checks whether it's one of the stloc instructions - - - - - Returns the local if it's a ldloc, stloc or ldloca instruction - - The locals - The local or null if it's not a ldloc, stloc or ldloca - instruction or if the local doesn't exist. - - - - Gets the index of the instruction's parameter operand or -1 if the parameter - is missing or if it's not an instruction with a parameter operand. - - - - - Returns a method parameter - - All parameters - A parameter or null if it doesn't exist - - - - Returns an argument type - - Method signature - Declaring type (only needed if it's an instance method) - The type or null if it doesn't exist - - - - Clone this instance. The and fields - are shared by this instance and the created instance. - - - - - - - - Converts instructions to strings - - - - - Converts an instruction to a string - - The instruction - The result - - - - Gets the instruction's operand as a string - - The instruction - The operand as a string - - - - Add an instruction's operand to - - Place result here - The instruction - - - - Add an instruction's operand to - - Place result here - The instruction - A string that will be added before the operand, if there's - an operand. - - - - Thrown when invalid data is detected while parsing a .NET method - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - The inner exception or null if none - - - - Constructor - - - - - - - A collection of s - - - - - Gets the number of locals - - - - - Gets the list of locals - - - - - Gets the N'th local - - The local index - - - - Default constructor - - - - - Constructor - - All locals that will be owned by this instance - - - - Adds a new local and then returns it - - The local that should be added to the list - The input is always returned - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A method local - - - - - Gets/sets the type of the local - - - - - Local index - - - - - Gets the name. This property is obsolete, use to get/set the name stored in the PDB file. - - - - - Gets the attributes. This property is obsolete, use to get/set the attributes stored in the PDB file. - - - - - Constructor - - The type - - - - Constructor - - The type - Name of local - - - - Constructor - - The type - Name of local - Index, should only be used if you don't add it to the locals list - - - - - - - Method body base class - - - - - A native method body - - - - - Gets/sets the RVA of the native method body - - - - - Default constructor - - - - - Constructor - - RVA of method body - - - - CIL (managed code) body - - - - - Size of a small header - - - - - Gets/sets a flag indicating whether the original max stack value should be used. - - - - - Gets/sets the init locals flag. This is only valid if the method has any locals. - - - - - Gets/sets the size in bytes of the method body header. The instructions immediately follow - the header. - - - - - true if it was a small body header ( is 1) - - - - - true if it was a big body header - - - - - Gets/sets max stack value from the fat method header. - - - - - Gets/sets the locals metadata token - - - - - true if is not empty - - - - - Gets the instructions - - - - - true if is not empty - - - - - Gets the exception handlers - - - - - true if is not empty - - - - - Gets the locals - - - - - Gets/sets the PDB method. This is null if no PDB has been loaded or if there's - no PDB info for this method. - - - - - true if is not null - - - - - Gets the total size of the body in the PE file, including header, IL bytes, and exception handlers. - This property returns 0 if the size is unknown. - - - - - Default constructor - - - - - Constructor - - Init locals flag - All instructions. This instance will own the list. - All exception handlers. This instance will own the list. - All locals. This instance will own the locals in the list. - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - - - - Optimizes branches by using the smallest possible branch - - - - - Updates each instruction's offset - - Total size in bytes of all instructions - - - - Reads strings from #US heap - - - - - Reads a string from the #US heap - - String token - A string - - - - Resolves instruction operands - - - - - Reads a .NET method body (header, locals, instructions, exception handlers) - - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Initializes the method header - - Header flags, eg. 2 if it's a tiny method - Max stack - Code size - Local variable signature token - - - - Reads the method body header, locals, all instructions, and the exception handlers (if any) - - true if it worked, and false if something failed - - - - Reads the method header - - - - - Reads the locals - - All locals or null if there are none - - - - Reads all instructions - - - - - - - - - - - - - - - - - - - - - - - Reads all exception handlers - - - - - Creates a CIL body. Must be called after , and can only be - called once. - - A new instance - - - - Method body reader base class - - - - The method reader - - - All parameters - - - All locals - - - All instructions - - - All exception handlers - - - First byte after the end of the code - - - Start offset of method - - - - Gets all parameters - - - - - Gets all locals - - - - - Gets all instructions - - - - - Gets all exception handlers - - - - - Constructor - - - - - Constructor - - The reader - - - - Constructor - - The reader - Method parameters or null if they're not known yet - - - - Sets new locals - - A list of types of all locals or null if none - - - - Sets new locals - - A list of types of all locals or null if none - - - - Reads all instructions - - Number of instructions to read - - - - Reads all instructions - - Size of code - - - - Fixes all branch instructions so their operands are set to an - instead of an offset. - - - - - Finds an instruction - - Offset of instruction - The instruction or null if there's no instruction at . - - - - Finds an instruction and throws if it's not present - - Offset of instruction - The instruction - There's no instruction at - - - - - Reads the next instruction - - - - - Reads the next OpCode from the current position - - - - - Reads the instruction operand (if any) - - The instruction - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Returns true if it's one of the ldarg/starg instructions that have an operand - - The instruction to check - - - - Returns a parameter - - A parameter index - A or null if is invalid - - - - Returns a local - - A local index - A or null if is invalid - - - - Add an exception handler if it appears valid - - The exception handler - true if it was added, false otherwise - - - - Gets the offset of an instruction - - The instruction or null if the offset is the first offset - at the end of the method. - The instruction offset - - - - Restores a 's body with the parsed method instructions - and exception handlers - - The method that gets updated with the instructions, locals, and - exception handlers. - - - - Converts a type address to a . The address can be found in - RuntimeTypeHandle.Value and it's the same address you use with the WinDbg SOS command - !dumpmt. - - - - - Converts to a . - - Address of type - The or null - - - - Instruction utility methods - - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All instructions - All locals - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - All instructions - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - All instructions - - - - Optimizes branches by using the smallest possible branch - - All instructions - - - - Updates each instruction's offset - - All instructions - Total size in bytes of all instructions - - - - A CIL opcode - - - - - The opcode name - - - - - The opcode as a enum - - - - - Operand type - - - - - Flow control info - - - - - Opcode type - - - - - Push stack behavior - - - - - Pop stack behavior - - - - - Gets the value which is compatible with - - - - - Gets the size of the opcode. It's either 1 or 2 bytes. - - - - - Creates a new instruction with no operand - - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with an operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a string operand - - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The targets - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The field - A new instance - - - - Creates a new instruction with a method operand - - The method - A new instance - - - - Creates a new instruction with a token operand - - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The method local - A new instance - - - - - - - Contains all valid CIL opcodes - - - - - All one-byte opcodes - - - - - All two-byte opcodes (first byte is 0xFE) - - - - - CIL opcode type - - - - - - - - - - - - - - - - - - - - - - - CIL opcode operand type - - - - 4-byte relative instruction offset - - - 4-byte field token ( or ) - - - int32 - - - int64 - - - 4-byte method token (, - or ) - - - No operand - - - Never used - - - 64-bit real - - - - - - 4-byte method sig token () - - - 4-byte string token (0x70xxxxxx) - - - 4-byte count N followed by N 4-byte relative instruction offsets - - - 4-byte token (, , - , , , - or ) - - - 4-byte type token (, or - ) - - - 2-byte param/local index - - - 1-byte relative instruction offset - - - 1-byte sbyte () or byte (the rest) - - - 32-bit real - - - 1-byte param/local index - - - - CIL opcode stack behavior - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Event attributes, see CorHdr.h/CorEventAttr - - - - event is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - - A high-level representation of a row in the Event table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Event.EventFlags - - - - - - - - From column Event.Name - - - - Name - - - - From column Event.EventType - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the adder method - - - - - Gets/sets the invoker method - - - - - Gets/sets the remover method - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - - - - Reset , , , - - - - true if there are no methods attached to this event - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the event - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - An Event row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Type - - - - Constructor - - Name - Type - Flags - - - - Created from a row in the Event table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this Event row - Row ID - If is null - If is invalid - - - - - - - A high-level representation of a row in the ExportedType table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - - - - - - - - - - From column ExportedType.Flags - - - - Attributes - - - - From column ExportedType.TypeDefId - - - - - - - - From column ExportedType.TypeName - - - - - - - - From column ExportedType.TypeNamespace - - - - - - - - From column ExportedType.Implementation - - - - - - - - - - Called to initialize - - - - true if it's nested within another - - - - - Gets the declaring type, if any - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit. See also - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this type has been moved to another assembly - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - Source module or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Converts this instance to a - - A new instance - - - - - - - An ExportedType row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - TypeDef ID - Type name - Type namespace - Flags - Implementation - - - - Created from a row in the ExportedType table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this ExportedType row - Row ID - If is null - If is invalid - - - - Field flags, see CorHdr.h/CorFieldAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Field may only be initialized, not written to after init. - - - Value is compile time constant. - - - Field does not have to be serialized when type is remoted. - - - field is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Runtime(metadata internal APIs) should check name encoding. - - - Field has marshalling information. - - - Field has default. - - - Field has RVA. - - - - A high-level representation of a row in the Field table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - From column Field.Flags - - - - Attributes - - - - From column Field.Name - - - - Name - - - - From column Field.Signature - - - - - - - - Gets/sets the field layout offset - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the field RVA - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the initial value. Be sure to set to true if - you write to this field. - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - Gets/sets the - - - - - - - - true if is not null - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - Gets/sets the field type - - - - - Modify field: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the field access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Returns the full name of this field - - - - - Gets the size of this field in bytes or 0 if unknown. - - - - - Gets the size of this field in bytes or 0 if unknown. - - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Size of a pointer - Updated with size - true if is valid, false otherwise - - - - - - - A Field row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Signature - - - - Constructor - - Name - Signature - Flags - - - - Created from a row in the Field table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Field row - Row ID - If is null - If is invalid - - - - File row flags. See CorHdr.h/CorFileFlags - - - - This is not a resource file - - - This is a resource file or other non-metadata-containing file - - - - A high-level representation of a row in the File table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column File.Flags - - - - Attributes - - - - From column File.Name - - - - Name - - - - From column File.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - A File row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name of file - Flags - File hash - - - - Created from a row in the File table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this File row - Row ID - If is null - If is invalid - - - - Redirects .NET framework assembly references from older to newer versions - - - - - Redirects a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - Module using the assembly reference - - - - Tries to redirect a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Module using the assembly reference - Updated with the redirected assembly if successful - - - - - Redirects a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Redirects a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Tries to redirect a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Tries to redirect a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Helps create a name - - - - - Checks whether the assembly name should be included when printing - the full type name. The assembly name isn't required in custom attributes - when the type already exists in the same module as the CA, or if the type - exists in mscorlib. - - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Creates type names, method names, etc. - - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - If false, don't add an assembly name if it's a type in , - if true, don't add an assembly name if it's a type in or the corlib. - true if the assembly name must be included, false otherwise - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeRef - A or null if none found - - - - Gets the scope - - The TypeRef - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeRef - A or null if none found - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeDef - A or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeDef - A or null if none found - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSpec - A or null if none found - - - - Gets the scope type - - The TypeSpec - The scope type or null if none found - - - - Gets the scope - - The TypeSpec - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSpec - A or null if none found - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSig - A or null if none found - - - - Gets the scope - - The TypeSig - The or null if none found - - - - Gets the scope type - - The TypeSig - The scope type or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSig - A or null if none found - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The ExportedType - A or null if none found - - - - Gets the scope type - - The ExportedType - The scope type or null if none found - - - - Gets the scope - - The ExportedType - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The ExportedType - A or null if none found - - - - - - - Constructor - - true if it's for generic types, false if generic methods - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Resolves a generic argument - - Generic variable number - A or null if none was found - - - - Replaces generic type/method var with its generic argument - - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Replaces a generic type/method var with its generic argument (if any). If - isn't a generic type/method var or if it can't - be resolved, it itself is returned. Else the resolved type is returned. - - Type signature - New which is never null unless - is null - - - - A high-level representation of a row in the GenericParam table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner type/method - - - - - - - - Gets the declaring type or null if none or if is - not a - - - - - - - - Gets the declaring method or null if none or if is - not a - - - - - From column GenericParam.Number - - - - - - - - From column GenericParam.Flags - - - - Attributes - - - - From column GenericParam.Name - - - - Name - - - - From column GenericParam.Kind (v1.1 only) - - - - - - - - Gets the generic param constraints - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets variance (non, contra, co) - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the special constraint - - - - - true if there are no special constraints - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - - - - - - - - - - - - - A GenericParam row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic param number - - - - Constructor - - The generic param number - Flags - - - - Constructor - - The generic param number - Flags - Name - - - - Created from a row in the GenericParam table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this GenericParam row - Row ID - If is null - If is invalid - - - - - - - Generic parameter flags. See CorHdr.h/CorGenericParamAttr - - - - - - - - - - - - - - - - - - - - - - type argument must be a reference type - - - type argument must be a value type but not Nullable - - - type argument must have a public default constructor - - - - A high-level representation of a row in the GenericParamConstraint table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner generic param - - - - - - - - From column GenericParamConstraint.Constraint - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - A GenericParamConstraintAssembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The constraint - - - - Created from a row in the GenericParamConstraint table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this GenericParamConstraint row - Row ID - Generic parameter context - If is null - If is invalid - - - - Generic parameter context - - - - - Type context - - - - - Method context - - - - - true if and are both null - - - - - Creates a new instance and initializes the - field to 's - and the field to . - - Method - A new instance - - - - Creates a new instance and initializes the - field to and the field - to null - - Type - A new instance - - - - Constructor - - Type context - - - - Constructor. The field is set to null and NOT to - 's . Use - if you want that behavior. - - Method context - - - - Constructor - - Type context - Method context - - - - Resolves assemblies - - - - - Finds and returns an - - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - The table row can be referenced by a MD token - - - - - Returns the metadata token - - - - - Gets/sets the row ID - - - - - All *MD classes implement this interface. - - - - - Gets the original row ID - - - - - An assembly. Implemented by , and - . - - - - - The assembly version - - - - - Assembly flags - - - - - Public key or public key token - - - - - Locale, aka culture - - - - - Gets the full name of the assembly but use a public key token - - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Implemented by and , which are the only - valid managed entry point tokens. - - - - - Interface to access a module def/ref - - - - - Type of scope - - - - - It's an instance - - - - - It's a instance - - - - - It's a instance - - - - - Implemented by modules and assemblies - - - - - Gets the scope type - - - - - Gets the scope name - - - - - Interface to get the full name of a type, field, or method - - - - - Gets the full name - - - - - Simple name of implementer - - - - - Implemented by all member refs and types - - - - - Gets the owner module - - - - - Methods to check whether the implementer is a type or a method. - - - - - true if it's a type - - - - - true if it's a method - - - - - Implemented by types, fields, methods, properties, events - - - - - Gets the declaring type - - - - - true if it's a or a that's - referencing a field. - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - All member definitions implement this interface: , - , , , - , and . - - - - - Gets the declaring type - - - - - Implemented by the following classes: , - , , , - , , , - and - - - - - Implemented by types and methods - - - - - Gets the number of generic parameters / arguments - - - - - Implemented by fields ( and ) - - - - - Gets/sets the field signature - - - - - Implemented by methods (, and ) - - - - - Method signature - - - - - Implemented by tables that can be a token in the ldtoken instruction - - - - - The table row can be referenced by a coded token - - - - - TypeDefOrRef coded token interface - - - - - The coded token tag - - - - - HasConstant coded token interface - - - - - The coded token tag - - - - - Gets/sets the constant value - - - - - HasCustomAttribute coded token interface - - - - - The coded token tag - - - - - Gets all custom attributes - - - - - true if is not empty - - - - - HasFieldMarshal coded token interface - - - - - The coded token tag - - - - - Gets/sets the marshal type - - - - - true if is not null - - - - - HasDeclSecurity coded token interface - - - - - The coded token tag - - - - - Gets the permission sets - - - - - true if is not empty - - - - - MemberRefParent coded token interface - - - - - The coded token tag - - - - - HasSemantic coded token interface - - - - - The coded token tag - - - - - MethodDefOrRef coded token interface - - - - - The coded token tag - - - - - MemberForwarded coded token interface - - - - - The coded token tag - - - - - Gets/sets the impl map - - - - - true if is not null - - - - - Implementation coded token interface - - - - - The coded token tag - - - - - CustomAttributeType coded token interface - - - - - The coded token tag - - - - - ResolutionScope coded token interface - - - - - The coded token tag - - - - - TypeOrMethodDef coded token interface - - - - - The coded token tag - - - - - Gets the generic parameters - - - - - true if is not empty - - - - - HasCustomDebugInformation interface - - - - - The custom debug information tag - - - - - Gets the custom debug infos - - - - - true if is not empty - - - - - Access to .NET core library's simple types - - - - - Gets a System.Void - - - - - Gets a System.Boolean - - - - - Gets a System.Char - - - - - Gets a System.SByte - - - - - Gets a System.Byte - - - - - Gets a System.Int16 - - - - - Gets a System.UInt16 - - - - - Gets a System.Int32 - - - - - Gets a System.UInt32 - - - - - Gets a System.Int64 - - - - - Gets a System.UInt64 - - - - - Gets a System.Single - - - - - Gets a System.Double - - - - - Gets a System.String - - - - - Gets a System.TypedReference - - - - - Gets a System.IntPtr - - - - - Gets a System.UIntPtr - - - - - Gets a System.Object - - - - - Gets the assembly reference to the core library - - - - - Gets a that references a type in the core library assembly - - Namespace of type (eg. "System") - Name of type - A instance. This instance may be a cached instance. - - - - Custom attribute interface. Implemented by and - - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Interface to decrypt methods - - - - - Gets the method's body - - Method rid - The found in the method's Method row - The method's parameters - Generic parameter context - Updated with the method's if this - method returns true - true if the method body was decrypted, false if the method isn't - encrypted and the default body reader code should be used. - - - - Interface to decrypt strings - - - - - Reads a string - - String token - A string or null if we should read it from the #US heap - - - - events - - - - - An error was detected. An exception should normally be thrown but the error - can be ignored. - - - - - Just a warning and can be ignored. - - - - - A normal message - - - - - A verbose message - - - - - A very verbose message - - - - - Simple logger - - - - - Log something - - Caller or null - Logger event - Format - Arguments - - - - true if this event is ignored. If the event is ignored, the caller can - choose not to call . This is useful if it can take time to - prepare the message. - - The logger event - - - - Dummy logger which ignores all messages, but can optionally throw on errors. - - - - - It ignores everything and doesn't throw anything. - - - - - Throws a on errors, but ignores anything else. - - - - - Constructor - - If non-null, this exception type is thrown on - errors. It must have a public constructor that takes a as the only - argument. - - - - - - - - - - A high-level representation of a row in the ImplMap table - - - - - The row id in its table - - - - - - - - - - - From column ImplMap.MappingFlags - - - - Attributes - - - - From column ImplMap.ImportName - - - - Name - - - - From column ImplMap.ImportScope - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the char set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets best fit - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets throw on unmappable char - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets calling convention - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - true if it's the specified P/Invoke method, else false - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - Treat as Windows - true if it's the specified P/Invoke method, else false - - - - An ImplMap row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Scope - Name - Flags - - - - Created from a row in the ImplMap table - - - - - - - - Constructor - - The module which contains this ImplMap row - Row ID - If is null - If is invalid - - - - options - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s, s and s - whenever possible if the definition is located in this module. - - - - - - - - Don't set this flag. For internal use only. - - - - - Re-maps entities that were renamed in the target module - - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Overrides default behavior of - May be used to use reference assemblies for resolution, for example. - - to create for. - or null to use default 's type resolution - - - - Imports s, s, s - and s as references - - - - - Constructor - - The module that will own all references - - - - Constructor - - The module that will own all references - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - Mapper for renamed entities - - - - Imports a as a . If it's a type that should be - the declaring type of a field/method reference, call instead. - - The type - The imported type or null if is invalid - - - - Imports a as a . Should be called if it's the - declaring type of a method/field reference. See also - - The type - - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a . This will be either - a or a . - - The method - Always verify method signature to make sure the - returned reference matches the metadata in the source assembly - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a - - The field - Always verify field signature to make sure the - returned reference matches the metadata in the source assembly - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as an - - The field - The imported type or null if is invalid - - - - Imports a as an - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - A high-level representation of a row in the InterfaceImpl table - - - - - The row id in its table - - - - - - - - - - - - - - From column InterfaceImpl.Interface - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - An InterfaceImpl row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The interface the type implements - - - - Created from a row in the InterfaceImpl table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this InterfaceImpl row - Row ID - Generic parameter context - If is null - If is invalid - - - - Resolves types, methods, fields - - - - - Resolves types - - - - - Resolves a type - - The type - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves fields and methods - - - - - Resolves a method or a field - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves tokens - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Interface to get the full name of a type - - - - - true if it's a value type - - - - - Returns the name of this type - - - - - Returns the reflection name of this type - - - - - Returns the namespace of this type - - - - - Returns the reflection namespace of this type - - - - - Returns the reflection name of this type. See also . - - - - - Returns the reflection name of this type, and includes the assembly name where the - type is located. It can be passed to to - load the type. - - - - - Gets the assembly where this type is defined - - - - - Gets the scope, which is different from since it - can differentiate between modules within the same assembly. - - - - - Gets the type whose scope is returned by and whose assembly - is returned by . This is always a - , or null. It can also be a - nested . - For example, if this type is a System.String&, then this value is a System.String. - If it's a generic instance type (eg. List<int>), then the generic type is - returned (eg. List<T>). In other words, the first or - that is found (without searching generic arguments) is returned. - - - - - true if it's an integer or a floating point type - - - - - Implemented by types and calling convention signatures. - - - - - true if this contains a or a . - - - - - Finds s - - - - - Finds a - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . 's scope (i.e., module or - assembly) is ignored when looking up the type. - - The type ref - An existing or null if it wasn't found. - - - - Interface to access a local or a parameter - - - - - Gets the variable type - - - - - Gets the 0-based position - - - - - Gets/sets the variable name - - - - - A high-level representation of a row in the ManifestResource table - - - - - The row id in its table - - - - - - - - - - - - - - From column ManifestResource.Offset - - - - - - - - From column ManifestResource.Flags - - - - Attributes - - - - From column ManifestResource.Name - - - - Name - - - - From column ManifestResource.Implementation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - A ManifestResource row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - Implementation - - - - Constructor - - Name - Implementation - Flags - - - - Constructor - - Name - Implementation - Flags - Offset - - - - Created from a row in the ManifestResource table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ManifestResource row - Row ID - If is null - If is invalid - - - - ManifestResource flags. See CorHdr.h/CorManifestResourceFlags - - - - - - - The Resource is exported from the Assembly. - - - The Resource is private to the Assembly. - - - - Reads s - - - - - Reads a from the #Blob heap - - Module - Blob offset - A new instance - - - - Reads a from the #Blob heap - - Module - Blob offset - Generic parameter context - A new instance - - - - Reads a from - - Owner module - Marshal data - A new instance - - - - Reads a from - - Owner module - Marshal data - Generic parameter context - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - Generic parameter context - A new instance - - - - Base class of all marshal types - - - - - The native type - - - - - Gets the - - - - - Constructor - - Native type - - - - - - - Contains the raw marshal blob data - - - - - Gets/sets the raw data - - - - - Constructor - - Raw data - - - - A marshal type - - - - - Gets/sets the size - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - - - - A marshal type - - - - - Gets/sets the variant type - - - - - Gets/sets the user-defined sub type (it's usually null) - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Variant type - - - - Constructor - - User-defined sub type - - - - Constructor - - Variant type - User-defined sub type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the size - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - Constructor - - Size - Element type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the parameter number - - - - - Gets/sets the size of the array - - - - - Gets/sets the flags - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if ntaSizeParamIndexSpecified bit is set, false if it's not - set or if is invalid. - - - - - true if ntaSizeParamIndexSpecified bit is not set, false if it's - set or if is invalid. - - - - - Default constructor - - - - - Constructor - - Element type - - - - Constructor - - Element type - Parameter number - - - - Constructor - - Element type - Parameter number - Number of elements - - - - Constructor - - Element type - Parameter number - Number of elements - Flags - - - - - - - A marshal type - - - - - Gets/sets the GUID string - - - - - Gets/sets the native type name string - - - - - Gets/sets the custom marshaler - - - - - Gets/sets the cookie string - - - - - Default constructor - - - - - Constructor - - GUID string - - - - Constructor - - GUID string - Native type name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - Cookie string - - - - - - - A , or a - marshal type - - - - - Gets/sets the IID parameter index - - - - - true if is valid - - - - - Constructor - - Native type - - - - Constructor - - Native type - IID parameter index - - - - - - - Metadata token - - - - - Mask to get the rid from a raw metadata token - - - - - Max rid value - - - - - Number of bits to right shift a raw metadata token to get the table index - - - - - Returns the table type - - - - - Returns the row id - - - - - Returns the raw token - - - - - Returns true if it's a null token - - - - - Constructor - - Raw token - - - - Constructor - - Raw token - - - - Constructor - - The table type - Row id - - - - Constructor - - The table type - Row id - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Gets the token as a raw 32-bit signed integer - - - - - Gets the token as a raw 32-bit unsigned integer - - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Represents the #Blob stream - - - - - - - - - - - Reads data - - Offset of data - The data or null if invalid offset - - - - Reads data just like , but returns an empty array if - offset is invalid - - Offset of data - The data - - - - Creates a reader that can access a blob - - Offset of blob - A new stream - - - - Creates a reader that can access a blob or returns false on failure - - Offset of blob - Updated with the reader - - - - - Contains all possible coded token classes - - - - TypeDefOrRef coded token - - - HasConstant coded token - - - HasCustomAttribute coded token - - - HasFieldMarshal coded token - - - HasDeclSecurity coded token - - - MemberRefParent coded token - - - HasSemantic coded token - - - MethodDefOrRef coded token - - - MemberForwarded coded token - - - Implementation coded token - - - CustomAttributeType coded token - - - ResolutionScope coded token - - - TypeOrMethodDef coded token - - - HasCustomDebugInformation coded token - - - - Returns all types of tables - - - - - Returns the number of bits that is used to encode table type - - - - - Constructor - - Number of bits used to encode token type - All table types - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - true if successful - - - - Encodes a token - - The token - Coded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Info about one column in a MD table - - - - - Gets the column index - - - - - Returns the column offset within the table row - - - - - Returns the column size - - - - - Returns the column name - - - - - Returns the ColumnSize enum value - - - - - Constructor - - Column index - The column name - Column size - - - - Constructor - - Column index - The column name - Column size - Offset of column - Size of column - - - - Reads the column - - A reader positioned on this column - The column value - - - - Writes a column - - The writer position on this column - The column value - - - - MD table column size - - - - RID into Module table - - - RID into TypeRef table - - - RID into TypeDef table - - - RID into FieldPtr table - - - RID into Field table - - - RID into MethodPtr table - - - RID into Method table - - - RID into ParamPtr table - - - RID into Param table - - - RID into InterfaceImpl table - - - RID into MemberRef table - - - RID into Constant table - - - RID into CustomAttribute table - - - RID into FieldMarshal table - - - RID into DeclSecurity table - - - RID into ClassLayout table - - - RID into FieldLayout table - - - RID into StandAloneSig table - - - RID into EventMap table - - - RID into EventPtr table - - - RID into Event table - - - RID into PropertyMap table - - - RID into PropertyPtr table - - - RID into Property table - - - RID into MethodSemantics table - - - RID into MethodImpl table - - - RID into ModuleRef table - - - RID into TypeSpec table - - - RID into ImplMap table - - - RID into FieldRVA table - - - RID into ENCLog table - - - RID into ENCMap table - - - RID into Assembly table - - - RID into AssemblyProcessor table - - - RID into AssemblyOS table - - - RID into AssemblyRef table - - - RID into AssemblyRefProcessor table - - - RID into AssemblyRefOS table - - - RID into File table - - - RID into ExportedType table - - - RID into ManifestResource table - - - RID into NestedClass table - - - RID into GenericParam table - - - RID into MethodSpec table - - - RID into GenericParamConstraint table - - - RID into Document table - - - RID into MethodDebugInformation table - - - RID into LocalScope table - - - RID into LocalVariable table - - - RID into LocalConstant table - - - RID into ImportScope table - - - RID into StateMachineMethod table - - - RID into CustomDebugInformation table - - - 8-bit byte - - - 16-bit signed int - - - 16-bit unsigned int - - - 32-bit signed int - - - 32-bit unsigned int - - - Index into #Strings stream - - - Index into #GUID stream - - - Index into #Blob stream - - - TypeDefOrRef encoded token - - - HasConstant encoded token - - - HasCustomAttribute encoded token - - - HasFieldMarshal encoded token - - - HasDeclSecurity encoded token - - - MemberRefParent encoded token - - - HasSemantic encoded token - - - MethodDefOrRef encoded token - - - MemberForwarded encoded token - - - Implementation encoded token - - - CustomAttributeType encoded token - - - ResolutionScope encoded token - - - TypeOrMethodDef encoded token - - - HasCustomDebugInformation encoded token - - - - See COMIMAGE_FLAGS_XXX in CorHdr.h in the Windows SDK - - - - - See COMIMAGE_FLAGS_ILONLY in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITREQUIRED in the Windows SDK - - - - - Set if a native header exists (COMIMAGE_FLAGS_IL_LIBRARY) - - - - - See COMIMAGE_FLAGS_STRONGNAMESIGNED in the Windows SDK - - - - - See COMIMAGE_FLAGS_NATIVE_ENTRYPOINT in the Windows SDK - - - - - See COMIMAGE_FLAGS_TRACKDEBUGDATA in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITPREFERRED in the Windows SDK - - - - - Used when a #~ stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - A custom .NET metadata stream - - - - - Constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - .NET metadata stream - - - - - Reader that can access the whole stream. - - NOTE: Always copy this field to a local variable before using it since it must be thread safe. - - - - - null if it wasn't present in the file - - - - - - - - - - - Gets the length of this stream in the metadata - - - - - Gets the stream header - - - - - Gets the name of the stream - - - - - Gets a data reader that can read the full stream - - - - - - Default constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - Called after gets recreated - - - - - - - - Dispose method - - true if called by - - - - Checks whether an index is valid - - The index - true if the index is valid - - - - Check whether an offset is within the stream - - Stream offset - true if the offset is valid - - - - Check whether an offset is within the stream - - Stream offset - Size of data - true if the offset is valid - - - - Base class of #US, #Strings, #Blob, and #GUID classes - - - - - - - - - - - Initializes .NET table row sizes - - - - - Initializes the table sizes - - true if #Strings size >= 0x10000 - true if #GUID size >= 0x10000 - true if #Blob size >= 0x10000 - Count of rows in each table - Count of rows in each table (debug tables) - - - - Creates the table infos - - Major table version - Minor table version - All table infos (not completely initialized) - - - - Creates the table infos - - Major table version - Minor table version - Initialized to max present tables (eg. 42 or 45) - All table infos (not completely initialized) - - - - Used when a #- stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - Converts a logical Field rid to a physical Field rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Method rid to a physical Method rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Param rid to a physical Param rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Event rid to a physical Event rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Property rid to a physical Property rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - Linear searches the table (O(n)) for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - - - - Represents the #GUID stream - - - - - - - - - - - - - - Read a - - Index into this stream - A or null if is 0 or invalid - - - - Heap type. The values are set in stone by MS. Don't change. - - - - #Strings heap - - - #GUID heap - - - #Blob heap - - - #US heap - - - - Represents the IMAGE_COR20_HEADER structure - - - - - Returns true if it has a native header - - - - - Returns the IMAGE_COR20_HEADER.cb field - - - - - Returns the IMAGE_COR20_HEADER.MajorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.MinorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.Metadata field - - - - - Returns the IMAGE_COR20_HEADER.Flags field - - - - - Returns the IMAGE_COR20_HEADER.EntryPointToken/EntryPointTokenRVA field - - - - - Returns the IMAGE_COR20_HEADER.Resources field - - - - - Returns the IMAGE_COR20_HEADER.StrongNameSignature field - - - - - Returns the IMAGE_COR20_HEADER.CodeManagerTable field - - - - - Returns the IMAGE_COR20_HEADER.VTableFixups field - - - - - Returns the IMAGE_COR20_HEADER.ExportAddressTableJumps field - - - - - Returns the IMAGE_COR20_HEADER.ManagedNativeHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Reads metadata table columns - - - - - Reads a column - - The table to read from - Table row id - The column to read - Result - true if was updated, false if - the column should be read from the original table. - - - - Reads table rows - - Raw row - - - - Reads a table row or returns false if the row should be read from the original table - - Row id - The row - - - - - Version strings found in the meta data header - - - - - MS CLR 1.0 version string (.NET 1.0) - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.1 version string (.NET 1.1) - - - - - MS CLR 2.0 version string (.NET 2.0-3.5) - - - - - MS CLR 4.0 version string (.NET 4.0-4.5) - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.1 any version - - - - - MS CLR 2.0 any version - - - - - MS CLR 4.0 any version - - - - - ECMA 2002 version string - - - - - ECMA 2005 version string - - - - - Portable PDB v1.0 - - - - - MDStream flags - - - - #Strings stream is big and requires 4 byte offsets - - - #GUID stream is big and requires 4 byte offsets - - - #Blob stream is big and requires 4 byte offsets - - - - - - - - - Extra data follows the row counts - - - Set if certain tables can contain deleted rows. The name column (if present) is set to "_Deleted" - - - - A MD table (eg. Method table) - - - - - - - - - - - Gets the table - - - - - Gets the name of this table - - - - - Returns total number of rows - - - - - Gets the total size in bytes of one row in this table - - - - - Returns all the columns - - - - - Returns true if there are no valid rows - - - - - Returns info about this table - - - - - Constructor - - The table - Number of rows in this table - Info about this table - - - - Checks whether the row exists - - Row ID - - - - Checks whether the row does not exist - - Row ID - - - - - - - Reads .NET metadata - - - - - true if the compressed (normal) metadata is used, false if the non-compressed - (Edit N' Continue) metadata is used. This can be false even if the table stream - is #~ but that's very uncommon. - - - - - true if this is standalone Portable PDB metadata - - - - - Gets the .NET header - - - - - Gets the version found in the metadata header. The major version number is in the high 16 bits - and the lower version number is in the low 16 bits. - - - - - Gets the version string found in the metadata header - - - - - Gets the - - - - - Gets the metadata header - - - - - Returns the #Strings stream or a default empty one if it's not present - - - - - Returns the #US stream or a default empty one if it's not present - - - - - Returns the #Blob stream or a default empty one if it's not present - - - - - Returns the #GUID stream or a default empty one if it's not present - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Pdb stream or null if it's not a standalone portable PDB file - - - - - Gets all streams - - - - - Gets a list of all the valid TypeDef rids. It's usually every rid in the - TypeDef table, but could be less if a type has been deleted. - - - - - Gets a list of all the valid ExportedType rids. It's usually every rid in the - ExportedType table, but could be less if a type has been deleted. - - - - - Gets the Field rid list - - TypeDef rid - A new instance - - - - Gets the Method rid list - - TypeDef rid - A new instance - - - - Gets the Param rid list - - Method rid - A new instance - - - - Gets the Event rid list - - EventMap rid - A new instance - - - - Gets the Property rid list - - PropertyMap rid - A new instance - - - - Finds all InterfaceImpl rids owned by - - Owner TypeDef rid - A instance containing the valid InterfaceImpl rids - - - - Finds all GenericParam rids owned by in table - - A TypeOrMethodDef table - Owner rid - A instance containing the valid GenericParam rids - - - - Finds all GenericParamConstraint rids owned by - - Owner GenericParam rid - A instance containing the valid GenericParamConstraint rids - - - - Finds all CustomAttribute rids owned by in table - - A HasCustomAttribute table - Owner rid - A instance containing the valid CustomAttribute rids - - - - Finds all DeclSecurity rids owned by in table - - A HasDeclSecurity table - Owner rid - A instance containing the valid DeclSecurity rids - - - - Finds all MethodSemantics rids owned by in table - - A HasSemantic table - Owner rid - A instance containing the valid MethodSemantics rids - - - - Finds all MethodImpl rids owned by - - Owner TypeDef rid - A instance containing the valid MethodImpl rids - - - - Finds a ClassLayout rid - - Owner TypeDef rid - The ClassLayout rid or 0 if is invalid - or if it has no row in the ClassLayout table. - - - - Finds a FieldLayout rid - - Owner Field rid - The FieldLayout rid or 0 if is invalid - or if it has no row in the FieldLayout table. - - - - Finds a FieldMarshal rid - - A HasFieldMarshal table - Owner rid - The FieldMarshal rid or 0 if is invalid - or if it has no row in the FieldMarshal table. - - - - Finds a FieldRVA rid - - Owner Field rid - The FieldRVA rid or 0 if is invalid - or if it has no row in the FieldRVA table. - - - - Finds an ImplMap rid - - A MemberForwarded table - Owner rid - The ImplMap rid or 0 if is invalid - or if it has no row in the ImplMap table. - - - - Finds a NestedClass rid - - Owner TypeDef rid - The NestedClass rid or 0 if is invalid - or if it has no row in the NestedClass table. - - - - Finds an EventMap rid - - Owner TypeDef rid - The EventMap rid or 0 if is invalid - or if it has no row in the EventMap table. - - - - Finds a PropertyMap rid - - Owner TypeDef rid - The PropertyMap rid or 0 if is invalid - or if it has no row in the PropertyMap table. - - - - Finds a Constant rid - - A HasConstant table - Owner rid - The Constant rid or 0 if is invalid - or if it has no row in the Constant table. - - - - Returns the owner TypeDef rid - - A Field rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Method rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Event rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Property rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeOrMethodDef rid - - A GenericParam rid - The owner TypeOrMethodDef rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner GenericParam rid - - A GenericParamConstraint rid - The owner GenericParam rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner Method rid - - A Param rid - The owner Method rid or 0 if is invalid - or if it has no owner. - - - - Gets a list of all nested classes owned by - - A TypeDef rid - A new instance - - - - Gets a list of all non-nested classes. A type is a non-nested type if - returns an empty list. - - A new instance - - - - Finds all LocalScope rids owned by - - Owner Method rid - A instance containing the valid LocalScope rids - - - - Gets the StateMachineMethod rid or 0 if it's not a state machine method - - Owner Method rid - - - - - Finds all CustomDebugInformation rids owned by in table - - A HasCustomDebugInformation table - Owner rid - A instance containing the valid CustomDebugInformation rids - - - - Disposes of this instance - - - - - Common base class for #~ and #- metadata classes - - - - - The PE image - - - - - The .NET header - - - - - The MD header - - - - - The #Strings stream - - - - - The #US stream - - - - - The #Blob stream - - - - - The #GUID stream - - - - - The #~ or #- stream - - - - - The #Pdb stream - - - - - All the streams that are present in the PE image - - - - true if this is standalone Portable PDB metadata - - - - Sorts a table by key column - - - - - Remembers rid and key - - - - - Constructor - - Row ID - Key - - - - Constructor - - The MD table - Index of key column - - - - Binary searches for a row with a certain key - - The key - The row or 0 if not found - - - - Find all rids that contain - - The key - A new instance - - - - Constructor - - The PE image - The .NET header - The MD header - - - - Initializes the metadata, tables, streams - - - - - Creates empty heap objects if they're not present in the metadata - - - - - Called by - - - - - Binary searches the table for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - Finds all rows owned by in table - whose index is - - Table to search - Key column index - Key - A instance - - - - Finds all rows owned by in table - whose index is . Should be called if - could be unsorted. - - Table to search - Key column index - Key - A instance - - - - Dispose method - - true if called by - - - - Low level access to a .NET file's metadata - - - - - Create a instance - - The PE image - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - A new instance - - - - Create a instance - - The PE image - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a standalone portable PDB instance - - Metadata stream - true if we should verify that it's a .NET PE file - A new instance - - - - Represents the .NET metadata header - - IMAGE_COR20_HEADER.Metadata points to this header - - - - Returns the signature (should be 0x424A5342) - - - - - Returns the major version - - - - - Returns the minor version - - - - - Returns the reserved dword (pointer to extra header data) - - - - - Returns the version string length value - - - - - Returns the version string - - - - - Returns the offset of STORAGEHEADER - - - - - Returns the flags (reserved) - - - - - Returns the reserved byte (padding) - - - - - Returns the number of streams - - - - - Returns all stream headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Constructor - - PE file reader pointing to the start of this section - Runtime reader kind - Verify section - Thrown if verification fails - - - - #Pdb stream - - - - - Gets the PDB id - - - - - Gets the entry point token or 0 - - - - - Gets the referenced type system tables in the PE metadata file - - - - - Gets all type system table rows. This array has exactly 64 elements. - - - - - - - - Equality comparer for all raw rows - - - - - Default instance - - - - - Raw contents of an uncompressed Module table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeDef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Field table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Method table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ParamPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Param table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed InterfaceImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MemberRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Constant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomAttribute table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldMarshal table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed DeclSecurity table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ClassLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StandAloneSig table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Event table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Property table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSemantics table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ModuleRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImplMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldRVA table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCLog table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Assembly table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed File table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ExportedType table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ManifestResource table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed NestedClass table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParam table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParamConstraint table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Document table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalVariable table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalConstant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImportScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StateMachineMethod table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Stores a list of rids - - - - - Gets the empty instance - - - - - Creates a new instance - - - - - - - - Creates a new instance - - List of valid rids - - - - - Gets the 'th rid - - Index. Must be < - A rid or 0 if is invalid - - - - Gets the number of rids it will iterate over - - - - - Enumerator - - - - - Gets the current rid - - - - - Disposes this instance - - - - - Moves to the next rid - - - - - - Gets the enumerator - - - - - - Storage flags found in the MD header - - - - - Normal flags - - - - - More data after the header but before the streams. - - The CLR will fail to load the file if this flag (or any other bits) is set. - - - - A metadata stream header - - - - - The offset of the stream relative to the start of the metadata header - - - - - The size of the stream - - - - - The name of the stream - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the #Strings stream - - - - - - - - - - - Reads a - - Offset of string - A instance or null if invalid offset - - - - Reads a . The empty string is returned if - is invalid. - - Offset of string - A instance - - - - The metadata tables - - - - Module table (00h) - - - TypeRef table (01h) - - - TypeDef table (02h) - - - FieldPtr table (03h) - - - Field table (04h) - - - MethodPtr table (05h) - - - Method table (06h) - - - ParamPtr table (07h) - - - Param table (08h) - - - InterfaceImpl table (09h) - - - MemberRef table (0Ah) - - - Constant table (0Bh) - - - CustomAttribute table (0Ch) - - - FieldMarshal table (0Dh) - - - DeclSecurity table (0Eh) - - - ClassLayout table (0Fh) - - - FieldLayout table (10h) - - - StandAloneSig table (11h) - - - EventMap table (12h) - - - EventPtr table (13h) - - - Event table (14h) - - - PropertyMap table (15h) - - - PropertyPtr table (16h) - - - Property table (17h) - - - MethodSemantics table (18h) - - - MethodImpl table (19h) - - - ModuleRef table (1Ah) - - - TypeSpec table (1Bh) - - - ImplMap table (1Ch) - - - FieldRVA table (1Dh) - - - ENCLog table (1Eh) - - - ENCMap table (1Fh) - - - Assembly table (20h) - - - AssemblyProcessor table (21h) - - - AssemblyOS table (22h) - - - AssemblyRef table (23h) - - - AssemblyRefProcessor table (24h) - - - AssemblyRefOS table (25h) - - - File table (26h) - - - ExportedType table (27h) - - - ManifestResource table (28h) - - - NestedClass table (29h) - - - GenericParam table (2Ah) - - - MethodSpec table (2Bh) - - - GenericParamConstraint table (2Ch) - - - (Portable PDB) Document table (30h) - - - (Portable PDB) MethodDebugInformation table (31h) - - - (Portable PDB) LocalScope table (32h) - - - (Portable PDB) LocalVariable table (33h) - - - (Portable PDB) LocalConstant table (34h) - - - (Portable PDB) ImportScope table (35h) - - - (Portable PDB) StateMachineMethod table (36h) - - - (Portable PDB) CustomDebugInformation table (37h) - - - - Info about one MD table - - - - - Returns the table type - - - - - Returns the total size of a row in bytes - - - - - Returns all the columns - - - - - Returns the name of the table - - - - - Constructor - - Table type - Table name - All columns - - - - Constructor - - Table type - Table name - All columns - Row size - - - - .NET metadata tables stream - - - - - Gets/sets the column reader - - - - - Gets/sets the Method table reader - - - - - Gets the reserved field - - - - - Gets the version. The major version is in the upper 8 bits, and the minor version - is in the lower 8 bits. - - - - - Gets - - - - - Gets the reserved log2 rid field - - - - - Gets the valid mask - - - - - Gets the sorted mask - - - - - Gets the extra data - - - - - Gets the MD tables - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - factory - Offset of metadata - Stream header - - - - Constructor - - factory - Offset of metadata - Stream header - Runtime kind - - - - Initializes MD tables - - Type system table rows (from #Pdb stream) - - - - - - - - - - Returns a MD table - - The table type - A or null if table doesn't exist - - - - Checks whether a table exists - - The table type - true if the table exists - - - - Checks whether table is sorted - - The table - - - - Reads a raw Module row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeDef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Field row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Method row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ParamPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Param row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw InterfaceImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MemberRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Constant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomAttribute row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldMarshal row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw DeclSecurity row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ClassLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StandAloneSig row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Event row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Property row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSemantics row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ModuleRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImplMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldRVA row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCLog row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Assembly row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw File row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ExportedType row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ManifestResource row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw NestedClass row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParam row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParamConstraint row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Document row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalVariable row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalConstant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImportScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StateMachineMethod row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a column - - The table - Row ID - Column index in - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Reads a column - - The table - Row ID - Column - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Represents the #US stream - - - - - - - - - - - Reads a unicode string - - Offset of unicode string - A string or null if is invalid - - - - Reads data just like , but returns an empty string if - offset is invalid - - Offset of unicode string - The string - - - - Finds types, fields, methods, etc in a module. If nothing has been added to the module, it's - faster to call ResolveMethodDef(), ResolveTypeRef() etc. - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - Finds all types, fields, etc - - The module to scan - Itself - - - - Methods to load properties to make sure they're initialized - - - - - Read every collection element - - Collection element type - Collection - - - - Load the object instance - - The value (ignored) - - - - A high-level representation of a row in the MemberRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - From column MemberRef.Class - - - - - - - - From column MemberRef.Name - - - - Name - - - - From column MemberRef.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if this is a method reference ( != null) - - - - - true if this is a field reference ( != null) - - - - - Gets/sets the method sig - - - - - Gets/sets the field sig - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - - - - Gets the full name - - - - - Get the declaring type's full name - - Full name or null if there's no declaring type - - - - Resolves the method/field - - A or a instance or null - if it couldn't be resolved. - - - - Resolves the method/field - - A or a instance - If the method/field couldn't be resolved - - - - Resolves the field - - A instance or null if it couldn't be resolved. - - - - Resolves the field - - A instance - If the field couldn't be resolved - - - - Resolves the method - - A instance or null if it couldn't be resolved. - - - - Resolves the method - - A instance - If the method couldn't be resolved - - - - Gets a that can be used as signature context - - Context passed to the constructor - Field/method class owner - - - - - - - - A MemberRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Name of ref - - - - Constructor - - Owner module - Name of field ref - Field sig - - - - Constructor - - Owner module - Name of field ref - Field sig - Owner of field - - - - Constructor - - Owner module - Name of method ref - Method sig - - - - Constructor - - Owner module - Name of method ref - Method sig - Owner of method - - - - Created from a row in the MemberRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MemberRef row - Row ID - Generic parameter context - If is null - If is invalid - - - - Method attributes, see CorHdr.h/CorMethodAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Method may not be overridden. - - - Method virtual. - - - Method hides by name+sig, else just by name. - - - vtable layout mask - Use this mask to retrieve vtable attributes. - - - The default. - - - Method always gets a new slot in the vtable. - - - Overridability is the same as the visibility. - - - Method does not provide an implementation. - - - Method is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Managed method exported via thunk to unmanaged code. - - - Runtime should check name encoding. - - - Method has security associate with it. - - - Method calls another method containing security code. - - - - A high-level representation of a row in the Method table - - - - - The row id in its table - - - - - All parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column Method.RVA - - - - - - - - From column Method.ImplFlags - - - - Implementation attributes - - - - From column Method.Flags - - - - Attributes - - - - From column Method.Name - - - - Name - - - - From column Method.Signature - - - - - - - - From column Method.ParamList - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the method body. See also - - - - - - - - - - - Frees the method body if it has been loaded. This does nothing if - returns false. - - - - Called to initialize - - - - true if can free the method body - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the methods this method implements - - - - - - - Initializes - - - - Gets the export info or null if the method isn't exported to unmanaged code. - - - - - - - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets/sets the CIL method body. See also - - - - - Gets/sets the native method body - - - - - true if there's at least one in - - - - - true if it has a - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets the full name - - - - - Gets/sets the - - - - - Gets the parameters - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - true if the method returns a value (i.e., return type is not ) - - - - - Gets/sets the method semantics attributes. If you remove/add a method to a property or - an event, you must manually update this property or eg. won't - work as expected. - - - - Set when has been initialized - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the method access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the code type - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the static type constructor - - - - - true if this is an instance constructor - - - - - true if this is a static or an instance constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A Method row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Method name - - - - Constructor - - Method name - Method sig - - - - Constructor - - Method name - Method sig - Flags - - - - Constructor - - Method name - Method sig - Impl flags - - - - Constructor - - Method name - Method sig - Impl flags - Flags - - - - Created from a row in the Method table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Method row - Row ID - If is null - If is invalid - - - - - - - - - - Contains the name and ordinal of a method that gets exported to unmanaged code. - - - - - Gets the ordinal or null - - - - - Gets the name. If it's null, and is also null, the name of the method - () is used as the exported name. - - - - - Gets the options - - - - - Constructor - - - - - Constructor - - Name or null to export by ordinal - - - - Constructor - - Ordinal - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - Options - - - - Exported method options - - - - - No bit is set - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - Method impl attributes, see CorHdr.h/CorMethodImpl - - - - Flags about code type. - - - Method impl is IL. - - - Method impl is native. - - - Method impl is OPTIL - - - Method impl is provided by the runtime. - - - Flags specifying whether the code is managed or unmanaged. - - - Method impl is unmanaged, otherwise managed. - - - Method impl is managed. - - - Indicates method is defined; used primarily in merge scenarios. - - - Indicates method sig is not to be mangled to do HRESULT conversion. - - - Reserved for internal use. - - - Method is single threaded through the body. - - - Method may not be inlined. - - - Method should be inlined if possible. - - - Method may not be optimized. - - - Method may contain hot code and should be aggressively optimized. - - - The JIT compiler should look for security mitigation attributes, such as the user-defined System.Runtime.CompilerServices.SecurityMitigationsAttribute. If found, the JIT compiler applies any related security mitigations. Available starting with .NET Framework 4.8. - - - - Describes which method some method implements - - - - - The method body. Usually a but could be a - - - - - The method implements - - - - - Constructor - - Method body - The method implements - - - - Method semantics flags, see CorHdr.h/CorMethodSemanticsAttr - - - - No bit is set - - - Setter for property - - - Getter for property - - - other method for property or event - - - AddOn method for event - - - RemoveOn method for event - - - Fire method for event - - - - A high-level representation of a row in the MethodSpec table - - - - - The row id in its table - - - - - - - - - - - - - - From column MethodSpec.Method - - - - - - - - From column MethodSpec.Instantiation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - Gets/sets the generic instance method sig - - - - - - - - - - - Gets the full name - - - - - - - - A MethodSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic method - - - - Constructor - - The generic method - The instantiated method sig - - - - Created from a row in the MethodSpec table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MethodSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - context - - - - - Gets/sets the assembly resolver. This is never null. - - - - - Gets/sets the resolver. This is never null. - - - - - Default constructor - - - - - Constructor - - Assembly resolver or null - - - - Constructor - - Type/method/field resolver or null - - - - Constructor - - Assembly resolver or null - Type/method/field resolver or null - - - - creation options - - - - - Module context - - - - - PDB reader options - - - - - Set it to A) the path (string) of the PDB file, B) the data (byte[]) of the PDB file or - C) to an of the PDB data. The will - be owned by the module. You don't need to initialize - - - - - If true, will load the PDB file from disk if present, or an embedded portable PDB file - stored in the PE file. The default value is true. - You don't need to initialize . - - - - - corlib assembly reference to use or null if the default one from the opened - module should be used. - - - - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - - Default constructor - - - - - Constructor - - Module context - - - - Constructor - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Constructor - - Module context - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Runtime reader kind - - - - - Microsoft's CLRs (.NET Framework, .NET Core) - - - - - Mono's CLR (Mono, Unity) - - - - - A high-level representation of a row in the Module table - - - - Default characteristics - - - Default DLL characteristics - - - - The row id in its table - - - - - Initialize this in the ctor - - - - - PDB state - - - - - Array of last used rid in each table. I.e., next free rid is value + 1 - - - - Module context - - - - - - - - - - - - - - - - Gets/sets a user value. This is never used by dnlib. This property isn't thread safe. - - - - - - - - - - - Gets/sets Module.Generation column - - - - - - - - Gets/sets Module.Name column - - - - Name - - - - Gets/sets Module.Mvid column - - - - - - - - Gets/sets Module.EncId column - - - - - - - - Gets/sets Module.EncBaseId column - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the module's assembly. To set this value, add this - to . - - - - - - - - Gets a list of all non-nested s. See also - - - - - - - Initializes - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the native entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - Gets/sets the managed entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - - - - - - - - - Called to initialize - - - Called to initialize - - - - - - - Gets/sets the entry point method - - - - - true if is non-zero - - - - - true if is non-null - - - - - true if is non-null - - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the . This is null if there are no - vtable fixups. - - - - - - - - - - Called to initialize - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - - - - Gets/sets the path of the module or an empty string if it wasn't loaded from disk - - - - - - - - Gets the - - - - - Gets the instance - - - - - Gets/sets the module context. This is never null. - - - - - If true, the cache is enabled. The cache is used by - and to find types. -

- IMPORTANT: Only enable the cache if this module's types keep their exact - name, namespace, and declaring type and if no type is either added or - removed from or from any type that is reachable from the - top-level types in (i.e., any type owned by this module). - This is disabled by default. When disabled, all calls to - and will result in a slow O(n) (linear) search. -
- -
- - - true if this is the manifest (main) module - - - - - Gets the global (aka. <Module>) type or null if there are no types - - - - - true if it's the core library module, false if it's not the core library module, - and null if it's not known. - - - - - Gets/sets the Win32 resources - - - - - - - - - - Called to initialize - - - - Gets the . This is null if no PDB file - has been loaded or if no PDB file could be found. - - - - - Module kind - - - - - Gets/sets the characteristics (from PE file header) - - - - - Gets/sets the DLL characteristics (from PE optional header) - - - - - Gets/sets the runtime version which is stored in the metadata header. - See . - - Not thread safe - - - - Gets the WinMD status - - Not thread safe - - - - true if this is a WinMD file - - - - - true if this is a managed WinMD file - - - - - true if this is a pure (non-managed) WinMD file - - - - - Gets the CLR runtime version of the managed WinMD file or null if none. This is - similar to for normal non-WinMD files. - - Not thread safe - - - - Gets the WinMD version or null if none - - Not thread safe - - - - true if is the CLR v1.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.0 string - - - - - true if is the CLR v1.1 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.1 string - - - - - true if is the CLR v1.0 or v1.1 string (only the - major and minor version numbers are checked) - - - - - true if is the CLR v1.0 or v1.1 string - - - - - true if is the CLR v2.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v2.0 string - - - - - true if is the CLR v4.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v4.0 string - - - - - true if is the ECMA 2002 string - - - - - true if is the ECMA 2005 string - - - - - Gets/sets the (from PE header) - - - - - true if is , , ... - - - - - true if is - - - - - true if is , , ... - - - - - true if is , , ... - - - - - true if is , , ... - - - - - Gets/sets the (from .NET header) - - - - - - - - Gets/sets the runtime version number in the COR20 header. The major version is - in the high 16 bits. The minor version is in the low 16 bits. This is normally 2.5 - (0x00020005), but if it's .NET 1.x, it should be 2.0 (0x00020000). If this is - null, the default value will be used when saving the module (2.0 if CLR 1.x, - and 2.5 if not CLR 1.x). - - - - - Gets the tables header version. The major version is in the upper 8 bits and the - minor version is in the lower 8 bits. .NET 1.0/1.1 use version 1.0 (0x0100) and - .NET 2.x and later use version 2.0 (0x0200). 1.0 has no support for generics, - 1.1 has support for generics (GenericParam rows have an extra Kind column), - and 2.0 has support for generics (GenericParam rows have the standard 4 columns). - No other version is supported. If this is null, the default version is - used (1.0 if .NET 1.x, else 2.0). - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - Dispose method - - true if called by - - - - Gets all the types (including nested types) present in this module - - - - - Adds as a non-nested type. If it's already nested, its - will be set to null. - - The to insert - - - - Updates the rid to the next free rid available. It's only updated if - the original rid is 0. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Updates the rid to the next free rid available. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as a - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the module to a stream. - - Destination stream - - - - Writes the module to a stream. - - Destination stream - Writer options - - - - Resets the cache which can be enabled by setting - to true. Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - Creates a new - - PDB file kind - - - - Sets a - - New - - - - Returns the size of a pointer. Assumes it's 32-bit if pointer size is unknown or - if it can be 32-bit or 64-bit. - - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size if it's not known or if it - can be 32-bit or 64-bit - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size - Pointer size if it's prefer-32-bit (should usually be 4) - - - - - - - - - - - - - - - - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable if possible - (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Finds a - - The type - A or null if it wasn't found - - - - Creates a new instance. There should normally only be one - instance shared by all s. - - A new instance - - - - Load everything in this module. All types, fields, asm refs, etc are loaded, all their - properties are read to make sure everything is cached. - - Cancellation token or null - - - - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Gets all s - - - - - Gets all s - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - Generic parameter context - - - - Gets all s - - - - - Finds an assembly reference by name. If there's more than one, pick the one with - the greatest version number. - - Simple name of assembly (eg. "mscorlib") - The found or null if there's no such - assembly reference. - - - - Compare asm refs' version - - First asm ref - New asm ref - - - - - A Module row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - is initialized to a random - Module nam - - - - Constructor - - Module name - Module version ID - - - - Constructor - - Module name - Module version ID - Corlib assembly ref or null - - - - Created from a row in the Module table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Module row - Row ID - If is null - If is invalid - - - - Initialize fields from the raw Module row - - - - - Created from a row in the Module table - - - - The file that contains all .NET metadata - - - - Gets/sets the method decrypter - - - - - Gets/sets the string decrypter - - - - - Returns the .NET metadata interface - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Strings stream - - - - - Returns the #Blob stream - - - - - Returns the #GUID stream - - - - - Returns the #US stream - - - - - - - - - - - - - - - - - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance - - PE image - A new instance - - - - Creates a instance - - PE image - Module context or null - A new instance - - - - Creates a instance - - PE image - Module creation options or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module context or null - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module creation options or null - A new instance - If is null - - - - Creates a instance from a - - The metadata - Module creation options or null - A new instance that now owns - - - - Constructor - - The metadata - Module creation options or null - If is null - - - - Loads symbols using - - PDB symbol reader - - - - Loads symbols from a PDB file - - PDB file name - - - - Loads symbols from a PDB file - - PDB reader options - PDB file name - - - - Loads symbols from a byte array - - PDB data - - - - Loads symbols from a byte array - - PDB reader options - PDB data - - - - Loads symbols from a stream - - PDB file stream which is now owned by us - - - - Loads symbols from a stream - - PDB reader options - PDB file stream which is now owned by us - - - - Loads symbols if a PDB file is available - - - - - Loads symbols if a PDB file is available - - PDB reader options - - - - Finds a mscorlib - - An existing instance or null if it wasn't found - - - - Called when no corlib assembly reference was found - - - - - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasConstant coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasFieldMarshal coded token - A or null if is invalid - - - - Resolves a - - A HasDeclSecurity coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasSemantic coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A MemberForwarded coded token - A or null if is invalid - - - - Resolves an - - An Implementation coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A ResolutionScope coded token - A or null if is invalid - - - - Resolves a - - A TypeOrMethodDef> coded token - A or null if is invalid - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a from the blob - - Table of owner - Row ID of owner - Generic parameter context - A new instance or null if there's no field - marshal for this owner. - - - - Reads a CIL method body - - Method parameters - RVA - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Reads a CIL method body - - Method parameters - RVA - Generic parameter context - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Returns the owner type of a field - - The field - The owner type or null if none - - - - Returns the owner type of a method - - The method - The owner type or null if none - - - - Returns the owner type of an event - - The event - The owner type or null if none - - - - Returns the owner type of a property - - The property - The owner type or null if none - - - - Returns the owner type/method of a generic param - - The generic param - The owner type/method or null if none - - - - Returns the owner generic param of a generic param constraint - - The generic param constraint - The owner generic param or null if none - - - - Returns the owner method of a param - - The param - The owner method or null if none - - - - Reads a module - - File rid - The assembly owning the module we should read - A new instance or null if - is invalid or if it's not a .NET module. - - - - Gets a list of all File rids that are .NET modules. Call - to read one of these modules. - - A new instance - - - - Concatenates the inputs and returns the result if it's a valid path - - Base dir - File name - Full path to the file or null if one of the inputs is invalid - - - - Gets the base directory where this .NET module is located on disk - - Base directory or null if unknown or if an error occurred - - - - Creates a instance - - ManifestResource rid - A new instance - - - - Reads a - - Custom attribute rid - A new instance or null if - is invalid - - - - Reads a - - Custom attribute rid - Generic parameter context - A new instance or null if - is invalid - - - - Reads data somewhere in the address space of the image - - RVA of data - Size of data - All the data or null if or - is invalid - - - - Gets the native entry point or 0 if none - - - - - Gets the managed entry point (a Method or a File) or null if none - - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - Generic parameter context - A new instance - - - - Reads a method body - - Method - Method RVA - Method impl attrs - Generic parameter context - A or null if none - - - - Updates with the PDB info (if any) - - Owner method - Method body - Returns originak value - - - - Reads a string from the #US heap - - String token - A non-null string - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the mixed-mode module to a stream. - - Destination stream - - - - Writes the mixed-mode module to a stream. - - Destination stream - Writer options - - - - Reads data from the #Blob. The following columns are returned: - Field.Signature - Method.Signature - MemberRef.Signature - Constant.Value - CustomAttribute.Value - FieldMarshal.NativeType - DeclSecurity.PermissionSet - StandAloneSig.Signature - Property.Type - TypeSpec.Signature - Assembly.PublicKey - AssemblyRef.PublicKeyOrToken - File.HashValue - MethodSpec.Instantiation - - A token - The value in the #Blob or null if is invalid - - - - Module kind - - - - - Console UI module - - - - - Windows GUI module - - - - - DLL module - - - - - Netmodule (it has no assembly manifest) - - - - - A high-level representation of a row in the ModuleRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - From column ModuleRef.Name - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Gets the definition module, i.e., the module which it references, or null - if the module can't be found. - - - - - Gets the definition assembly, i.e., the assembly of the module it references, or - null if the assembly can't be found. - - - - - - - - - - - A ModuleRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Module name - - - - Created from a row in the ModuleRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ModuleRef row - Row ID - If is null - If is invalid - - - - Native types used by field marshals. See CorHdr.h/CorNativeType - - - - Deprecated - - - void - - - bool - - - int8 - - - unsigned int8 - - - int16 - - - unsigned int16 - - - int32 - - - unsigned int32 - - - int64 - - - unsigned int64 - - - float32 - - - float64 - - - syschar - - - variant - - - currency - - - ptr - - - decimal - - - date - - - bstr - - - lpstr - - - lpwstr - - - lptstr - - - fixed sysstring - - - objectref - - - iunknown - - - idispatch - - - struct - - - interface - - - safearray - - - fixed array - - - int - - - uint - - - nested struct - - - byvalstr - - - ansi bstr - - - tbstr - - - variant bool - - - func - - - as any - - - array - - - lpstruct - - - custom marshaler - - - error - - - iinspectable - - - hstring - - - UTF-8 encoded string - - - first invalid element type - - - Value wasn't present in the blob - - - Raw marshal blob type - - - - A resolver that always fails - - - - - The one and only instance of this type - - - - - - - - - - - - - - Parameter flags. See CorHdr.h/CorParamAttr - - - - Param is [In] - - - Param is [out] - - - Param is a locale identifier - - - Param is a return value - - - Param is optional - - - Param has default value. - - - Param has FieldMarshal. - - - - A high-level representation of a row in the Param table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - Gets the declaring method - - - - - - - - From column Param.Flags - - - - Attributes - - - - From column Param.Sequence - - - - - - - - From column Param.Name - - - - Name - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - A Param row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Sequence - - - - Constructor - - Name - Sequence - Flags - - - - Created from a row in the Param table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Param row - Row ID - If is null - If is invalid - - - - A list of all method parameters - - - - - Gets the owner method - - - - - Gets the number of parameters, including a possible hidden 'this' parameter - - - - - Gets the index of the first parameter that is present in the method signature. - If this is a static method, the value is 0, else it's an instance method so the - index is 1 since the first parameter is the hidden 'this' parameter. - - - - - Gets the N'th parameter - - The parameter index - - - - Gets the method return parameter - - - - - Constructor - - The method with all parameters - 's declaring type - - - - Should be called when the method's declaring type has changed - - Method declaring type - - - - Should be called when the method sig has changed - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - A method parameter - - - - - The hidden 'this' parameter's - - - - - The return type parameter's - - - - - Gets the parameter index. If the method has a hidden 'this' parameter, that parameter - has index 0 and the remaining parameters in the method signature start from index 1. - The method return parameter has index -1. - - - - - Gets the index of the parameter in the method signature. See also - and - - - - - true if it's a normal visible method parameter, i.e., it's not the hidden - 'this' parameter and it's not the method return type parameter. - - - - - true if it's the hidden 'this' parameter - - - - - true if it's the method return type parameter - - - - - Gets the parameter type - - - - - Gets the owner method - - - - - Gets the or null if not present - - - - - true if it has a - - - - - Gets the name from . If is null, - an empty string is returned. - - - - - Constructor - - Parameter index - - - - Constructor - - Parameter index - Parameter type - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - Parameter type - - - - Creates a if it doesn't already exist - - - - - - - - Custom debug info guids - - - - - Implements and uses a as the underlying - stream. - - - - - Constructor - - Source stream - - - - Constructor - - Source stream - Name of original file or null if unknown. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - IMAGE_DEBUG_DIRECTORY - - - - - An address in the image - - - - - Section - - - - - Offset in - - - - - Constructor - - Section - Offset in - - - - Constructor - - Section - Offset in - - - - Returns true if is less than or equal to - - First - Second - - - - - Returns true if is less than - - First - Second - - - - - Returns true if is greater than or equal to - - First - Second - - - - - Returns true if is greater than - - First - Second - - - - - Returns true if is equal to - - First - Second - - - - - Returns true if is not equal to - - First - Second - - - - - Compares this instance with and returns less than 0 if it's - less than , 0 if it's equal to and - greater than 0 if it's greater than - - Other instance - - - - - Compares this to another instance - - The other one - true if they're equal - - - - Compares this to another instance - - The other one - true if they're equal - - - - Gets the hash code - - Hash code - - - - ToString() override - - - - - - Reads a 32-bit offset followed by a 16-bit section and creates a new - - Reader - - - - - Exception that is thrown when encounters an error. - - - - - Constructor - - - - - Constructor - - Exception message - - - - Constructor - - Inner exception - - - - Constructor - - - - - - - A managed PDB reader implementation for .NET modules. - - - - - Read the PDB in the specified stream. - - PDB file data reader - - - - Creates a instance - - - - - Creates a new instance - - PDB context - PDB file stream which is now owned by this method - A new instance or null. - - - - A constant in a method scope, eg. "const int SomeConstant = 123;" - - - - - Gets/sets the name - - - - - Gets/sets the type of the constant - - - - - Gets/sets the value of the constant - - - - - Constructor - - - - - Constructor - - Name of constant - Type of constant - Constant value - - - - - - - - - - Gets all custom debug infos - - - - - ToString() - - - - - - Custom debug info kind - - See CustomDebugInfoKind in Roslyn source code - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unknown - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class of custom debug info added to the PDB file by the compiler - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Unknown custom debug info. If you see an instance of this class, you're using an old dnlib version or - dnlib hasn't been updated to support this new custom debug info kind. - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Gets the data - - - - - Constructor - - Custom debug info kind - Raw custom debug info data - - - - Constructor - - Custom debug info guid - Raw custom debug info data - - - - Contains sizes of using groups - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the using counts - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains a reference to another method that contains the import strings - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - Contains a reference to another method that contains the per-module debug info (assembly reference aliases) - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - State machine hosted local scope info - - - - - true if it's a syntesized local ( and are both null) - - - - - The instruction of the first operation in the scope. Can be null if it's a synthesized local - - - - - The instruction of the first operation outside of the scope or null if it ends at the last instruction in the body. - Can also be null if it's a synthesized local (in which case is also null, see ) - - - - - Constructor - - Start of the scope - First instruction after the end of the scope - - - - Contains local scopes for state machine hoisted local variables. - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the scopes - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the state machine type - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the state machine type - - - - - Constructor - - - - - Constructor - - State machine type - - - - Contains dynamic flags for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the dynamic locals - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Dynamic local info - - - - - Gets the dynamic flags - - - - - Gets/sets the name of the local. The name must have at most 64 characters and no char can be NUL (0x0000). - If null is written, is returned instead. - - - - - true if it's a constant and not a variable ( is null) - - - - - true if it's a variable ( is not null) - - - - - Gets/sets the local. Could be null if there's no local (it's a 'const' local). - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the EnC local variable slot map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLocalSlotMap - - - - - Constructor - - Raw custom debug info data - - - - Contains the EnC lambda map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLambdaAndClosureMap - - - - - Constructor - - Raw custom debug info data - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Tuple element name info - - - - - Gets/sets the name of the local. If null is written, is returned instead. - - - - - Gets/sets the local. It's null if it's a constant, and non-null if it's a variable - - - - - true if it's a constant. Constants have a scope ( and ) - - - - - true if it's a variable. Variables don't have a scope ( and ) - - - - - Gets/sets the start of the scope or null. Only constants have a scope. - - - - - Gets/sets the end of the scope or null if it has no scope or if the scope ends at the end of the body. Only constants have a scope. - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Async method stepping info - - It's internal and translated to a - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the catch handler instruction or null - - - - - Gets all async step infos - - - - - Constructor - - - - - Default namespace - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the default namespace - - - - - Constructor - - - - - Constructor - - Default namespace - - - - Dynamic flags - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the dynamic flags - - - - - Constructor - - - - - Constructor - - Dynamic flags - - - - Contains the source code - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source code blob. - - It's not decompressed and converted to a string because the encoding isn't specified. - - https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#embedded-source-c-and-vb-compilers - - - - - Constructor - - - - - Constructor - - Source code blob - - - - Contains the source link file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source link file contents - - - - - Constructor - - - - - Constructor - - Source link file contents - - - - Contains the source server file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source server file contents - - - - - Constructor - - - - - Constructor - - Source server file contents - - - - Async method info - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the starting method that initiates the async operation - - - - - Gets/sets the instruction for the compiler generated catch handler that wraps an async method. - This can be null. - - - - - Gets all step infos used by the debugger - - - - - Constructor - - - - - Constructor - - Default capacity for - - - - Async step info used by debuggers - - - - - The yield instruction - - - - - Resume method - - - - - Resume instruction (where the debugger puts a breakpoint) - - - - - Constructor - - The yield instruction - Resume method - Resume instruction (where the debugger puts a breakpoint) - - - - Iterator method - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the kickoff method - - - - - Constructor - - - - - Constructor - - Kickoff method - - - - A PDB document - - - - - Gets/sets the document URL - - - - - Gets/sets the language GUID. See - - - - - Gets/sets the language vendor GUID. See - - - - - Gets/sets the document type GUID. See - - - - - Gets/sets the checksum algorithm ID. See - - - - - Gets/sets the checksum - - - - - - - - - - - Gets all custom debug infos - - - - - Default constructor - - - - - Constructor - - A instance - - - - Constructor - - Document URL - Language. See - Language vendor. See - Document type. See - Checksum algorithm ID. See - Checksum - - - - - - - - - - PDB document constants - - - - - PDB file kind - - - - - Windows PDB - - - - - Portable PDB - - - - - Embedded portable PDB - - - - - Import scope - - - - - Constructor - - - - - Gets/sets the parent import scope - - - - - Gets all imports - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - Import kind - - - - - PDB import base class - - - - - Gets the import kind - - - - - Import namespace - - - - - Returns - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - Import assembly, namespace - - - - - Returns - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import type - - - - - Returns - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - Import xml namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import assembly reference alias - - - - - Returns - - - - - Gets the alias - - - - - Constructor - - - - - Constructor - - - - - - Alias assembly reference - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Constructor - - - - - Constructor - - - - - - - Alias namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Alias assembly namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - - Alias type - - - - - Returns - - - - - Gets the alias - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - - A local variable - - - - - Constructor - - - - - Constructor - - - - - - - - Gets/sets the local - - - - - Gets/sets the name - - - - - Gets/sets the attributes - - - - - Gets the index of the local - - - - - true if it should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - - - - - - - Gets all custom debug infos - - - - - Local attributes - - - - - No bit is set - - - - - Local should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - A PDB method - - - - - Gets/sets the root scope. It contains all scopes of the method, using namespaces, variables and constants - - - - - Constructor - - - - - PDB reader options - - - - - No bit is set - - - - - Use the COM Windows PDB reader instead of the managed Windows PDB reader. - - This is NOT recommended since the COM reader can only be called on the same - thread it was created on. It also requires a Windows OS. - - If this is not set, the managed PDB reader will be used. - - This option is only used if it's a Windows PDB file, not if it's a Portable PDB file. - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - Only used if is set and if it's a Windows PDB file - - - - - Don't use diasymreader.dll's PDB reader that is shipped with .NET Framework. - - Only used if is set and if it's a Windows PDB file - - - - - A PDB scope - - - - - Constructor - - - - - Gets/sets the first instruction - - - - - Gets/sets the last instruction. It's null if it ends at the end of the method. - - - - - Gets all child scopes - - - - - true if is not empty - - - - - Gets all locals in this scope - - - - - true if is not empty - - - - - Gets all namespaces (Windows PDBs). Portable PDBs use - - - - - true if is not empty - - - - - Gets/sets the import scope (Portable PDBs). Windows PDBs use - - - - - Gets all constants - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - PDB state for a - - - - - Gets/sets the PDB file kind. You can change it from portable PDB to embedded portable PDB - and vice versa. Converting a Windows PDB to a portable PDB isn't supported. - - - - - Gets/sets the user entry point method. - - - - - Gets all PDB documents - - - - - true if is not empty - - - - - Constructor - - Module - PDB file kind - - - - Constructor - - A instance - Owner module - - - - Adds - - New document - if it wasn't inserted, or the already existing document - if it was already inserted. - - - - Removes - - Document - true if it was removed, false if it wasn't inserted. - - - - Returns an inserted instance or null if it's not been - inserted yet. - - A PDB document - The existing or null if it doesn't exist. - - - - Removes all documents - - - - - - Removes all documents and optionally returns them - - true if all the original s - should be returned. - All s if is true - or null if is false. - - - - Constructor - - Module that resolves assembly and type references - Portable PDB blob stream - - - - PDB sequence point - - - - - PDB document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - Clones this instance - - A new cloned instance - - - - Async step info - - - - - Yield offset - - - - - Breakpoint offset - - - - - Breakpoint method token - - - - - Constructor - - Yield offset - Breakpoint offset - Breakpoint method token - - - - A document - - - - - Gets the URL - - - - - Gets the language - - - - - Gets the language vendor - - - - - Gets the document type - - - - - Gets the checksum algorithm id - - - - - Gets the checksum - - - - - Gets the custom debug infos - - - - - A method - - - - - Gets the method token - - - - - Gets the root scope - - - - - Gets all sequence points - - - - - Reads custom debug info - - Method - Method body - Updated with custom debug info - - - - A namespace - - - - - Gets the name - - - - - Reads symbols from a PDB file - - - - - Called by the owner module before any other methods and properties are called - - Owner module - - - - Gets the PDB file kind - - - - - Gets the user entry point token or 0 if none - - - - - Gets all documents - - - - - Gets a method or returns null if the method doesn't exist in the PDB file - - Method - Edit and continue version. The first version is 1 - - - - - Reads custom debug info - - Token of a instance - Generic parameter context - Updated with custom debug info - - - - Cleans up resources - - - - - A scope - - - - - Gets the method - - - - - Gets the parent scope - - - - - Gets the start offset of the scope in the method - - - - - Gets the end offset of the scope in the method - - - - - Gets all child scopes - - - - - Gets all locals defined in this scope - - - - - Gets all namespaces in this scope - - - - - Gets all custom debug infos - - - - - Gets the import scope or null if none - - - - - Gets all the constants - - Owner module if a signature must be read from the #Blob - Generic parameter context - - - - - Sequence point - - - - - IL offset - - - - - Document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - A variable - - - - - Gets the name - - - - - Gets the attributes - - - - - Gets the index of the variable - - - - - Gets all custom debug infos - - - - - Reads custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Reads custom debug info - - Method - The method's body. Needs to be provided by the caller since we're called from - PDB-init code when the Body property hasn't been initialized yet - Place all custom debug info in this list - Custom debug info from the PDB file - - - - Writes custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Returns the raw custom debug info or null if there was an error - - Metadata - Writer context - Method - Custom debug infos to write - - - - - - - - P/Invoke attributes, see CorHdr.h/CorPinvokeMap - - - - Pinvoke is to use the member name as specified. - - - Use this mask to retrieve the CharSet information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Information about target function. Not relevant for fields. - - - - - - Pinvoke will use native callconv appropriate to target windows platform. - - - - - - - - - - - - In M9, pinvoke will raise exception. - - - - - - - Property attributes, see CorHdr.h/CorPropertyAttr - - - - property is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - Property has default - - - - A high-level representation of a row in the Property table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - From column Property.PropFlags - - - - Attributes - - - - From column Property.Name - - - - Name - - - - From column Property.Type - - - - - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the first getter method. Writing null will clear all get methods. - - - - - Gets/sets the first setter method. Writing null will clear all set methods. - - - - - Gets all getter methods - - - - - Gets all setter methods - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - Reset , , - - - - true if there are no methods attached to this property - - - - - - - - true if is not empty - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - Gets/sets the property sig - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the property - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - A Property row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Property signature - - - - Constructor - - Name - Property signature - Flags - - - - Created from a row in the Property table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this Property row - Row ID - If is null - If is invalid - - - - - - - Represents a public key - - - - - Gets the - - - - - - - - Constructor - - - - - Constructor - - Public key data - - - - Constructor - - Public key data as a hex string or the string "null" - to set public key data to null - - - - - - - - - - Public key / public key token base class - - - - - The key data - - - - - Returns true if is null or empty - - - - - Returns true if is null - - - - - Gets/sets key data - - - - - Gets the - - - - - Constructor - - Key data - - - - Constructor - - Key data as a hex string or the string "null" - to set key data to null - - - - Checks whether a public key or token is null or empty - - Public key or token instance - - - - Returns a - - A or a instance - - - - Compares two s as s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Compares two s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Gets the public key token hash code - - Public key or token - The hash code - - - - Gets the public key token hash code - - Public key token - The hash code - - - - Creates a - - Public key data or null - A new instance or null if - was null - - - - Creates a - - Public key token data or null - A new instance or null if - was null - - - - Gets the raw public key / public key token byte array - - The instance or null - Raw public key / public key token data or null - - - - - - - Represents a public key token - - - - - Gets the - - - - - Constructor - - - - - - - - - - - - - - - - - Recursion counter - - - - - Max recursion count. If this is reached, we won't continue, and will use a default value. - - - - - Gets the recursion counter - - - - - Increments if it's not too high. ALL instance methods - that can be called recursively must call this method and - (if this method returns true) - - true if it was incremented and caller can continue, false if - it was not incremented and the caller must return to its caller. - - - - Must be called before returning to caller if - returned true. - - - - - - - - Extension methods for reflection types, methods, fields - - - - - Checks whether it's a - - The type - - - - Gets a 's - - The type - The type's element type - - - - Returns true if is a generic method, but - not a generic method definition, i.e., a MethodSpec. - - The method - - - - Checks whether a parameter/prop/event type should be treated as if it is really a - generic instance type and not a generic type definition. In the .NET metadata (method - sig), the parameter is a generic instance type, but the CLR treats it as if it's just - a generic type def. This seems to happen only if the parameter type is exactly the same - type as the declaring type, eg. a method similar to: MyType<!0> MyType::SomeMethod(). - - Declaring type of method/event/property - Parameter/property/event type - - - - Checks whether is a type definition and not a type spec - (eg. pointer or generic type instantiation) - - this - - - - Resolve exception base class - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if an assembly couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a type couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a method/field couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Resolves types, methods, fields - - - - - true to project WinMD types to CLR types, eg. Windows.UI.Xaml.Interop.TypeName - gets converted to System.Type before trying to resolve the type. This is enabled - by default. - - - - - Constructor - - The assembly resolver - - - - - - - - - - Type of resource - - - - - It's a - - - - - It's a - - - - - It's a - - - - - Resource base class - - - - - - - - - - - Gets/sets the offset of the resource - - - - - Gets/sets the name - - - - - Gets/sets the flags - - - - - Gets the type of resource - - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - Constructor - - Name - flags - - - - A resource that is embedded in a .NET module. This is the most common type of resource. - - - - - Gets the length of the data - - - - - - - - Constructor - - Name of resource - Resource data - Resource flags - - - - Constructor - - Name of resource - Data reader factory - Offset of resource data - Length of resource data - Resource flags - - - - Gets a data reader that can access the resource - - - - - - - - - A reference to a resource in another assembly - - - - - - - - Gets/sets the assembly reference - - - - - Constructor - - Name of resource - Assembly reference - Resource flags - - - - - - - A resource that is stored in a file on disk - - - - - - - - Gets/sets the file - - - - - Gets/sets the hash - - - - - Gets/sets the file name - - - - - Constructor - - Name of resource - The file - Resource flags - - - - - - - A collection of s - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Finds the index of a resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an embedded resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an assembly linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of a linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds a resource - - Name of resource - The or null if none was found - - - - Finds an embedded resource - - Name of resource - The or null if none was found - - - - Finds an assembly linked resource - - Name of resource - The or null if none was found - - - - Finds a linked resource - - Name of resource - The or null if none was found - - - - Built-in resource data - - - - - Gets the data - - - - - - - - - - - - - - Constructor - - Type of data - Data - - - - - - - - - - Implemented by all resource data - - - - - Gets the type of data - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Writes the data - - Writer - Formatter if needed by implementer - - - - Creates resource data - - - - - Gets the owner module - - - - - Constructor - - Owner module - - - - Gets number of user data types - - - - - Create null data - - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates array data - - Value - - - - - Creates data - - Value - - - - - Creates serialized data - - Serialized data - Type of serialized data - - - - - Creates serialized data - - Serialized data - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - Use without converting it to a - type in an existing assembly reference - - - - - Converts an assembly simple name (eg. mscorlib) to the full name of the assembly, - which includes the version, public key token, etc. Returns null if it's - unknown. - - Simple name of assembly - - - - - Gets all types sorted by - - - - - - Resource element - - - - - Name of resource - - - - - Data of resource - - - - - - - - Resource element set - - - - - Gets the number of elements in the set - - - - - Gets all resource elements - - - - - Adds a new resource to the set, overwriting any existing resource - - - - - - Thrown by - - - - - Constructor - - - - - Constructor - - Message - - - - Constructor - - - - - - - Gets called to create a from serialized data. Returns null - if a default instance should be created. - - ResourceDataFactory - Serialized type - Serialized data - - - - - Reads .NET resources - - - - - Returns true if it's possibly resources file data - - Reader - - - - - Reads a .NET resource - - Owner module - Data of resource - - - - - Reads a .NET resource - - Owner module - Data of resource - Call back that gets called to create a instance. Can be null. - - - - - Type of resource - - - - - null - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - array - - - - - - - - - - Start of user types - - - - - Writes .NET resources - - - - - Write .NET resources - - Owner module - Output stream - .NET resources - - - - Base class of all user data - - - - - Full name including assembly of type - - - - - User type code - - - - - - - - - - - Constructor - - User resource type - - - - - - - Binary data - - - - - Gets the raw data - - - - - Constructor - - User resource type - Raw serialized data - - - - - - - - - - User resource type - - - - - Full name including assembly of type - - - - - User type code - - - - - Constructor - - Full name including assembly of type - User type code - - - - - - - Security action. See CorHdr.h/CorDeclSecurity - - - - Mask allows growth of enum. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Persisted grant set at prejit time - - - Persisted grant set at prejit time - - - Persisted denied set at prejit time - - - Persisted denied set at prejit time - - - - - - - - - - - - Maximum legal value - - - - A DeclSecurity security attribute - - - - - Gets/sets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Creates a from an XML string. - - Owner module - XML - A new instance - - - - Default constructor - - - - - Constructor - - Attribute type - - - - Constructor - - Attribute type - Named arguments that will be owned by this instance - - - - - - - See CorSerializationType/CorHdr.h - - - - - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Single-dimension, zero lower bound array ([]) - - - System.Type - - - Boxed value type - - - A field - - - A property - - - An enum - - - - Compares types - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares fields - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - Compares methods - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares properties - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares events - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares calling convention signatures - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Decides how to compare types, sigs, etc - - - - - Don't compare a type's (assembly/module) scope - - - - - Compares a method/field's declaring type. - - - - - Compares a property's declaring type - - - - - Compares an event's declaring type - - - - - Compares method / field / property / event declaring types - - - - - Compares parameters after a sentinel in method sigs. Should not be enabled when - comparing s against s since it's - not possible to get those sentinel params from a . - - - - - Compares assembly public key token - - - - - Compares assembly version - - - - - Compares assembly locale - - - - - If set, a and an can reference the - global <Module> type. - - - - - Don't compare a method/property's return type - - - - - Type namespaces are case insensitive - - - - - Type names (not namespaces) are case insensitive - - - - - Type names and namespaces are case insensitive - - - - - Method and field names are case insensitive - - - - - Property names are case insensitive - - - - - Event names are case insensitive - - - - - Type namespaces, type names, method names, field names, property names - and event names are all case insensitive - - - - - A field that is can compare equal to - a - - - - - A method that is can compare equal to - a - - - - - A field that is and a method that is - can compare equal to a - - - - - Raw (bit by bit) comparison of signatures. This matches what the CLR does when it - compares signatures. This means that metadata tokens will be compared. - - - - - Ignore required and optional modifiers when comparing s. - They're already ignored when comparing eg. a with a - . - - - - - By default, all module and assembly compares when they're both the system library - (eg. mscorlib or System.Runtime.dll) return true, even if they're really different, - eg. mscorlib (.NET 2.0) vs mscorlib (Windows CE). If this flag is set, the system - library is compared just like any other module/assembly. - - - - - Don't project CLR compatible WinMD references back to the original CLR type/method before comparing - - - - - Don't check type equivalence when comparing types. Starting with .NET 4.0, two different - types can be considered equivalent if eg. a TypeIdentifierAttribute is used. - - - - - When comparing types, don't compare a multi-dimensional array's lower bounds and sizes - - - - - Compares types, signatures, methods, fields, properties, events - - - - - Constructor - - Comparison options - - - - Constructor - - Comparison options - The module which the comparison take place in. - - - - is mapped to , so use - the same hash code for both - - - - - Compare members - - Member #1 - Member #2 - true if same, false otherwise - - - - Gets the hash code of a member - - The member - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares resolution scopes - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares resolution scope and implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares files - - File #1 - File #2 - true if same, false otherwise - - - - Compares a module with a file - - Module - File - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Compares signatures - - Sig #1 - Sig #2 - true if same, false otherwise - - - - Gets the hash code of a sig - - The sig - The hash code - - - - Compares method/property sigs - - Method/property #1 - Method/property #2 - true if same, false otherwise - - - - Gets the hash code of a method/property sig - - The method/property sig - The hash code - - - - Compares field sigs - - Field sig #1 - Field sig #2 - true if same, false otherwise - - - - Gets the hash code of a field sig - - The field sig - The hash code - - - - Compares local sigs - - Local sig #1 - Local sig #2 - true if same, false otherwise - - - - Gets the hash code of a local sig - - The local sig - The hash code - - - - Compares generic method instance sigs - - Generic inst method #1 - Generic inst method #2 - true if same, false otherwise - - - - Gets the hash code of a generic instance method sig - - The generic inst method sig - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares MemberRefs - - MemberRef #1 - MemberRef #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRef - - The MemberRef - The hash code - - - - Compares MethodSpecs - - MethodSpec #1 - MethodSpec #2 - true if same, false otherwise - - - - Gets the hash code of a MethodSpec - - The MethodSpec - The hash code - - - - Compares MemberRefParents - - MemberRefParent #1 - MemberRefParent #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRefParent - - The MemberRefParent - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Checks whether it's FnPtr&, FnPtr*, FnPtr[], or FnPtr[...] - - The type - - - - Compares types - - Type #1 - Type #2 - true if we should treat - as a generic instance type - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Gets the hash code of a type - - The type - true if we should treat - as a generic instance type - The hash code - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Gets the hash code of a list with only generic method parameters () - - Number of generic method parameters - Hash code - - - - Gets the hash code of a TypeDef type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares a file and a module - - File - Module - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares method declaring types - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares generic method args, making sure only - contains s. - - Number of generic method args in method #1 - Generic method args in method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a MethodBase - - The MethodBase - The hash code - - - - Gets the hash code of a parameter list - - The type list - Declaring type of method that owns parameter - The hash code - - - - Compares calling conventions - - Calling convention - Method - - - - - Compares return types - - Return type #1 - MethodBase - true if same, false otherwise - - - - Compares parameter lists - - Type list #1 - Type list #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares parameter types - - Parameter type #1 - Parameter #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - - - - Helps resolve types - - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if - is invalid - - - - Converts the address of a to a - - - Address of . This is also known as the - method table and has the same value as - A or null if not supported - - - - Reads signatures from the #Blob stream - - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Constructor - - Reader module - #Blob stream offset of signature - Generic parameter context - - - - Constructor - - Token resolver - A instance - The signature data - Generic parameter context - - - - Reads the signature - - A new instance or null if invalid signature - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads the next type - - A new instance or null if invalid element type - - - - A high-level representation of a row in the StandAloneSig table - - - - - The row id in its table - - - - - - - - - - - - - - From column StandAloneSig.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the method sig - - - - - Gets/sets the locals sig - - - - - - - - A StandAloneSig row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A locals sig - - - - Constructor - - A method sig - - - - Created from a row in the StandAloneSig table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this StandAloneSig row - Row ID - Generic parameter context - If is null - If is invalid - - - - Thrown if the strong name key or public key is invalid - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Type of signature algorithm. See WinCrypt.h in the Windows SDK - - - - - RSA signature algorithm - - - - - A public key - - - - - Gets/sets the signature algorithm - - - - - Gets/sets the hash algorithm - - - - - Gets/sets the modulus - - - - - Gets/sets the public exponent - - - - - Default constructor - - - - - Constructor - - Modulus - Public exponent - - - - Constructor - - Modulus - Public exponent - Hash algorithm - - - - Constructor - - Modulus - Public exponent - Hash algorithm - Signature algorithm - - - - Constructor - - Public key - - - - Constructor - - Public key data - Strong name key is invalid - - - - Constructor - - Public key file - Strong name key is invalid - - - - Constructor - - Public key stream - Strong name key is invalid - - - - Constructor - - Public key reader - Strong name key is invalid - - - - Creates a public key blob - - - - - - - - Stores a strong name key pair - - - - - Gets the public key - - - - - Gets the strong name signature size in bytes - - - - - Gets the public key hash algorithm. It's usually - - - - - Gets the public exponent - - - - - Gets the modulus - - - - - Gets prime1 - - - - - Gets prime2 - - - - - Gets exponent1 - - - - - Gets exponent2 - - - - - Gets the coefficient - - - - - Gets the private exponent - - - - - Constructor - - Strong name key data - Strong name key is invalid - - - - Constructor - - Strong name key file - Strong name key is invalid - - - - Constructor - - Strong name key stream - Strong name key is invalid - - - - Constructor - - Strong name key reader - Strong name key is invalid - - - - Creates a strong name key with a new hash algorithm - - Algorithm - - - - - Creates an instance - - - - - Creates a strong name blob - - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature as a hex string - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature - - - - Strong name signs an assembly. It supports normal strong name signing and the new - (.NET 4.5) enhanced strong name signing. - - - - - Constructor - - .NET PE file stream - - - - Constructor - - .NET PE file stream - Offset in of the first byte of - the PE file. - - - - Calculates the strong name signature and writes it to the stream. The signature - is also returned. - - Strong name key used for signing - Offset (relative to the start of the PE file) of the strong - name signature. - The strong name signature - - - - Calculates and returns the strong name signature - - Strong name key used for signing - Offset (relative to start of PE file) of the strong - name signature. - The strong name signature - - - - Strong name hashes the .NET file - - Hash algorithm - Strong name sig offset (relative to start of .NET PE file) - Size of strong name signature - The strong name hash of the .NET file - - - - Returns the strong name signature - - Strong name key - Hash algorithm - Strong name hash of the .NET PE file - Strong name signature - - - - System.Runtime.InteropServices.TypeIdentifierAttribute helper code used by - - - - - TypeDef and ExportedType flags. See CorHdr.h/CorTypeAttr - - - - Use this mask to retrieve the type visibility information. - - - Class is not public scope. - - - Class is public scope. - - - Class is nested with public visibility. - - - Class is nested with private visibility. - - - Class is nested with family visibility. - - - Class is nested with assembly visibility. - - - Class is nested with family and assembly visibility. - - - Class is nested with family or assembly visibility. - - - Use this mask to retrieve class layout information - - - Class fields are auto-laid out - - - Class fields are laid out sequentially - - - Layout is supplied explicitly - - - Use this mask to retrieve class semantics information. - - - Use this mask to retrieve class semantics information. - - - Type is a class. - - - Type is an interface. - - - Class is abstract - - - Class is concrete and may not be extended - - - Class name is special. Name describes how. - - - Class / interface is imported - - - The class is Serializable. - - - The type is a Windows Runtime type - - - Use StringFormatMask to retrieve string information for native interop - - - LPTSTR is interpreted as ANSI in this class - - - LPTSTR is interpreted as UNICODE - - - LPTSTR is interpreted automatically - - - A non-standard encoding specified by CustomFormatMask - - - Use this mask to retrieve non-standard encoding information for native interop. The meaning of the values of these 2 bits is unspecified. - - - Initialize the class any time before first static field access. - - - This ExportedType is a type forwarder. - - - Flags reserved for runtime use. - - - Runtime should check name encoding. - - - Class has security associate with it. - - - - A high-level representation of a row in the TypeDef table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - Gets/sets the owner module - - - - - - - - - - Called to initialize - - - - From column TypeDef.Flags - - - - Attributes - - - - From column TypeDef.Name - - - - Name - - - - From column TypeDef.Namespace - - - - Name - - - - From column TypeDef.Extends - - - - - - - - - - Called to initialize - - - Reset - - - - From column TypeDef.FieldList - - - - - - - Initializes - - - - From column TypeDef.MethodList - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets the interfaces - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets/sets the class layout - - - - - - - - - - Called to initialize - - - - - - - Gets/sets the enclosing type. It's null if this isn't a nested class. - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - Called to initialize - - - - Gets all the nested types - - - - - - - Initializes - - - - Gets all events - - - - - - - Initializes - - - - Gets all properties - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets/sets the packing size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - Gets/sets the class size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - - - - true if it's an enum - - - - - true if it's a delegate (it derives from ) - - - - - true if this is a nested type (it has a declaring type) - - - - - - - - Checks whether this type has opted into equivalence - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the global (aka. <Module>) type - - - - - Gets a list of all nested types and all their nested types - - - - - Gets an enum's underlying type or null if none. Should only be called - if this is an enum. - - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. Private scope methods/fields are not returned. - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. - - A method/field reference - Method/field signature comparison options - A or a instance or null - if it couldn't be resolved. - - - - Finds a method. Private scope methods are not returned. - - Method name - Method signature - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The first method that matches or null if none found - - - - Finds a method by name - - Name of method - The or null if not found - - - - Finds all methods by name - - Name of method - All methods with that name - - - - Finds the class constructor (aka type initializer). It's the method named .cctor - - The class constructor or null if none found - - - - Finds the class constructor (aka type initializer). It's the method named .cctor. - If it doesn't exist, it is created, inserted into and returned. - The created .cctor will have just one RET instruction. - - The class constructor - - - - Finds all instance constructors (not class constructors) - - All instance constructors - - - - Finds all static and instance constructors - - All static and instance constructors - - - - Finds the default instance constructor (the one with no arguments) - - The default instance constructor or null if none - - - - Finds a field. Private scope fields are not returned. - - Field name - Field signature - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The first field that matches or null if none found - - - - Finds a field by name - - Name of field - The or null if not found - - - - Finds all fields by name - - Name of field - All fields with that name - - - - Finds an event - - Name of event - Type of event - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - The module that needs to find the event or null - A or null if not found - - - - Finds an event by name - - Name of event - The or null if not found - - - - Finds all events by name - - Name of event - All events with that name - - - - Finds a property - - Name of property - Property signature - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - The module that needs to find the property or null - A or null if not found - - - - Finds a prop by name - - Name of prop - The or null if not found - - - - Finds all props by name - - Name of prop - All props with that name - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - The method or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - The field or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - Event type - The event or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - The event or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The module that needs to find the property or null - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - The property or null if it wasn't found - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - true if we should remove all - empty properties and events. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets all fields named - - Field name - A list of 0 or more fields with name - - - - Gets the first field named - - Field name - The field or null if none found - - - - FInd a method implementation method - - Method - - - - - - - - A TypeDef row created by the user and not present in the original .NET file - - - - - Constructor - - Name - - - - Constructor - - Namespace - Name - - - - Constructor - - Name - Base class or null if it's an interface - - - - Constructor - - Namespace - Name - Base class or null if it's an interface - - - - Created from a row in the TypeDef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeDef row - Row ID - If is null - If is invalid - - - - Gets all methods overrides - - The method - Generic parameter context - A list (possibly empty) of all methods overrides - - - - Initializes all . Only those s - that are property or event handlers get updated. - - - - - Initializes a property's special methods - - The property - Updated with a list of all get methods - Updated with a list of all set methods - Updated with a list of all other methods - - - - Initializes an event's special methods - - The event - Updated with the addOn method or null if none - Updated with the fire method or null if none - Updated with the removeOn method or null if none - Updated with a list of all other methods - - - - - - - - - - - - - - - - - - - Finds s - - - - - true if the cache is enabled. false if the cache - is disabled and a slower O(n) lookup is performed. - - - - - Constructor - - All root types. All their nested types are also included. - If is null - - - - Constructor - - All root types - true if all nested types that are reachable - from should also be included. - If is null - - - - Resets the cache (clears all cached elements). Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - - - - - - - Gets the next or null if there are no more left - - The next or null if none - - - - Gets the next or null if there are no more left. - The cache is updated with the returned before the method - returns. - - The next or null if none - - - - - - - Various helper methods for classes to prevent infinite recursion - - - - - Checks whether contains a or a - . - - Calling convention signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Field signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Method or property signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Local signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Generic method signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Thrown by when it fails to parse a type name - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Helps create types - - - - - Finds a 's when the original assembly - info is missing from the full type name. - - A non-nested - 's or null - - - - Parses a type name and creates an - - - - Owner module - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Increment recursion counter - - If this method has been called too many times - - - - Decrement recursion counter - - - - - - - - Dispose method - - true if called by - - - - Reads a including any possible nested s. - - Character separating nested types - A new instance, which could be nested. - - - - Reads a namespace and name and creates a TypeRef. Does not read any nested types. - - A new instance - - - - Peeks the next char. -1 if no more chars. - - - - - Gets the next char or -1 if no more chars - - - - - Gets the next ID char or -1 if no more ID chars - - true if white space should be ignored - - - - Parses reflection type names. Grammar http://msdn.microsoft.com/en-us/library/yfsftwz6.aspx - - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses an assembly name - - Full assembly name - A new instance or null if parsing failed - - - - Parses an assembly name - - Full assembly name - Generic parameter context - A new instance or null if parsing failed - - - - - - - A high-level representation of a row in the TypeRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - From column TypeRef.ResolutionScope - - - - - - - - - - Called to initialize - - - - From column TypeRef.Name - - - - Name - - - - From column TypeRef.Namespace - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if it's nested within another - - - - - - - - - - - Gets the declaring type, if any - - - - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Gets the top-most (non-nested) - - Input - The non-nested or null - - - - - - - A TypeRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - Type name - - - - Constructor - - Owner module - Type namespace - Type name - - - - Constructor - - Owner module - Type namespace - Type name - Resolution scope (a , - , or ) - - - - Created from a row in the TypeRef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeRef row - Row ID - If is null - If is invalid - - - - Type sig base class - - - - - Returns the wrapped element type. Can only be null if it was an invalid sig or - if it's a - - - - - Gets the element type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a or a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if this contains a or a - . - - - - - - - - Base class for element types that are last in a type sig, ie., - , , , - , - - - - - - - - Wraps a - - - - - Gets the the TypeDefOrRef - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Constructor - - A , or - a - - - - A core library type - - - - - Gets the element type - - - - - Constructor - - The type which must be a or a - . and null are not allowed. - The type's element type - - - - Base class for class/valuetype element types - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Generic method/type var base class - - - - - true if it has an owner or - - - - - true if it has an owner ( is - not null) - - - - - true if it has an owner ( is - not null) - - - - - Gets the owner type or null if the owner is a or if it - has no owner. - - - - - Gets the owner method or null if the owner is a or if it - has no owner. - - - - - Gets the generic param number - - - - - Gets the corresponding or null if none exists. - - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - Owner method/type or null - - - - Returns true if it's a MVar element type - - - - - Returns true if it's a Var element type - - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner type or null - - - - Constructor - - Generic parameter number - Owner type or null - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner method or null - - - - Constructor - - Generic parameter number - Owner method or null - - - - Represents a - - - - - - - - Represents a - - - - - - - - Gets the signature - - - - - Gets the - - - - - Constructor - - The method signature - - - - Represents a - - - - - - - - Gets the generic type - - - - - Gets the generic arguments (it's never null) - - - - - Default constructor - - - - - Constructor - - The generic type - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Generic argument #1 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - Generic argument #3 - - - - Constructor - - The generic type - Generic arguments - - - - Constructor - - The generic type - Generic arguments - - - - Base class of non-leaf element types - - - - - - - - Constructor - - Next sig - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Array base class - - - - - Constructor - - Array type - - - - true if it's a multi-dimensional array (i.e., ), - and false if it's a single-dimensional array (i.e., ) - - - - - - true if it's a single-dimensional array (i.e., ), - and false if it's a multi-dimensional array (i.e., ) - - - - - - Gets/sets the rank (number of dimensions). This can only be set if - is true - - - - - Gets all sizes. If it's a , then it will be an empty temporary - list that is re-created every time this method is called. - - A list of sizes - - - - Gets all lower bounds. If it's a , then it will be an empty - temporary list that is re-created every time this method is called. - - A list of lower bounds - - - - Represents a - - - - - - - - - Gets/sets the rank (max value is 0x1FFFFFFF) - - - - - Gets all sizes (max elements is 0x1FFFFFFF) - - - - - Gets all lower bounds (max elements is 0x1FFFFFFF) - - - - - Constructor - - Array type - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - - - - - - - Represents a (single dimension, zero lower bound array) - - - - - - - - - - - - Constructor - - The next element type - - - - - - - - - - Base class for modifier type sigs - - - - - Returns the modifier type - - - - - Constructor - - Modifier type - The next element type - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Gets/sets the size - - - - - Constructor - - The next element type - Size of the array - - - - Represents a - - - - - - - - Gets/sets the index - - - - - Constructor - - Index - The next element type - - - - A high-level representation of a row in the TypeSpec table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column TypeSpec.Signature - - - - - Gets/sets the extra data that was found after the signature - - - - - - - - - - - - - Called to initialize - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - A TypeSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A type sig - - - - Created from a row in the TypeSpec table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - Compares s - - - - - The default instance - - - - - - - - - - - A UTF-8 encoded string where the original data is kept in memory to avoid conversions - when the data is not really valid UTF-8 encoded data - - When comparing strings, a byte compare is performed. The reason is that this - is what the CLR does when comparing strings in the #Strings stream. - - - - An empty - - - - - Gets the value as a UTF8 decoded string. Only use it for display purposes, - not for serialization. - - - - - Gets the original encoded data. Don't modify this data. - - - - - Gets the length of the this as a . I.e., it's the same as - String.Length. - - - - - - Gets the length of the raw data. It's the same as Data.Length - - - - - - Checks whether is null or if its data is null. - - The instance to check - true if null or empty, false otherwise - - - - Checks whether is null or if its data is null or the - data is zero length. - - The instance to check - true if null or empty, false otherwise - - - Implicit conversion from to - - - Implicit conversion from to - - - - Converts it to a - - The UTF-8 string instace or null - A or null if is null - - - - Converts it to a or an empty string if is null - - The UTF-8 string instace or null - A (never null) - - - - Gets the hash code of a - - Input - - - - - - - Compares two instances (case sensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - true if equals, false otherwise - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - Constructor - - UTF-8 data that this instance now owns - - - - Constructor - - The string - - - - Compares two instances - - First - Second - true if equals, false otherwise - - - - - - - - - - Checks whether exists in this string - - Value to find - true if exists in string or is the - empty string, else false - - - - Checks whether matches the end of this string - - Value - - - - - Checks whether matches the end of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the end of this string - - Value - Comparison type - - - - - Checks whether matches the beginning of this string - - Value - - - - - Checks whether matches the beginning of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the beginning of this string - - Value - Comparison type - - - - - Compares this instance with - - Other string - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Returns the index of the first character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Returns the index of the last character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Inserts string at a index - - Start index - Value to insert - A new instance with the inserted at position - - - - - Removes all characters starting from position - - Start index - A new instance - - - - Removes characters starting from position - - - Start index - Number of characters to remove - A new instance - - - - Replaces all characters with - - Character to find - Character to replace all - A new instance - - - - Replaces all sub strings with - - Sub string to find - Sub string to replace all - A new instance - - - - Returns a sub string of this string starting at offset - - Start index - A new instance - - - - Returns a sub string of this string starting at offset . - Length of sub string is . - - Start index - Length of sub string - A new instance - - - - Returns the lower case version of this string - - A new instance - - - - Returns the lower case version of this string - - Culture info - A new instance - - - - Returns the lower case version of this string using the invariant culture - - A new instance - - - - Returns the upper case version of this string - - A new instance - - - - Returns the upper case version of this string - - Culture info - A new instance - - - - Returns the upper case version of this string using the invariant culture - - A new instance - - - - Removes all leading and trailing whitespace characters - - A new instance - - - - - - - - - - Compares byte arrays - - - - - Default instance - - - - - - - - - - - Returns an assembly name string - - Simple assembly name - Version or null - Culture or null - Public key / public key token or null - Assembly attributes - An assembly name string - - - - Convert a byte[] to a - - All bytes - true if output should be in upper case hex - as a hex string - - - - Converts a hex string to a byte[] - - A string with an even number of hex characters - converted to a byte[] or null - if is invalid - - - - Converts a character to a hex digit - - Hex character - 0x00-0x0F if successful, -1 if is not - a valid hex digit - - - - Compares two byte arrays - - Byte array #1 - Byte array #2 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two byte arrays are equal - - First - Second - true if same, false otherwise - - - - Gets the hash code of a byte array - - Byte array - The hash code - - - - Compares two versions - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two versions are the same - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - true if same, false otherwise - - - - Creates a new instance with no undefined version values (eg. - the build and revision values won't be -1). - - A instance - A new instance - - - - Parses a version string - - Version string - A new or null if - is an invalid version - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Gets the hash code of a locale - - Value - The hash code - - - - Align up - - Value - Alignment - - - - Align up - - Value - Alignment - - - - Variant type (VT_XXX in the Windows SDK) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This wasn't present in the blob - - - - All native vtables - - - - - Gets/sets the RVA of the vtable fixups - - - - - Gets all s - - - - - Default constructor - - - - - Constructor - - Module - - - - - - - - - - See COR_VTABLE_XXX in CorHdr.h - - - - - 32-bit vtable slots - - - - - 64-bit vtable slots - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - One VTable accessed by native code - - - - - Gets/sets the of this vtable - - - - - Gets/sets the flags - - - - - true if each vtable slot is 32 bits in size - - - - - true if each vtable slot is 64 bits in size - - - - - Gets the vtable methods - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - RVA of this vtable - Flgas - Number of methods in vtable - - - - Constructor - - RVA of this vtable - Flgas - Vtable methods - - - - - - - - - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD member reference to a CLR member reference. Returns - null if it's not a CLR compatible WinMD member reference. - - Owner module or null - Member reference - - - - - Converts WinMD method to a CLR member reference. Returns - null if it's not a CLR compatible WinMD method - - Owner module or null - Method - - - - - WinMD status - - - - - This is not a WinMD file - - - - - This is a pure WinMD file (not managed) - - - - - This is a managed WinMD file (created by eg. winmdexp.exe) - - - - - Writes data - - - - - Gets the current position - - - - - Constructor - - Destination array - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes - - - - Writes bytes - - Bytes - Source index - Number of bytes to write - - - - #Blob heap - - - - - - - - Populates blobs from an existing (eg. to preserve - blob offsets) - - The #Blob stream with the original content - - - - Adds data to the #Blob heap - - The data - The offset of the data in the #Blob heap - - - - Adds data to the #Blob heap, but does not re-use an existing position - - The data - The offset of the data in the #Blob heap - - - - - - - - - - - - - - - - - - - Stores a byte array - - - - - - - - - - - Gets the data - - - - - Constructor - - The data. It will be owned by this instance and can't be modified by - other code if this instance is inserted as a key in a dictionary (because - return value will be different if you modify the array). If - it's never inserted as a key in a dictionary, then the contents can be modified, - but shouldn't be resized after has been called. - - - - - - - - - - - - - - - - - - - - - - Checksum algorithm - - - - - SHA-1 - - - - - SHA-256 - - - - - SHA-384 - - - - - SHA-512 - - - - - Contains a list of s - - - - - Default constructor - - - - - Add a - - The chunk to add or null if none - Chunk alignment - - - - Remove a - - The chunk to remove or null if none - Alignment of the chunk, or null if the chunk cannot be removed. - - - - Base class of chunk list types - - Chunk type - - - All chunks - - - true if has been called - - - - Helper struct - - - - Data - - - Alignment - - - - Constructor - - Chunk - Alignment - - - - Equality comparer for - - - - - Constructor - - Compares the chunk type - - - - - - - - - - - - - - - - - - - - - - - - - - - - Helps write custom attributes - - - - - Writes s - - - - - Writes a custom attribute - - Helper class - The custom attribute - Custom attribute blob - - - - Writes custom attribute named arguments - - Helper class - Named arguments - The named args blob - - - - Write a value - - The ctor arg type, field type, or property type - The value to write - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - - - - A chunk - - - - - - - - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Gets the data reader - - - - - Replaces the old data with new data. The new data must be the same size as the old data if - has been called. That method gets called after - event - - - - - - - - - - - - - - - - - - Copies existing data to a new metadata heap - - - - - Gets the name of the heap - - - - - Constructor - - The stream whose data will be copied to the new metadata file - - - - Constructor - - Heap name - Heap content - - - - - - - - - - Writes data - - - - - Gets/sets the position - - - - - Constructor - - Destination stream - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes to write - - - - Writes bytes - - Bytes to write - Index to start copying from - Number of bytes to copy - - - - Writes a compressed - - Value - - - - Writes a compressed - - - - - - Gets the size of a compressed , see - - Value - - - - - Debug directory entry - - - - - Gets the header - - - - - Gets the data - - - - - Constructor - - Data - - - - Debug directory chunk - - - - Default debug directory alignment - - - - - - - - - - Constructor - - - - - Adds data - - Data - - - - - Adds data - - Data - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - - - - - - - - - - - - - Writes DeclSecurity blobs - - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - A DeclSecurity blob - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A DeclSecurity blob - - - - Extension methods - - - - - Write zeros - - this - Number of zeros - - - - Writes all data to and verifies that all bytes were written - - this - Destination - Not all bytes were written - - - - Writes a data directory - - Writer - The data - - - - #GUID heap - - - - - - - - Adds a guid to the #GUID heap - - The guid - The index of the guid in the #GUID heap - - - - - - - - - - - - - - - - - - - Base class of most heaps - - - - - true if has been called - - - - - - - - - - - - - - - - - true if offsets require 4 bytes instead of 2 bytes. - - - - - - - - - - - - - - - - - Gets the raw length of the heap - - Raw length of the heap - - - - - - - Writes all data to at its current location. - - Destination - - - - - - - Data that gets written to the file - - - - - Gets the file offset. This is valid only after has been called. - - - - - Gets the RVA. This is valid only after has been called. - - - - - Called when the file offset and RVA are known - - File offset of this chunk - RVA of this chunk - - - - Gets the raw file length of this chunk. Must only be called after - has been called. - - Length of this chunk - - - - Gets the virtual size of this chunk. Must only be called after - has been called. - - Virtual size of this chunk - - - - Writes all data to at its current location. It's only - called after and have been called. - You cannot assume that 's file position is the same as this - chunk's file position. - - Destination - - - - Implemented by s that can reuse the old data location in the original PE file - - - - - Returns true if this chunk fits in the old location - - Original RVA of data - Size of the original location - - - - - .NET Heap interface - - - - - Gets the name of the heap - - - - - Checks whether the heap is empty - - - - - Called when the heap should be set to read-only mode - - - - - Options to - - - - - Default major runtime version - - - - - Default minor runtime version - - - - - Major runtime version - - - - - Minor runtime version - - - - - Flags - - - - - Entry point or null. Either a Method/File token or an RVA. - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Major runtime version (default is ) - Minor runtime version (default is ) - Flags - - - - .NET header - - - - - Gets/sets the - - - - - Gets/sets the .NET resources - - - - - Gets/sets the strong name signature - - - - - - - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Import address table chunk - - - - - Gets/sets the - - - - - - - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Import directory chunk - - - - - Gets/sets the - - - - - Gets the RVA of _CorDllMain/_CorExeMain in the import lookup table - - - - - Gets RVA of _CorExeMain/_CorDllMain in the IAT - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets/sets the name of the dll which should be imported. - - - - - Gets/sets the name of the entry point of the imported dll. - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Interface to get and set raw heap data. Implemented by the offset heaps: #Strings, - #GUID, #Blob, and #US. - - Type of cooked data - - - - Gets the size of the data as raw data when written to the heap - - The data - Size of the data as raw data when written to the heap - - - - Overrides what value should be written to the heap. - - Offset of value. Must match an offset returned by - - The new raw data. The size must match the raw size exactly. - - - - Gets all inserted raw data and their offsets. The returned array - is owned by the caller. - - An enumerable of all raw data and their offsets - - - - Gets notified of errors. The default handler should normally throw since the written data - will probably be invalid. Any error can be ignored. - - - - - Called when an error is detected (eg. a null pointer or other invalid value). The error - can be ignored but the written data won't be valid. - - Error message - - - - Writes the .sdata blob. We could write the data in any order, but we write the data in the same order as ILASM - - PE timestamp - - - - Writes field marshal blobs - - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - A field marshal blob or null if is - null - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A field marshal blob or null if is - null - - - - - - - Calculates max stack usage by using a simple pass over all instructions. This value - can be placed in the fat method header's MaxStack field. - - - - - Gets max stack value - - All instructions - All exception handlers - Max stack value - - - - Gets max stack value - - All instructions - All exception handlers - Updated with max stack value - true if no errors were detected, false otherwise - - - - MD table interface - - - - - Gets the table type - - - - - true if the table is empty - - - - - Gets the number of rows in this table - - - - - Gets/sets a value indicating whether it's sorted - - - - - true if has been called - - - - - Gets/sets the - - - - - Called when the table can't be modified any more - - - - - Creates rows in a table. Rows can optionally be shared to create a compact table. - - The raw row type - - - - - - - - - - - - - - - - - - - - - - Gets the value with rid - - The row ID - - - - Constructor - - The table type - Equality comparer - - - - - - - Adds a row. If the row already exists, returns a rid to the existing one, else - it's created and a new rid is returned. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Creates a new row even if this row already exists. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Re-adds all added rows. Should be called if rows have been modified after being - inserted. - - - - - Reset the table. - - - - - Writes s - - - - - Writes a Module table - - Writer - Metadata - Table - - - - Writes a TypeRef table - - Writer - Metadata - Table - - - - Writes a TypeDef table - - Writer - Metadata - Table - - - - Writes a FieldPtr table - - Writer - Metadata - Table - - - - Writes a Field table - - Writer - Metadata - Table - - - - Writes a MethodPtr table - - Writer - Metadata - Table - - - - Writes a Method table - - Writer - Metadata - Table - - - - Writes a ParamPtr table - - Writer - Metadata - Table - - - - Writes a Param table - - Writer - Metadata - Table - - - - Writes a InterfaceImpl table - - Writer - Metadata - Table - - - - Writes a MemberRef table - - Writer - Metadata - Table - - - - Writes a Constant table - - Writer - Metadata - Table - - - - Writes a CustomAttribute table - - Writer - Metadata - Table - - - - Writes a FieldMarshal table - - Writer - Metadata - Table - - - - Writes a DeclSecurity table - - Writer - Metadata - Table - - - - Writes a ClassLayout table - - Writer - Metadata - Table - - - - Writes a FieldLayout table - - Writer - Metadata - Table - - - - Writes a StandAloneSig table - - Writer - Metadata - Table - - - - Writes a EventMap table - - Writer - Metadata - Table - - - - Writes a EventPtr table - - Writer - Metadata - Table - - - - Writes a Event table - - Writer - Metadata - Table - - - - Writes a PropertyMap table - - Writer - Metadata - Table - - - - Writes a PropertyPtr table - - Writer - Metadata - Table - - - - Writes a Property table - - Writer - Metadata - Table - - - - Writes a MethodSemantics table - - Writer - Metadata - Table - - - - Writes a MethodImpl table - - Writer - Metadata - Table - - - - Writes a ModuleRef table - - Writer - Metadata - Table - - - - Writes a TypeSpec table - - Writer - Metadata - Table - - - - Writes a ImplMap table - - Writer - Metadata - Table - - - - Writes a FieldRVA table - - Writer - Metadata - Table - - - - Writes a ENCLog table - - Writer - Metadata - Table - - - - Writes a ENCMap table - - Writer - Metadata - Table - - - - Writes a Assembly table - - Writer - Metadata - Table - - - - Writes a AssemblyProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyOS table - - Writer - Metadata - Table - - - - Writes a AssemblyRef table - - Writer - Metadata - Table - - - - Writes a AssemblyRefProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyRefOS table - - Writer - Metadata - Table - - - - Writes a File table - - Writer - Metadata - Table - - - - Writes a ExportedType table - - Writer - Metadata - Table - - - - Writes a ManifestResource table - - Writer - Metadata - Table - - - - Writes a NestedClass table - - Writer - Metadata - Table - - - - Writes a GenericParam table - - Writer - Metadata - Table - - - - Writes a MethodSpec table - - Writer - Metadata - Table - - - - Writes a GenericParamConstraint table - - Writer - Metadata - Table - - - - Writes a Document table - - Writer - Metadata - Table - - - - Writes a MethodDebugInformation table - - Writer - Metadata - Table - - - - Writes a LocalScope table - - Writer - Metadata - Table - - - - Writes a LocalVariable table - - Writer - Metadata - Table - - - - Writes a LocalConstant table - - Writer - Metadata - Table - - - - Writes a ImportScope table - - Writer - Metadata - Table - - - - Writes a StateMachineMethod table - - Writer - Metadata - Table - - - - Writes a CustomDebugInformation table - - Writer - Metadata - Table - - - - flags - - - - - Preserves all rids in the TypeRef table - - - - - Preserves all rids in the TypeDef table - - - - - Preserves all rids in the Field table - - - - - Preserves all rids in the Method table - - - - - Preserves all rids in the Param table - - - - - Preserves all rids in the MemberRef table - - - - - Preserves all rids in the StandAloneSig table - - - - - Preserves all rids in the Event table - - - - - Preserves all rids in the Property table - - - - - Preserves all rids in the TypeSpec table - - - - - Preserves all rids in the MethodSpec table - - - - - Preserves all method rids, i.e., Method, MemberRef and - MethodSpec rids. - - - - - Preserves all rids in the following tables: TypeRef, TypeDef, - Field, Method, Param, MemberRef, StandAloneSig, - Event, Property, TypeSpec, MethodSpec - - - - - Preserves all offsets in the #Strings heap (the original #Strings heap will be saved - in the new file). Type names, field names, and other non-user strings are stored - in the #Strings heap. - - - - - Preserves all offsets in the #US heap (the original #US heap will be saved - in the new file). User strings (referenced by the ldstr instruction) are stored in - the #US heap. - - - - - Preserves all offsets in the #Blob heap (the original #Blob heap will be saved - in the new file). Custom attributes, signatures and other blobs are stored in the - #Blob heap. - - - - - Preserves the extra data that is present after the original signature in the #Blob - heap. This extra data shouldn't be present but might be present if an obfuscator - has added this extra data and is eg. using it to decrypt stuff. - - - - - Preserves as much as possible - - - - - The original method body's max stack field should be used and a new one should not - be calculated. - - - - - Always create the #GUID heap even if it's empty - - - - - Always create the #Strings heap even if it's empty - - - - - Always create the #US heap even if it's empty - - - - - Always create the #Blob heap even if it's empty - - - - - Sort the InterfaceImpl table the same way Roslyn sorts it. Roslyn doesn't sort it - according to the ECMA spec, see https://github.com/dotnet/roslyn/issues/3905 - - - - - Don't write method bodies - - - - - Don't write .NET resources - - - - - Don't write field data - - - - - Serialized type names stored in custom attributes are optimized if the types - exist in the core library (eg. mscorlib/System.Private.CoreLib). - Instead of storing type-name + assembly-name, only type-name is stored. This results in - slightly smaller assemblies. -
-
- If it's a type in the current module, the type name is optimized and no assembly name is stored in the custom attribute. -
-
- This is disabled by default. It's safe to enable if the reference core assembly - is the same as the runtime core assembly (eg. it's mscorlib.dll and .NET Framework, - but not .NET Core / .NET Standard). -
-
- - - Metadata heaps event args - - - - - Gets the metadata writer - - - - - Gets all heaps - - - - - Constructor - - Metadata writer - All heaps - - - - options - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Various options - - - - - Extra heaps to add to the metadata. Also see and - - - - - Raised after all heaps have been added. The caller can sort the list if needed - - - - - Preserves the original order of heaps, and optionally adds all custom heaps to . - - Original module with the heaps - If true, all custom streams are added to - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Meta data header options - - - - Constructor - - Meta data header options - Flags - - - - Portable PDB metadata kind - - - - - No debugging metadata - - - - - Standalone / embedded portable PDB metadata - - - - - Metadata writer event args - - - - - Gets the metadata writer - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Metadata writer progress event args - - - - - Gets the metadata writer - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - .NET meta data - - - - - Raised at various times when writing the metadata - - - - - Raised when the progress is updated - - - - - Gets/sets the logger - - - - - Gets the module - - - - - Gets the constants - - - - - Gets the method body chunks - - - - - Gets the .NET resources - - - - - Gets the MD header - - - - - Gets the tables heap. Access to this heap is not recommended, but is useful if you - want to add random table entries. - - - - - Gets the #Strings heap. Access to this heap is not recommended, but is useful if you - want to add random strings. - - - - - Gets the #US heap. Access to this heap is not recommended, but is useful if - you want to add random user strings. - - - - - Gets the #GUID heap. Access to this heap is not recommended, but is useful if you - want to add random GUIDs. - - - - - Gets the #Blob heap. Access to this heap is not recommended, but is useful if you - want to add random blobs. - - - - - Gets the #Pdb heap. It's only used if it's portable PDB metadata - - - - - Gets all exported methods - - - - - The public key that should be used instead of the one in . - - - - - Creates a instance - - Module - Constants list - Method bodies list - .NET resources list - Options - Debug metadata kind - A new instance - - - - - - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - If true, use the original Field RVAs. If it has no RVA, assume it's a new - field value and create a new Field RVA. - - - - - Gets the number of methods that will be written. - - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the - - Method - The or null if is - null or not a method defined in this module. - - - - Gets a method's local variable signature token - - Method - Locals sig token or 0 - - - - Gets the where the resource data will be stored - - Embedded resource - A instance or null if - is invalid - - - - Gets the where the initial value is stored - - Field - A instance or null if - is invalid - - - - Called when an error is detected - - Error message - Optional message arguments - - - - Called to warn of something - - Warning message - Optional message arguments - - - - Raises - - Event - - - - Raises the progress event - - Base event - Sub progress - - - - Creates the .NET metadata tables - - - - - Updates each Method row's RVA column if it has any code - - - - - Updates the FieldRVA rows - - - - - Initializes all TypeDef, Field, Method, Event, - Property and Param rows. Other tables that are related to these six - tables are also updated. No custom attributes are written yet, though. Method bodies - aren't written either. - - - - - Writes TypeDef, Field, Method, Event, - Property and Param custom attributes and custom debug infos. - - - - - Adds the tokens of all methods in all vtables, if any - - - - - Adds the entry point. It's only needed if it's a since if it's - a , it will have already been added. - - - - - Sorts all unsorted tables except GenericParamConstraint and CustomAttribute - - - - - Initializes the GenericParamConstraint table - - - - - Inserts all custom attribute / custom debug info rows in the tables and sort them - - - - - Writes all method bodies - - - - - Checks whether a list is empty or whether it contains only nulls - - Any type - The list - true if the list is empty or if it contains only nulls, false otherwise - - - - - - - - - - Adds a - - Method signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - FIeld signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a NestedType row - - Nested type - Declaring type - - - - Adds a Module row - - Module - Its new rid - - - - Adds a ModuleRef row - - Module ref - Its new rid - - - - Adds an AssemblyRef row - - Assembly ref - Its new rid - - - - Adds an Assembly row - - Assembly - The public key that should be used - Its new rid - - - - Adds generic parameters - - New token of owner - All generic params - - - - Adds a generic param - - New token of owner - Generic paramater - - - - Adds generic parameter constraints - - New rid of owner generic param - Its constraints - - - - Adds a generic parameter constraint - - New rid of owner generic param - Generic parameter constraint - - - - Adds a InterfaceImpl row - - New rid of owner - All interfaces - - - - Adds a FieldLayout row - - Owner field - - - - Adds a FieldMarshal row - - New owner token - Owner - - - - Adds a FieldRVA row - - The field - - - - Adds a ImplMap row - - New owner token - Owner - - - - Adds a Constant row - - New owner token - Owner - - - - Adds a DeclSecurity row - - New owner token - All DeclSecurity rows - - - - Adds MethodSemantics rows - - Event - - - - Adds MethodSemantics rows - - Property - - - - Adds a ClassLayout row - - Type - - - - Adds a File row - - File - Its new rid - - - - Adds a ExportedType row - - Exported type - Its new rid - - - - Gets a #Blob offset of a type signature - - Type sig - Extra data to append the signature if - is true. - #Blob offset - - - - Gets a #Blob offset of a calling convention signature - - Signature - #Blob offset - - - - Adds a CustomAttribute row - - Owner table - New owner rid - Onwer - - - - Adds a CustomDebugInformation row - - Owner table - New owner rid - Onwer - - - - Writes the portable PDB to . - - Output stream - Entry point token - Updated with the offset of the 20-byte PDB ID. The caller is responsible for initializing it with the PDB ID - - - - - - - - - - - - - Called before any other methods - - - - - Gets all s that should be saved in the meta data - - - - - Initializes TypeDef rids and creates raw rows, but does not initialize - any columns. - - - - - Allocates Field, Method, Property, Event, Param: - rid and raw row, but doesn't initialize the raw row. - Initializes TypeDef columns: FieldList, MethodList. - Initializes Method column: ParamList. - Initializes and . - - - - - Adds a . Its custom attributes are also added. - - Type reference - Its new rid - - - - Adds a . Its custom attributes are also added. - - Type spec - Its new rid - - - - Adds a . Its custom attributes are also added. - - Member ref - Its new rid - - - - Adds a . Its custom attributes are also added. - - Stand alone sig - Its new rid - - - - Adds a . Its custom attributes are also added. - - Method spec - Its new rid - - - - Called before sorting the CustomAttribute table. This is the last time anything - can be inserted into this table. - - - - - Called after everything has been initialized. The sub class can initialize more - rows if necessary or do nothing. After this method has been called, nothing else - can be added. - - - - - Should be called before all chunks get an RVA - - - - - - - - - - - - - - - - - Sorts the s - - All s - A sorted list - - - - All events - - - - - Creating the tables has just begun - - - - - Before allocating all TypeDef RIDs - - - - - Before allocating all MemberDef RIDs - - - - - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Before sorting most tables - - - - - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - All resources are about to be added to the .NET resources table - - - - - All resources have been added to the .NET resources table - - - - - All method bodies are about to be written - - - - - All method bodies have been written. Their RVAs are still not known. - - - - - All tables are now sorted, including the CustomAttribute table. - - - - - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - options - - - - - Default version string - - - - - Default header signature - - - - - MD header signature. Default value is - - - - - Major version. Default is 1. MS' CLR supports v0.x (x >= 19) and v1.1, nothing else. - - - - - Minor version. Default is 1. - - - - - Reserved and should be 0. - - - - - Version string. Default is . It's stored as a - zero-terminated UTF-8 string. Length should be <= 255 bytes. - - - - - Storage flags should be 0 - - - - - Reserved and should be 0 - - - - - Creates portable PDB v1.0 options - - - - - - Meta data header. IMAGE_COR20_HEADER.Metadata points to this header. - - - - - - - - - - - Gets/sets the heaps - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Method body chunk - - - - - - - - - - - Gets the code - - - - - Gets the extra sections (exception handlers) or null - - - - - Gets the token of the locals - - - - - true if it's a fat body - - - - - true if it's a tiny body - - - - - true if there's an extra section - - - - - Constructor - - Code - - - - Constructor - - Code - Extra sections or null - - - - Constructor - - Code - Extra sections or null - Token of locals - - - - Gets the approximate size of the method body (code + exception handlers) - - - - - - - - - - - - - - - - - - - - - - - Stores all method body chunks - - - - - - - - - - - Gets the number of bytes saved by re-using method bodies - - - - - Constructor - - true if bodies can be shared - - - - Adds a and returns the one that has been cached - - The method body - The cached method body - - - Removes the specified method body from this chunk - The method body - if the method body is removed - - - - - - - - - - - - - - - - Returns tokens of token types, strings and signatures - - - - - Gets the token of - - A token type or a string or a signature - The token - - - - Gets a StandAloneSig token - - All locals - The original token or 0 if none - A StandAloneSig token or 0 if is - empty. - - - - Writes CIL method bodies - - - - - Gets the code as a byte array. This is valid only after calling . - The size of this array is not necessarily a multiple of 4, even if there are exception - handlers present. See also - - - - - Gets the extra sections (exception handlers) as a byte array or null if there - are no exception handlers. This is valid only after calling - - - - - Gets the token of the locals - - - - - Constructor - - Helps this instance - The CIL method body - - - - Constructor - - Helps this instance - The CIL method body - Keep the original max stack value that has been initialized - in - - - - Writes the method body - - - - - Gets the code and (possible) exception handlers in one array. The exception handlers - are 4-byte aligned. - - The code and any exception handlers - - - - - - - - - - - - - - - - - - - - - - - - - Base class of all CIL method body writers - - - - - - - - - - - true if there was at least one error - - - - - Constructor - - All instructions - All exception handlers - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Gets max stack value - - - - - Gets the offset of an instruction - - The instruction - The offset or 0 if is null or not - present in the list of all instructions. - - - - Initializes instruction offsets and returns the total code size - - Size of code - - - - Gets the size of an instruction - - The instruction - Size of the instruction in bytes - - - - Writes all instructions to at its current offset - - The instruction writer - Number of bytes written - - - - Gets the current offset in the instruction stream. This offset is relative to - the first written instruction. - - The instruction writer - Current offset, relative to the first written instruction - - - - Writes an instruction - - The instruction writer - The instruction - - - - Writes an instruction's opcode - - The instruction writer - The instruction - - - - Writes an instruction's operand - - The instruction writer - The instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - options - - - - - Constructor - - The module - - - - Writes a .NET PE file. See also - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .sdata section - - - - - Gets the .rsrc section or null if none - - - - - Gets the .reloc section - - - - - Gets the PE headers - - - - - Gets the IAT or null if there's none - - - - - Gets the .NET header - - - - - Gets the import directory or null if there's none - - - - - Gets the startup stub or null if there's none - - - - - Gets the reloc directory or null if there's none - - - - - Constructor - - The module - - - - Constructor - - The module - Options or null - - - - - - - - - - Module writer event args - - - - - Gets the writer ( or ) - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Module writer progress event args - - - - - Gets the writer ( or ) - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - Content ID - - - - - Gets the GUID - - - - - Gets the timestamp - - - - - Constructor - - Guid - Timestamp - - - - Event handler - - Event args type - Sender - Event args - - - - PDB writer options - - - - - No bit is set - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - This is only used if it's a Windows PDB file. - - - - - Don't use diasymreader.dll's PDB writer that is shipped with .NET Framework. - - This is only used if it's a Windows PDB file. - - - - - Create a deterministic PDB file and add a debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Hash the PDB file and add a PDB checksum debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Common module writer options base class - - - - - Raised at various times when writing the file. The listener has a chance to modify - the file, eg. add extra metadata, encrypt methods, etc. - - - - - Raised when the progress is updated - - - - - Gets/sets the logger. If this is null, any errors result in a - being thrown. To disable this behavior, either - create your own logger or use . - - - - - Gets/sets the writer logger. If this is null, use - . - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - If true, Win32 resources aren't written to the output - - - - - Gets/sets the Win32 resources. If this is null, use the module's - Win32 resources if any. - - - - - true to delay sign the assembly. Initialize to the - public key to use, and don't initialize . To generate the - public key from your strong name key file, execute sn -p mykey.snk mypublickey.snk - - - - - Gets/sets the strong name key. When you enhance strong name sign an assembly, - this instance's HashAlgorithm must be initialized to its public key's HashAlgorithm. - You should call - to initialize this property if you use normal strong name signing. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - Gets/sets the new public key that should be used. If this is null, use - the public key generated from . If it is also null, - use the module's Assembly's public key. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - true if method bodies can be shared (two or more method bodies can share the - same RVA), false if method bodies can't be shared. Don't enable it if there - must be a 1:1 relationship with method bodies and their RVAs. - This is enabled by default and results in smaller files. - - - - - true if the PE header CheckSum field should be updated, false if the - CheckSum field isn't updated. - - - - - true if it's a 64-bit module, false if it's a 32-bit or AnyCPU module. - - - - - Gets/sets the module kind - - - - - true if it should be written as an EXE file, false if it should be - written as a DLL file. - - - - - Set it to true to enable writing a PDB file. Default is false (a PDB file - won't be written to disk). - - - - - PDB writer options. This property is ignored if is false. - - - - - PDB file name. If it's null a PDB file with the same name as the output assembly - will be created but with a PDB extension. must be true or - this property is ignored. - - - - - PDB file name stored in the debug directory, or null to use - - - - - PDB stream. If this is initialized, then you should also set - to the name of the PDB file since the file name must be written to the PE debug directory. - must be true or this property is ignored. - - - - - Gets the PDB content id (portable PDBs). The argument is the PDB stream with the PDB ID zeroed out, - and the 2nd argument is the default timestamp. - This property is ignored if a deterministic PDB file is created or if the PDB checksum is calculated. - - - - - PDB checksum algorithm - - - - - true if an .mvid section should be added to the assembly. Not used by native module writer. - - - - - Constructor - - The module - - - - Initializes and - for normal strong name signing. - - Module - Signature strong name key pair - - - - Initializes and - for enhanced strong name signing (without key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - - - - Initializes and - for enhanced strong name signing (with key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - Identity strong name key pair - Identity public key - - - - Module writer base class - - - - Default alignment of all constants - - - Default alignment of all method bodies - - - Default alignment of all .NET resources - - - Default alignment of the .NET metadata - - - Default Win32 resources alignment - - - Default strong name signature alignment - - - Default COR20 header alignment - - - See - - - See - - - See - - - See - - - See - - - See - - - Offset where the module is written. Usually 0. - - - Debug directory - - - - Strong name signature - - - - - Returns the module writer options - - - - - Gets the destination stream - - - - - Gets the constants - - - - - Gets the method bodies - - - - - Gets the .NET resources - - - - - Gets the .NET metadata - - - - - Gets the Win32 resources or null if there's none - - - - - Gets the strong name signature or null if there's none - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Gets the debug directory or null if there's none - - - - - true if this is a , false if - this is a . - - - - - null if we're not writing a PDB - - - - - Writes the module to a file - - File name. The file will be truncated if it exists. - - - - Writes the module to a - - Destination stream - - - - Returns the module that is written - - - - - Writes the module to . Event listeners and - have been initialized when this method is called. - - Number of bytes written - - - - Creates the strong name signature if the module has one of the strong name flags - set or wants to sign the assembly. - - - - - Creates the .NET metadata chunks (constants, method bodies, .NET resources, - the metadata, and Win32 resources) - - - - - - Gets the Win32 resources that should be written to the new image or null if none - - - - - Calculates and of all s - - All chunks - Starting file offset - Starting RVA - File alignment - Section alignment - - - - Writes all chunks to - - The writer - All chunks - File offset of first chunk - File alignment - - - - Strong name sign the assembly - - Strong name signature offset - - - - Creates the debug directory if a PDB file should be written - - - - - Write the PDB file. The caller should send the PDB events before and after calling this - method. - - - - - Gets the timestamp stored in the PE header - - - - - - Raises a writer event - - Event - - - - - - - - - - Logs an error message - - Format - Format args - - - - Logs a warning message - - Format - Format args - - - - All / events - - - - - Writing has just begun - - - - - All PE sections have been created - - - - - All chunks have been created - - - - - All chunks have been added to their sections - - - - - Original event: . - Creating the metadata tables has just begun - - - - - Original event: . - Before allocating all TypeDef RIDs - - - - - Original event: . - Before allocating all MemberDef RIDs - - - - - Original event: . - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - Original event: . - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Original event: . - Before sorting most tables - - - - - Original event: . - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Original event: . - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - Original event: . - All resources are about to be added to the .NET resources table - - - - - Original event: . - All resources have been added to the .NET resources table - - - - - Original event: . - All method bodies are about to be written - - - - - Original event: . - All method bodies have been written. Their RVAs are still not known. - - - - - Original event: . - All tables are now sorted, including the CustomAttribute table. - - - - - Original event: . - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - This event occurs before the PDB file is written. This event occurs even if no PDB file - will be written. - - - - - The PDB file has been written. This event occurs even if no PDB file has been written. - - - - - This event occurs just before all RVAs and file offsets of the chunks are calculated. - - - - - File offsets and RVAs of all chunks are now known. This includes method body and - field RVAs. Nothing has been written to the destination stream yet. - - - - - This event occurs before all chunks are written to the destination stream, and after - all RVAs and file offsets are known. - - - - - All chunks have been written to the destination stream. - - - - - This event occurs before the strong name signature is calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs after the strong name signature has been calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs before the checksum in the PE header is updated. This event - occurs even if the checksum isn't updated. - - - - - This event occurs after the checksum in the PE header has been updated. This event - occurs even if the checksum isn't updated. - - - - - Writing has ended - - - - - Thrown when the module writer encounters an unrecoverable error - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - options - - - - - If true, any extra data after the PE data in the original file is also saved - at the end of the new file. Enable this option if some protector has written data to - the end of the file and uses it at runtime. - - - - - If true, keep the original Win32 resources - - - - - Constructor - - Module - true to optimize the image size so it's as small as possible. - Since the file can contain native methods and other native data, we re-use the - original file when writing the new file. If is true, - we'll try to re-use the old method body locations in the original file and - also try to fit the new metadata in the old metadata location. - - - - A module writer that supports saving mixed-mode modules (modules with native code). - The original image will be re-used. See also - - - - The original .NET module - - - All options - - - - Any extra data found at the end of the original file. This is null if there's - no extra data or if is - false. - - - - The original PE sections and their data - - - Original PE image - - - New sections we've added and their data - - - New .text section where we put some stuff, eg. .NET metadata - - - The new COR20 header - - - - New .rsrc section where we put the new Win32 resources. This is null if there - are no Win32 resources or if - is true - - - - - Offset in of the PE checksum field. - - - - - Original PE section - - - - PE section - - - PE section data - - - - Constructor - - PE section - - - - - - - - - - Gets the module - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s - - - - - Gets the original PE sections and their data - - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Constructor - - The module - Options or null - - - - - - - - - - Gets the raw section data of the image. The sections are saved in - . - - - - - Creates the PE header "section" - - - - - Saves any data that is appended to the original PE file - - - - - true if image is 64-bit - - - - - Updates the PE header and COR20 header fields that need updating. All sections are - also updated, and the new ones are added. - - - - - Converts to a file offset in the destination stream - - RVA - - - - Gets the entry point - - Updated with entry point (either a token or RVA of native method) - true if it's a managed entry point or there's no entry point, - false if it's a native entry point - - - - .NET resources - - - - - - - - - - - Gets offset of next resource. This offset is relative to the start of - the .NET resources and is always aligned. - - - - - Constructor - - Alignment of all resources - - - - Adds a resource - - The resource data - The resource data - - - - - - - - - - - - - - - - Does not preserve metadata tokens - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Pdb heap - - - - - - - - Gets the PDB ID. This is always 20 bytes in size. - - - - - Gets/sets the entry point token - - - - - Gets the offset of the 20-byte PDB ID - - - - - Gets/sets the referenced type system tables - - - - - Gets the type system table rows. This table has 64 elements. - - - - - Constructor - - - - - - - - - - - options - - - - - Default DLL characteristics - - - - - Default subsystem value - - - - - Default major linker version. Roslyn C# defaults to 0x30, and Roslyn VB defaults to 0x50. - - - - - Default minor linker version - - - - - IMAGE_FILE_HEADER.Machine value - - - - - IMAGE_FILE_HEADER.TimeDateStamp value - - - - - IMAGE_FILE_HEADER.PointerToSymbolTable value - - - - - IMAGE_FILE_HEADER.NumberOfSymbols value - - - - - IMAGE_FILE_HEADER.Characteristics value. bit - is ignored and set/cleared depending on whether it's a EXE or a DLL file. - - - - - IMAGE_OPTIONAL_HEADER.MajorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.ImageBase value - - - - - IMAGE_OPTIONAL_HEADER.SectionAlignment value - - - - - IMAGE_OPTIONAL_HEADER.FileAlignment value - - - - - IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.Win32VersionValue value - - - - - IMAGE_OPTIONAL_HEADER.Subsystem value - - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackCommit value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit value - - - - - IMAGE_OPTIONAL_HEADER.LoaderFlags value - - - - - IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes value - - - - - Creates a new time date stamp using current time - - A new time date stamp - - - - DOS and PE headers - - - - - Gets/sets the native entry point - - - - - Gets/sets the COR20 header - - - - - Gets/sets the IAT - - - - - Gets/sets the - - - - - Gets/sets the Win32 resources - - - - - Gets/sets the relocation directory - - - - - Gets/sets the debug directory - - - - - Gets the image base - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets the section alignment - - - - - Gets the file alignment - - - - - Gets/sets the s - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Calculates the PE checksum and writes it to the checksum field - - Writer - Length of PE file - - - - A PE section - - - - - Gets the name - - - - - Gets the Characteristics - - - - - true if this is a code section - - - - - true if this is an initialized data section - - - - - true if this is an uninitialized data section - - - - - Constructor - - Section name - Section characteristics - - - - Writes the section header to at its current position. - Returns aligned virtual size (aligned to ) - - Writer - File alignment - Section alignment - Current - - - - Preserves metadata tokens - - - - - Its real rid - - - - - Its logical rid or real rid. If the ptr table exists (eg. MethodPtr), then it's - an index into it, else it's the real rid. - - - - - Gets total number of defs in the list. It does not necessarily return - the table size. Use for that. - - - - - Gets the number of rows that need to be created in the table - - - - - Returns true if the ptr table (eg. MethodPtr) is needed - - - - - Sorts the table - - Comparer - - - - Adds a def. must be called after adding the last def. - - The def - Collection position - - - - Must be called after 'ing the last def - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reserves rows in TypeRef, MemberRef, StandAloneSig, - TypeSpec and MethodSpec where we will store the original rows - to make sure they get the same rid. Any user created rows will be stored at - the end of each table. - - - - - Adds any non-referenced rows that haven't been added yet but are present in - the original file. If there are any non-referenced rows, it's usually a sign - that an obfuscator has encrypted one or more methods or that it has added - some rows it uses to decrypt something. - - - - - - - - Re-uses all Field rows which aren't owned by any type due to the fields - having been deleted by the user. The reason we must do this is that the - FieldPtr and Field tables must be the same size. - - - - - Re-uses all Method rows which aren't owned by any type due to the methods - having been deleted by the user. The reason we must do this is that the - MethodPtr and Method tables must be the same size. - - - - - Re-uses all Param rows which aren't owned by any type due to the params - having been deleted by the user. The reason we must do this is that the - ParamPtr and Param tables must be the same size. - This method must be called after since - this method will create more methods at the end of the Method table. - - - - - Re-uses all Event rows which aren't owned by any type due to the events - having been deleted by the user. The reason we must do this is that the - EventPtr and Event tables must be the same size. - - - - - Re-uses all Property rows which aren't owned by any type due to the properties - having been deleted by the user. The reason we must do this is that the - PropertyPtr and Property tables must be the same size. - - - - - Creates a dummy TypeDef at the end of the TypeDef table that will own - dummy methods and fields. These dummy methods and fields are only created if the size - of the ptr table is less than the size of the non-ptr table (eg. size MethodPtr table - is less than size Method table). The only reason the ptr table would be smaller than - the non-ptr table is when some field/method has been deleted and we must preserve - all method/field rids. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Relocations directory - - - - - - - - - - - Constructor - - Machine - - - - - - - - - - - - - - - - Adds a relocation - - RVA of location - - - - Adds a relocation - - Chunk or null. If it's null, is the RVA - Offset relative to the start of , or if is null, this is the RVA - - - - Length of section - - - - - Section characteristics - - - - - Constructor - - Length of section - Section characteristics - - - - Calculates the optional header section sizes - - - - - Helps map s to tokens - - - - - Returns a TypeDefOrRef encoded token - - A TypeDefOrRef type - - - - Writes signatures - - - - - Write a signature - - Helper - The type - The signature as a byte array - - - - Write a signature - - Helper - The signature - The signature as a byte array - - - - - - - Stores the instruction that jumps to _CorExeMain/_CorDllMain - - - - - Gets/sets the - - - - - Gets/sets the - - - - - - - - - - - Gets the address of the JMP instruction - - - - - Constructor - - Reloc directory - Machine - Error logger - - - - - - - - - - - - - - - - #Strings heap - - - - - - - - Populates strings from an existing (eg. to preserve - string offsets) - - The #Strings stream with the original content - - - - Adds a string to the #Strings heap. The returned value is not necessarily an offset in - the #Strings heap. Call to get the offset. - - The string - The offset id. This is not a #Strings offset. Call to get the #Strings offset - - - - Gets the offset of a string in the #Strings heap. This method can only be called after - all strings have been added. - - Offset id returned by - - - - - Adds a string to the #Strings heap, but does not re-use an existing position - - The string - The offset of the string in the #Strings heap - - - - - - - - - - - - - - - - - - - Strong name signature chunk - - - - - - - - - - - Constructor - - Size of strong name signature - - - - - - - - - - - - - - - - options - - - - - Should be 0 - - - - - Major version number. Default is 2. Valid versions are v1.0 (no generics), - v1.1 (generics are supported), or v2.0 (recommended). - - - - - Minor version number. Default is 0. - - - - - Force #- or #~ stream. Default value is null and recommended because the correct - tables stream will be used. true will force #- (Edit N' Continue) - stream, and false will force #~ (normal compressed) stream. - - - - - Extra data to write - - - - - true if there are deleted s, s, - s, s, s and/or - s. - - - - - Creates portable PDB v1.0 options - - - - - - Contains all .NET tables - - - - - - - - - - - All tables - - - - - - - - - - - true if the Edit 'N Continue name will be used (#-) - - - - - true if any rows have been deleted (eg. a deleted TypeDef, Method, Field, etc. - Its name has been renamed to _Deleted). - - - - - true if #Strings heap size > 0xFFFF - - - - - true if #GUID heap size > 0xFFFF - - - - - true if #Blob heap size > 0xFFFF - - - - - Constructor - - Metadata owner - Options - - - - - - - - - - - - - - - - Calculates the length. This will set all MD tables to read-only. - - - - - - - - - - - Re-uses existing chunks to save space - - Chunk type - - - - Default constructor - - - - - Constructor - - Compares the chunk type - - - - - - - Adds a if not already present - - The chunk to add or null if none - Chunk alignment - The original input if it wasn't present, or the cached one - - - - #US heap - - - - - - - - Populates strings from an existing (eg. to preserve - string tokens) - - The #US stream with the original content - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - - - - - - - - - - - - - - - - Writes Win32 resources - - - - - - - - - - - Constructor - - Win32 resources - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - 's name. must have been - called. - - The name of a - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a 's name. - must have been called. - - The name of a - The file offset or 0 if is invalid - - - - Returns the of a 's name. - must have been called. - - The name of a - The RVA or 0 if is invalid - - - - - - - - - - - - - - - - A that reads from a byte array - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since a has nothing that must be cleaned up - - - - - Thrown by a when it can't read data or if the caller tries to set an invalid offset - - - - - Reads data - - - - - Gets the start offset of the data - - - - - Gets the end offset of the data, not inclusive - - - - - Gets the total length of the data - - - - - Gets the current offset. This is between and (inclusive) - - - - - Gets/sets the position relative to - - - - - Gets the number of bytes that can be read without throwing an exception - - - - - Constructor - - Stream - Start offset of data - Length of data - - - - Resets the reader so it points to the start of the data - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a UTF-16 encoded - - Number of characters to read - - - - - Reads bytes - - Destination pointer - Number of bytes to read - - - - Reads bytes - - Destination array - Destination index - Number of bytes to read - - - - Reads bytes - - Number of bytes to read - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a serialized UTF-8 string - - - - - - Reads a serialized string - - Encoding - - - - - Returns all data without updating the current position - - - - - - Returns the remaining data - - - - - - Reads all bytes until a terminating byte or returns null if wasn't found. - If found, the current offset is incremented by the length of the returned data - - Terminating byte value - - - - - Reads a zero-terminated UTF-8 string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - - - - - Reads a zero-terminated string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - Encoding - - - - - Reads a UTF-8 encoded string - - Number of bytes to read (not characters) - - - - - Reads a string - - Number of bytes to read (not characters) - Encoding - - - - - Creates a that can access this content. The caller doesn't have to dispose of the returned stream. - - - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Creates s that can read its data. - - This factory class is thread safe and its data can be read by on any thread. - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a data reader that can read all data - - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Stream - Offset of data - Length of data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Disposes of this instance - - - - - This class is used by a . The instance - verifies that all input are valid before calling any methods in this class. - This class is thread safe. - - - - - Reads bytes - - Offset of data - Destination pointer - Number of bytes to read - - - - Reads bytes - - Offset of data - Destination array - Destination index - Number of bytes to read - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a UTF-16 encoded - - Offset of data - Number of characters to read - - - - - Reads a string - - Offset of data - Length of string in bytes - Encoding - - - - - Gets the data offset of a byte or returns false if the byte wasn't found - - Offset of data - End offset of data (not inclusive) - Byte value to search for - Offset of the byte if found - - - - - Creates s - - - - - Creates a that reads from native memory - - Pointer to data - - - - - Creates a that reads from a byte array - - Data - - - - - Represents a file offset - - - - - Extension methods - - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Base class for classes needing to implement IFileSection - - - - - The start file offset of this section - - - - - Size of the section - - - - - - - - - - - Set to 's current position - - The reader - - - - Set according to 's current position - - The reader - - - - Represents a section in a file - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Creates s that read memory mapped data - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Cleans up and frees all allocated memory - - - - - true if memory mapped I/O is enabled - - - - - Call this to disable memory mapped I/O. This must only be called if no other code is - trying to access the memory since that could lead to an exception. - - - - - Creates s that read native memory - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Pointer to data - Length of data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since this instance doesn't own the native memory - - - - - IMAGE_FILE_HEADER.Characteristics flags - - - - Relocation info stripped from file. - - - File is executable (i.e. no unresolved externel references). - - - Line nunbers stripped from file. - - - Local symbols stripped from file. - - - Agressively trim working set - - - App can handle >2gb addresses - - - - - - Bytes of machine word are reversed. - - - 32 bit word machine. - - - Debugging info stripped from file in .DBG file - - - If Image is on removable media, copy and run from the swap file. - - - If Image is on Net, copy and run from the swap file. - - - System File. - - - File is a DLL. - - - File should only be run on a UP machine - - - Bytes of machine word are reversed. - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics - - - - - - - - - - - - - - - - - - - Image can handle a high entropy 64-bit virtual address space. - - - DLL can move. - - - Code Integrity Image - - - Image is NX compatible - - - Image understands isolation and doesn't want it - - - Image does not use SEH. No SE handler may reside in this image - - - Do not bind this image. - - - Image should execute in an AppContainer - - - Driver uses WDM model - - - Image supports Control Flow Guard. - - - - - - - Interface for PE optional header classes - - - - - Returns the Magic field - - - - - Returns the MajorLinkerVersion field - - - - - Returns the MinorLinkerVersion field - - - - - Returns the SizeOfCode field - - - - - Returns the SizeOfInitializedData field - - - - - Returns the SizeOfUninitializedData field - - - - - Returns the AddressOfEntryPoint field - - - - - Returns the BaseOfCode field - - - - - Returns the BaseOfData field - - - - - Returns the ImageBase field - - - - - Returns the SectionAlignment field - - - - - Returns the FileAlignment field - - - - - Returns the MajorOperatingSystemVersion field - - - - - Returns the MinorOperatingSystemVersion field - - - - - Returns the MajorImageVersion field - - - - - Returns the MinorImageVersion field - - - - - Returns the MajorSubsystemVersion field - - - - - Returns the MinorSubsystemVersion field - - - - - Returns the Win32VersionValue field - - - - - Returns the SizeOfImage field - - - - - Returns the SizeOfHeaders field - - - - - Returns the CheckSum field - - - - - Returns the Subsystem field - - - - - Returns the DllCharacteristics field - - - - - Returns the SizeOfStackReserve field - - - - - Returns the SizeOfStackCommit field - - - - - Returns the SizeOfHeapReserve field - - - - - Returns the SizeOfHeapCommit field - - - - - Returns the LoaderFlags field - - - - - Returns the NumberOfRvaAndSizes field - - - - - Returns the DataDirectories field. This array contains exactly 16 elements. - - - - - Represents the IMAGE_DATA_DIRECTORY PE section - - - - - Returns the IMAGE_DATA_DIRECTORY.VirtualAddress field - - - - - Returns the IMAGE_DATA_DIRECTORY.Size field - - - - - Default constructor - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - A IMAGE_DEBUG_DIRECTORY - - - - - Gets the characteristics (reserved) - - - - - Gets the timestamp - - - - - Gets the major version - - - - - Gets the minor version - - - - - Gets the type - - - - - Gets the size of data - - - - - RVA of the data - - - - - File offset of the data - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Image debug type, see IMAGE_DEBUG_TYPE_* in winnt.n - - - - - Contains PDB info - - - - - It's a deterministic (reproducible) PE file - - - - - Embedded portable PDB data - - - - - Checksum of the PDB file. 0 or more entries allowed. - - - - - Represents the IMAGE_DOS_HEADER PE section - - - - - File offset of the NT headers - - - - - Constructor - - PE file reader - Verify section - Thrown if verification fails - - - - Represents the IMAGE_FILE_HEADER PE section - - - - - Returns the IMAGE_FILE_HEADER.Machine field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSections field - - - - - Returns the IMAGE_FILE_HEADER.TimeDateStamp field - - - - - Returns the IMAGE_FILE_HEADER.PointerToSymbolTable field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSymbols field - - - - - Returns the IMAGE_FILE_HEADER.SizeOfOptionalHeader field - - - - - Returns the IMAGE_FILE_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the IMAGE_NT_HEADERS PE section - - - - - Returns the IMAGE_NT_HEADERS.Signature field - - - - - Returns the IMAGE_NT_HEADERS.FileHeader field - - - - - Returns the IMAGE_NT_HEADERS.OptionalHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Creates an IImageOptionalHeader - - PE file reader pointing to the start of the optional header - Verify section - The created IImageOptionalHeader - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER (32-bit) PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER64 PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.BaseOfCode field - - - - - Returns 0 since BaseOfData is not present in IMAGE_OPTIONAL_HEADER64 - - - - - Returns the IMAGE_OPTIONAL_HEADER64.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_SECTION_HEADER PE section - - - - - Returns the human readable section name, ignoring everything after - the first nul byte - - - - - Returns the IMAGE_SECTION_HEADER.Name field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualSize field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualAddress field - - - - - Returns the IMAGE_SECTION_HEADER.SizeOfRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Converts s to/from s - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Interface to access a PE image - - - - - true if image layout is the same as the raw PE image layout, false - if it's the same layout as a PE image loaded by the OS PE loader. - - - - - true if some of the memory where the image is located could be unavailable. - This could happen if it's been loaded by the OS loader. - - - - - The filename or null if the data is not from a file - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Returns the debug directories - - - - - Gets/sets the Win32 resources. This is null if there are no Win32 resources. - - - - - Gets the factory - - - - - Creates a from to the end of the image - - Offset of data - - - - - Creates a - - Offset of data - Length of data - - - - - Creates a from to the end of the image - - RVA of data - - - - - Creates a - - RVA of data - Length of data - - - - - Creates a that can read the whole image - - - - - - Interface to access a PE image - - - - - Call this to disable memory mapped I/O if it was used to open the file. This must only - be called if no other code is trying to access the memory since that could lead to an - exception. - - - - - true if memory mapped I/O is enabled - - - - - Extension methods - - - - - Finds a - - this - Type - Name - Language ID - The or null if none found - - - - Calculates a PE checksum - - PE image stream positioned at the MZ bytes - Length of image - Offset of checksum - PE checksum - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Converts a to/from an - - - - - Converts a to an - - The PEInfo context - The file offset to convert - The RVA - - - - Converts an to a - - The PEInfo context - The RVA to convert - The file offset - - - - IMAGE_FILE_HEADER.Machine enum - - - - Unknown machine - - - x86 - - - MIPS little-endian, 0x160 big-endian - - - MIPS little-endian - - - MIPS little-endian - - - MIPS little-endian WCE v2 - - - Alpha_AXP - - - SH3 little-endian - - - - - - SH3E little-endian - - - SH4 little-endian - - - SH5 - - - ARM Little-Endian - - - ARM Thumb/Thumb-2 Little-Endian - - - ARM Thumb-2 Little-Endian - - - - - - IBM PowerPC Little-Endian - - - - - - IA-64 - - - - - - - - - - - - - - - Infineon - - - - - - EFI Byte Code - - - x64 - - - M32R little-endian - - - - - - - - - - Extensions - - - - - Checks if is a 64-bit machine - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Image layout - - - - - Use this if the PE file has a normal structure (eg. it's been read from a file on disk) - - - - - Use this if the PE file has been loaded into memory by the OS PE file loader - - - - - Accesses a PE file - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - Data reader factory - Image layout - Verify PE file data - - - - Constructor - - Name of the file - true if we should map it as an executable - Verify PE file data - - - - Constructor - - Name of the file - Verify PE file data - - - - Constructor - - Name of the file - - - - Constructor - - The PE file data - Filename or null - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Verify PE file data - - - - Constructor - - The PE file data - Filename or null - Verify PE file data - - - - Constructor - - The PE file data - - - - Constructor - - The PE file data - Filename or null - - - - Constructor - - Address of PE image - Length of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - - - - Constructor - - Address of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Verify PE file data - - - - Constructor - - Address of PE image - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reads all PE sections from a PE stream - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify sections - Thrown if verification fails - - - - Returns the first that has data at file offset - - - The file offset - - - - - Returns the first that has data at RVA - - - The RVA - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Returns size of image rounded up to - - It calculates the size itself, and does not return - Size of image in bytes - - - - Represents an RVA (relative virtual address) - - - - - IMAGE_OPTIONAL_HEADER.Subsystem - - - - Unknown subsystem. - - - Image doesn't require a subsystem. - - - Image runs in the Windows GUI subsystem. - - - Image runs in the Windows character subsystem. - - - image runs in the OS/2 character subsystem. - - - image runs in the Posix character subsystem. - - - image is a native Win9x driver. - - - Image runs in the Windows CE subsystem. - - - - - - - - - - - - - - - - - - - - - - dnlib settings - - - - - true if dnlib is thread safe. (THREAD_SAFE was defined during compilation) - - - - - Cancellation token interface - - - - - Throws a if the operation should be canceled - - - - - Simple class using Monitor.Enter() and Monitor.Exit() - and just like ReaderWriterLockSlim it prevents recursive locks. It doesn't support - multiple readers. A reader lock is the same as a writer lock. - - - - - Creates a new instance of this class - - - - - - Constructor - - - - - Enter read mode - - - - - Exit read mode - - - - - Enter write mode - - - - - Exit write mode - - - - - Interface to access a lazily initialized list - - Type to store in list - - - - Gets notified of list events - - List value - - - - Called before a new value is lazily added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list. It can be modified by - the callee. - - - - Called before a new value is added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list - - - - Called before a value is removed from the list. If all elements are removed, - is called, and this method is not called. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index of value - The value that will be removed - - - - Called after the list has been resized (eg. an element has been added/removed). It's not - called when an element is replaced. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the change occurred. - - - - Called before the whole list is cleared. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - - - - Implements a that is lazily initialized - - Type to store in list - - - - Stores a simple value - - - - - true if it has been initialized, false otherwise - - - - - Default constructor - - - - - Constructor that should be used when new elements are inserted into - - User data - - - - Gets the value - - Index in the list - - - - Sets the value - - Index in the list - New value - - - - - - - - - - - - - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - - - - Implements a that is lazily initialized - - Type to store in list - Type of the context passed to the read-value delegate - - - - Stores data and keeps track of the original index and whether the data has been - initialized or not. - - - - - - - - - - - - - - Constructor that should only be called when is initialized. - - Original index of this element - LazyList instance - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Constructor - - Initial length of the list - List listener - Context passed to - Delegate instance that returns original values - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid in rare cases. It must never return - null. - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - Generic parameter context - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid. It must never return null. - - - - Lazily returns the original value if the user hasn't overwritten the value - - Value type - - - - Sets the lock that protects the data - - - - - Set a delegate instance that will return the original value - - - - - Gets/sets the value - - The getter returns the original value if the value hasn't been initialized. - - - - Returns true if the value has been initialized - - - - - Returns true if the value was set by the user - - - - - A resource blob - - - - - Gets the data reader - - - - - - Gets/sets the code page - - - - - Gets/sets the reserved field - - - - - Constructor - - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - Code page - Reserved value - - - - A Win32 resource directory (see IMAGE_RESOURCE_DIRECTORY in the Windows SDK) - - - - See - - - See - - - See - - - See - - - See - - - See - - - - Gets/sets the characteristics - - - - - Gets/sets the time date stamp - - - - - Gets/sets the major version number - - - - - Gets/sets the minor version number - - - - - Gets all directory entries - - - - - Gets all resource data - - - - - Constructor - - Name - - - - Finds a by name - - Name - A or null if it wasn't found - - - - Finds a by name - - Name - A or null if it wasn't found - - - - A Win32 resource directory created by the user - - - - - Constructor - - Name - - - - A Win32 resource directory created from a PE file - - - - - To make sure we don't get stuck in an infinite loop, don't allow more than this - many sub directories. - - - - Owner - - - Directory depth. When creating more 's, - the instances get this value + 1 - - - - Info about all 's we haven't created yet - - - - - Info about all 's we haven't created yet - - - - Offset of resource directory / data - - - - Constructor - - Starts from 0. If it's big enough, we'll stop reading more data. - Name - Resources - Reader positioned at the start of this resource directory - - - - Reads the directory header and initializes and - . - - - - - - Reads a string - - Reader - Offset of string - The string or null if we could not read it - - - - Base class of and - - - - - Gets/sets the name - - - - - Constructor - - Name - - - - - - - A Win32 resource name. It can be either an integer or a string. - - - - - true if is valid - - - - - true if is valid - - - - - The ID. It's only valid if is true - - - - - The name. It's only valid if is true - - - - - Constructor - - ID - - - - Constructor - - Name - - - Converts input to a - - - Converts input to a - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Win32 resources base class - - - - - Gets/sets the root directory - - - - - Finds a - - Type - The or null if none found - - - - Finds a - - Type - Name - The or null if none found - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - - - - Dispose method - - true if called by - - - - Win32 resources class created by the user - - - - - - - - Win32 resources class created from a PE file - - - - - Converts data RVAs to file offsets in - - - - - This reader only reads the raw data. The data RVA is found in the data header and - it's first converted to a file offset using . This file - offset is where we'll read from using this reader. - - - - - This reader only reads the directory entries and data headers. The data is read - by - - - - - - - - Gets the resource reader - - - - - Constructor - - / converter - Reader for the whole Win32 resources section (usually - the .rsrc section). It's used to read 's and - 's but not the actual data blob. - Offset of resource section - Length of resource section - true if this instance can dispose of - Data reader (it's used after converting an - to a ) - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Constructor - - The PE image - - - - Constructor - - The PE image - Reader for the whole Win32 resources section (usually - the .rsrc section) or null if we should create one from the resource data - directory in the optional header - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Creates a new data reader - - RVA of data - Size of data - - - - - - - diff --git a/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.dll b/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.dll deleted file mode 100644 index 58e49b4..0000000 Binary files a/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.dll and /dev/null differ diff --git a/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.xml b/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.xml deleted file mode 100644 index 9c0ad02..0000000 --- a/packages/dnlib.3.3.2/lib/netstandard2.0/dnlib.xml +++ /dev/null @@ -1,38514 +0,0 @@ - - - - dnlib - - - - - Returns types without getting stuck in an infinite loop - - - - - Gets a list of all types and nested types - - A list of types - - - - Assembly flags from Assembly.Flags column. - - See CorHdr.h/CorAssemblyFlags - - - No flags set - - - The assembly ref holds the full (unhashed) public key. - - - Processor Architecture unspecified - - - Processor Architecture: neutral (PE32) - - - Processor Architecture: x86 (PE32) - - - Processor Architecture: Itanium (PE32+) - - - Processor Architecture: AMD X64 (PE32+) - - - Processor Architecture: ARM (PE32) - - - applies to any platform but cannot run on any (e.g. reference assembly), should not have "specified" set - - - Propagate PA flags to AssemblyRef record - - - Bits describing the processor architecture - - - Bits describing the PA incl. Specified - - - NOT A FLAG, shift count in PA flags <--> index conversion - - - From "DebuggableAttribute". - - - From "DebuggableAttribute". - - - The assembly can be retargeted (at runtime) to an assembly from a different publisher. - - - - - - - - - Bits describing ContentType - - - - A high-level representation of a row in the Assembly table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Assembly.HashAlgId - - - - - - - - From columns Assembly.MajorVersion, Assembly.MinorVersion, Assembly.BuildNumber, - Assembly.RevisionNumber. - - If is null - - - - - - - From column Assembly.Flags - - - - Attributes - - - - From column Assembly.PublicKey - - An empty is created if the caller writes null - - - - - - - Gets the public key token which is calculated from - - - - - From column Assembly.Name - - - - Name - - - - From column Assembly.Locale - - - - Name - - - - - - - - - Initializes - - - - - - - - - - - - - Gets all modules. The first module is always the . - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if is not empty - - - - - Gets the manifest (main) module. This is always the first module in . - null is returned if is empty. - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Finds a module in this assembly - - Name of module - A instance or null if it wasn't found. - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a file - - File name of an existing .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a byte[] - - Contents of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a memory location - - Address of a .NET assembly - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module context or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Creates an instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream - Module creation options or null - A new instance - If is null - If it's not a .NET assembly (eg. not a .NET file or only a .NET module) - - - - Gets the assembly name with the public key - - - - - Gets the assembly name with the public key token - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable - if possible (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Writes the assembly to a file on disk. If the file exists, it will be truncated. - - Filename - Writer options - - - - Writes the assembly to a stream. - - Destination stream - Writer options - - - - Checks whether this assembly is a friend assembly of - - Target assembly - - - - Adds or updates an existing System.Reflection.AssemblySignatureKeyAttribute - attribute. This attribute is used in enhanced strong naming with key migration. - See http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Identity public key - Identity strong name key pair - Signature public key - - - - Gets the original System.Runtime.Versioning.TargetFrameworkAttribute custom attribute information if possible. - It reads this from the original metadata and doesn't use . - Returns false if the custom attribute isn't present or if it is invalid. - - Framework name - Version - Profile - - - - - - - - - - - - - - - - - - - - - - - An Assembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly name info - If is null - - - - Created from a row in the Assembly table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Assembly row - Row ID - If is null - If is invalid - - - - Hashes some data according to a - - - - - Constructor - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The algorithm to use - - - - - - - Hash data - - If is an unsupported hash algorithm, then - will be used as the hash algorithm. - The data - The algorithm to use - Hashed data or null if was null - - - - Hash data - - Data - - - - Hash data - - Data - Offset - Length - - - - Hash stream data - - Stream - Number of bytes to hash - Temp buffer - - - - Computes the hash - - - - - Creates a public key token from the hash of some - - A public key is hashed, and the last 8 bytes of the hash, in reverse - order, is used as the public key token - The data - A new instance - - - - Any ALG_CLASS_HASH type in WinCrypt.h can be used by Microsoft's CLI implementation - - - - - - - - - - - - - This is a reserved value in the CLI - - - The only algorithm supported by the CLI - - - - - - - - - - - - - - - - - - - - - - - - - - - - Extension methods - - - - - Gets the field type - - this - Field type or null if none - - - - Gets the return type - - this - Return type or null if none - - - - Gets the parameters - - this - The parameters - - - - Gets the parameter count - - this - Parameter count - - - - Gets the generic parameter count - - this - Generic parameter count - - - - Gets the parameters after the sentinel - - this - Parameters after sentinel or null if none - - - - Gets the locals - - this - All locals - - - - Gets the generic arguments - - this - All generic arguments - - - - Gets the property - - this - The type's property or - false if input isnull - - - - Returns true if it's an integer or a floating point type - - Element type - - - - - Returns the size of the element type in bytes or -1 if it's unknown - - Element type - Size of a pointer - - - - - Checks whether it's a value type - - this - true if it's a value type, false if it's not a value type or - if we couldn't determine whether it's a value type. Eg., it could be a generic - instance type. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Finds and returns an - - this - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver - If the assembly couldn't be found. - - - - Checks whether appears to be the core library (eg. - mscorlib, System.Runtime or corefx). - - If is a reference to a private corlib (eg. System.Private.CoreLib), - this method returns false unless is an - whose manifest (first) module defines System.Object. This check is performed in - the constructor and the result can be found in . - - Note that this method also returns true if it appears to be a 'public' corlib, - eg. mscorlib, etc, even if it internally possibly references a private corlib. - - The assembly - - - - Converts to a instance - - The assembly - A new instance - - - - Converts to a - - The type - true if we should try to figure out whether - is a - A instance or null if - is invalid - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns the base type of . Throws if we can't resolve - a . - - The type - The base type or null if there's no base type - - - - Returns the base type of - - The type - true if we should throw if we can't - resolve a . false if we should ignore the error and - just return null. - The base type or null if there's no base type, or if - is true and we couldn't resolve - a - - - - Gets the scope type, resolves it, and returns the - - Type - A or null if input was null or if we - couldn't resolve the reference. - - - - Gets the scope type, resolves it, and returns the - - Type - A instance. - If the type couldn't be resolved - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also - - Field to resolve - The or null if is - null or if it wasn't possible to resolve it (the field doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception if - it was not possible to resolve it. See also - - Field to resolve - The - - - - Resolves an to a . Returns null if it - was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The or null if is - null or if it wasn't possible to resolve it (the method doesn't exist or its - assembly couldn't be loaded) - - - - Resolves an to a and throws an exception - if it was not possible to resolve it. See also . If - is a , then the - property is resolved and returned. - - Method to resolve - The - - - - Returns the definition assembly of a - - Member reference - - - - - Gets the normal visible parameters, doesn't include the hidden 'this' parameter - - this - The normal visible parameters - - - - Gets the normal visible parameter count, doesn't include the hidden 'this' parameter - - this - Normal visible parameter count - - - - Checks whether any normal visible parameter exists, doesn't include the hidden 'this' parameter - - this - true if there's at least one normal visible parameter - - - - Gets a normal visible parameter, doesn't include the hidden 'this' parameter - - this - Normal visible parameter index - - - - - Converts a to a - - The sig - - - - Returns true if it's an integer or a floating point type - - Type - - - - - Gets a if matches a primitive type. - - this - The type - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Gets a if and - matches a primitive type. - - this - Namespace - Name - Definition assembly - A or null if it didn't match any primitive type - - - - Log an error message - - this - Sender or null - Message - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an error message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an error message - - this - Sender or null - Message - Message arguments - - - - Log a warning message - - this - Sender or null - Message - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a warning message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a warning message - - this - Sender or null - Message - Message arguments - - - - Log an info message - - this - Sender or null - Message - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log an info message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log an info message - - this - Sender or null - Message - Message arguments - - - - Log a verbose message - - this - Sender or null - Message - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a verbose message - - this - Sender or null - Message - Message arguments - - - - Log a very verbose message - - this - Sender or null - Message - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - - - - Log a very verbose message - - this - Sender or null - Message - Message arg #1 - Message arg #2 - Message arg #3 - Message arg #4 - - - - Log a very verbose message - - this - Sender or null - Message - Message arguments - - - - Resolves a type - - this - The type - A instance or null if it couldn't be resolved - - - - Resolves a type - - this - The type - A instance - If the type couldn't be resolved - - - - Resolves a type - - this - The type - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Resolves a method or a field - - this - A method/field reference - A or a instance - If the method/field couldn't be resolved - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - - - - Resolves a field - - this - A field reference - A instance or null if it couldn't be resolved. - If the field couldn't be resolved - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - - - - Resolves a method - - this - A method reference - A instance or null if it couldn't be resolved. - If the method couldn't be resolved - - - - Resolves a token - - This - The metadata token - A or null if is invalid - - - - Returns , but if it's a nested , - return the non-nested - - this - The scope type - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. - - this - The type ref - An existing or null if it wasn't found. - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by / - An existing - If type couldn't be found - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing or null if it wasn't found. - - - - Finds a - - this - Full name of the type (no assembly information). Nested types are separated by + - An existing - If type couldn't be found - - - - Checks whether a exists. 's scope (i.e., - module or assembly) is ignored when looking up the type. - - this - The type ref - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by / - true if the exists, false otherwise - - - - Checks whether a exists - - this - Full name of the type (no assembly information). Nested types are separated by + - true if the exists, false otherwise - - - - Removes all C optional/required modifiers - - A instance - Input after all modifiers - - - - Removes pinned signature - - The type - Input after pinned signature - - - - Removes all modifiers and pinned sig - - The type - Inputer after modifiers and pinned signature - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Returns a - - The type - A or null if it's not a - - - - - Gets the next field or null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the value or false if - is null - - this - - - - - Gets the element type - - this - The element type - - - - Gets the full name of the type - - this - Full name of the type - - - - Gets the name of the type - - this - Name of the type - - - - Gets the namespace of the type - - this - Namespace of the type - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Returns the if it is a . - Nothing is resolved. - - this - A or null if none found - - - - Returns the if it is a . - - this - A or null if none found - - - - Flags used by - - - - - Compare assembly simple name - - - - - Compare assembly version - - - - - Compare assembly public key token - - - - - Compare assembly culture - - - - - Compare content type - - - - - Compare assembly simple name, version, public key token, locale and content type - - - - - Compares two assembly names - - - - - Compares the name, version, public key token, culture and content type - - - - - Compares only the name and the public key token - - - - - Compares only the name - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - Comparison flags - - - - Compares two assembly names - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two assembly names - - First - Second - true if equal, false otherwise - - - - Figures out which of two assembly names is closer to another assembly name - - Requested assembly name - First - Second - -1 if both are equally close, 0 if is closest, 1 if - is closest - - - - Gets the hash code of an assembly name - - Assembly name - The hash code - - - - Stores assembly name information - - - - - Gets/sets the - - - - - Gets/sets the or null if none specified - - - - - Gets/sets the - - - - - Gets/sets the public key or token - - - - - Gets/sets the name - - - - - Gets/sets the culture or null if none specified - - - - - Gets the full name of the assembly - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Default constructor - - - - - Constructor - - An assembly name - - - - Constructor - - The assembly - - - - Constructor - - Assembly name info - - - - - - - A high-level representation of a row in the AssemblyRef table - - - - - An assembly ref that can be used to indicate that it references the current assembly - when the current assembly is not known (eg. a type string without any assembly info - when it references a type in the current assembly). - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - From columns AssemblyRef.MajorVersion, AssemblyRef.MinorVersion, - AssemblyRef.BuildNumber, AssemblyRef.RevisionNumber - - If is null - - - - - - - From column AssemblyRef.Flags - - - - Attributes - - - - From column AssemblyRef.PublicKeyOrToken - - If is null - - - - - - - From column AssemblyRef.Name - - - - Name - - - - From column AssemblyRef.Locale - - - - Culture - - - - From column AssemblyRef.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Same as , except that it uses the PublicKey if available. - - - - - Gets the full name of the assembly but use a public key token - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - - - - An AssemblyRef row created by the user and not present in the original .NET file - - - - - Creates a reference to CLR 1.0's mscorlib - - - - - Creates a reference to CLR 1.1's mscorlib - - - - - Creates a reference to CLR 2.0's mscorlib - - - - - Creates a reference to CLR 4.0's mscorlib - - - - - Default constructor - - - - - Constructor - - Simple name - If any of the args is invalid - - - - Constructor - - Simple name - Version - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - If any of the args is invalid - - - - Constructor - - Simple name - Version - Public key or public key token - Locale - If any of the args is invalid - - - - Constructor - - Assembly name info - If is null - - - - Constructor - - Assembly - - - - Created from a row in the AssemblyRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this AssemblyRef row - Row ID - If is null - If is invalid - - - - Resolves assemblies - - - - - Gets/sets the default - - - - - true if should find an assembly that matches exactly. - false if it first tries to match exactly, and if that fails, it picks an - assembly that is closest to the requested assembly. - - - - - true if resolved .NET framework assemblies can be redirected to the source - module's framework assembly version. Eg. if a resolved .NET 3.5 assembly can be - redirected to a .NET 4.0 assembly if the source module is a .NET 4.0 assembly. This is - ignored if is true. - - - - - If true, all modules in newly resolved assemblies will have their - property set to true. This is - enabled by default since these modules shouldn't be modified by the user. - - - - - true to search the Global Assembly Cache. Default value is true. - - - - - Gets paths searched before trying the standard locations - - - - - Gets paths searched after trying the standard locations - - - - - Default constructor - - - - - Constructor - - Module context for all resolved assemblies - - - - - - - Add a module's assembly to the assembly cache - - The module whose assembly should be cached - true if 's assembly is cached, false - if it's not cached because some other assembly with the exact same full name has - already been cached or if or its assembly is null. - - - - Add an assembly to the assembly cache - - The assembly - true if is cached, false if it's not - cached because some other assembly with the exact same full name has already been - cached or if is null. - - - - Removes a module's assembly from the cache - - The module - true if its assembly was removed, false if it wasn't removed - since it wasn't in the cache, it has no assembly, or was - null - - - - Removes the assembly from the cache - - The assembly - true if it was removed, false if it wasn't removed since it - wasn't in the cache or if was null - - - - Clears the cache and calls on each cached module. - Use to remove any assemblies you added yourself - using before calling this method if you don't want - them disposed. - - - - - Gets the cached assemblies in this resolver. - - The cached assemblies. - - - - Finds an assembly that exactly matches the requested assembly - - Assembly to find - Search paths or null if none - Module context - An instance or null if an exact match - couldn't be found. - - - - Finds the closest assembly from the already cached assemblies - - Assembly to find - The closest or null if none found - - - - Returns true if is inserted in - - Assembly to check - - - - Called before - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Called after (if it fails) - - Assembly to find - The module that needs to resolve an assembly or null - We're trying to find an exact match - null or an enumerable of full paths to try - - - - Gets all search paths to use for this module - - The module or null if unknown - A list of all search paths to use for this module - - - - Gets all module search paths. This is usually empty unless its assembly has - a .config file specifying any additional private search paths in a - <probing/> element. - - The module or null if unknown - A list of search paths - - - - Gets all private assembly search paths as found in the module's .config file. - - The module or null if unknown - A list of search paths - - - - See CorHdr.h/CorCallingConvention - - - - The managed calling convention - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - generic method instantiation - - - used ONLY for 64bit vararg PInvoke calls - - - Calling convention is bottom 4 bits - - - Generic method - - - Method needs a 'this' parameter - - - 'this' parameter is the first arg if set (else it's hidden) - - - Used internally by the CLR - - - - Base class for sigs with a calling convention - - - - - The calling convention - - - - - Gets/sets the extra data found after the signature - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Returns true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if there's an implicit this parameter - - - - - true if this contains a - or a . - - - - - Default constructor - - - - - Constructor - - The calling convention - - - - Gets the calling convention - - - - - A field signature - - - - - Gets/sets the field type - - - - - Default constructor - - - - - Constructor - - Field type - - - - Constructor - - Field type - The calling convention (must have Field set) - - - - Clone this - - - - - - - - Method sig base class - - - - - - - - - - - - - - - - - Gets/sets the calling convention - - - - - Gets/sets the return type - - - - - Gets the parameters. This is never null - - - - - Gets/sets the generic param count - - - - - Gets the parameters that are present after the sentinel. Note that this is null - if there's no sentinel. It can still be empty even if it's not null. - - - - - A method signature - - - - - Gets/sets the original token. It's set when reading calli instruction operands - and it's a hint to the module writer if it tries to re-use the same token. - - - - - Creates a static MethodSig - - Return type - - - - Creates a static MethodSig - - Return type - Arg type #1 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static MethodSig - - Return type - Argument types - - - - Creates an instance MethodSig - - Return type - - - - Creates an instance MethodSig - - Return type - Arg type #1 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance MethodSig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance MethodSig - - Return type - Argument types - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance generic MethodSig - - Number of generic parameters - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention - - - - Constructor - - Calling convention - Number of generic parameters - - - - Constructor - - Calling convention - Number of generic parameters - Return type - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A property signature - - - - - Creates a static PropertySig - - Return type - - - - Creates a static PropertySig - - Return type - Arg type #1 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates a static PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates a static PropertySig - - Return type - Argument types - - - - Creates an instance PropertySig - - Return type - - - - Creates an instance PropertySig - - Return type - Arg type #1 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - - - - Creates an instance PropertySig - - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Creates an instance PropertySig - - Return type - Argument types - - - - Default constructor - - - - - Constructor - - Calling convention (must have Property set) - - - - Constructor - - true if instance, false if static - - - - Constructor - - true if instance, false if static - Return type - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - - - - Constructor - - true if instance, false if static - Return type - Arg type #1 - Arg type #2 - Arg type #3 - - - - Constructor - - true if instance, false if static - Return type - Argument types - - - - Constructor - - Calling convention - Number of generic parameters - Return type - Argument types - Parameters after sentinel - - - - Clone this - - - - - - - - A local variables signature - - - - - All local types. This is never null. - - - - - Default constructor - - - - - Constructor - - Calling convention (must have LocalSig set) - Number of locals - - - - Constructor - - Local type #1 - - - - Constructor - - Local type #1 - Local type #2 - - - - Constructor - - Local type #1 - Local type #2 - Local type #3 - - - - Constructor - - All locals - - - - Constructor - - All locals - - - - Constructor - - All locals (this instance now owns it) - Dummy - - - - Clone this - - - - - An instantiated generic method signature - - - - - Gets the generic arguments (must be instantiated types, i.e., closed types) - - - - - Default constructor - - - - - Constructor - - Calling convention (must have GenericInst set) - Number of generic args - - - - Constructor - - Generic arg #1 - - - - Constructor - - Generic arg #1 - Generic arg #2 - - - - Constructor - - Generic arg #1 - Generic arg #2 - Generic arg #3 - - - - Constructor - - Generic args - - - - Constructor - - Generic args - - - - Clone this - - - - - A high-level representation of a row in the ClassLayout table - - - - - The row id in its table - - - - - - - - - - - From column ClassLayout.PackingSize - - - - - - - - From column ClassLayout.ClassSize - - - - - - - - A ClassLayout row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - PackingSize - ClassSize - - - - Created from a row in the ClassLayout table - - - - - - - - Constructor - - The module which contains this ClassLayout row - Row ID - If is null - If is invalid - - - - A high-level representation of a row in the Constant table - - - - - The row id in its table - - - - - - - - - - - From column Constant.Type - - - - - - - - From column Constant.Value - - - - - - - - A Constant row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Value - - - - Constructor - - Value - Type - - - - Created from a row in the Constant table - - - - - - - - Constructor - - The module which contains this Constant row - Row ID - If is null - If is invalid - - - - Default implementation of - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The owner module - - - - Constructor - - The owner module - Corlib assembly reference or null if a default - assembly reference should be created - - - - - - - Gets the required alignment for the stubs, must be a power of 2 - - Stub type - - - - - Gets the size of a stub, it doesn't have to be a multiple of - - Stub type - - - - - Gets the offset of the code (entry point) relative to the start of the stub - - Stub type - - - - - Gets the RVA of the func field that the stub jumps to - - Reader, positioned at the stub func - PE image - Updated with RVA of func field - - - - - Writes stub relocs, if needed - - Stub type - Reloc directory - The chunk where this stub will be written to - Offset of this stub in - - - - Writes the stub that jumps to the managed function - - Stub type - Writer - Image base - RVA of this stub - RVA of a pointer-sized field that contains the absolute address of the managed function - - - - A custom attribute - - - - - Gets/sets the custom attribute constructor - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - true if the raw custom attribute blob hasn't been parsed - - - - - Gets the raw custom attribute blob or null if the CA was successfully parsed. - - - - - Gets all constructor arguments - - - - - true if is not empty - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Gets the #Blob offset or 0 if unknown - - - - - Constructor - - Custom attribute constructor - Raw custom attribute blob - - - - Constructor - - Custom attribute constructor - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - - - - Constructor - - Custom attribute constructor - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - - - - Constructor - - Custom attribute constructor - Constructor arguments or null if none - Named arguments or null if none - Original custom attribute #Blob offset or 0 - - - - Constructor - - Custom attribute constructor - Constructor arguments. The list is now owned by this instance. - Named arguments. The list is now owned by this instance. - Original custom attribute #Blob offset or 0 - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the field named - - Name of field - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property named - - Name of property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - Gets the property/field named - - Name of property/field - true if it's a field, false if it's a property - A instance or null if not found - - - - - - - A custom attribute constructor argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Constructor - - Argument type - - - - Constructor - - Argument type - Argument value - - - - Clones this instance and any s and s - referenced from this instance. - - - - - - - - - A custom attribute field/property argument - - - - - true if it's a field - - - - - true if it's a property - - - - - Gets/sets the field/property type - - - - - Gets/sets the property/field name - - - - - Gets/sets the argument - - - - - Gets/sets the argument type - - - - - Gets/sets the argument value - - - - - Default constructor - - - - - Constructor - - true if field, false if property - - - - Constructor - - true if field, false if property - Field/property type - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - - - - Constructor - - true if field, false if property - Field/property type - Name of field/property - Field/property argument - - - - Clones this instance and any s referenced from this instance. - - - - - - - - - Stores s - - - - - Default constructor - - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Checks whether a custom attribute is present - - Full name of custom attribute type - true if the custom attribute type is present, false otherwise - - - - Removes all custom attributes of a certain type - - Full name of custom attribute type that should be removed - - - - Finds a custom attribute - - Full name of custom attribute type - A or null if it wasn't found - - - - Finds all custom attributes of a certain type - - Full name of custom attribute type - All s of the requested type - - - - Finds a custom attribute - - Custom attribute type - The first found or null if none found - - - - Finds a custom attribute - - Custom attribute type - Attribute type comparison flags - The first found or null if none found - - - - Finds all custom attributes of a certain type - - Custom attribute type - All s of the requested type - - - - Finds all custom attributes of a certain type - - Custom attribute type - Attribute type comparison flags - All s of the requested type - - - - Searches for a type according to custom attribute search rules: first try the - current assembly, and if that fails, try mscorlib - - - - - Constructor - - The module to search first - - - - - - - Thrown by CustomAttributeReader when it fails to parse a custom attribute blob - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Reads custom attributes from the #Blob stream - - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - A new instance - - - - Reads a custom attribute - - Reader module - Custom attribute constructor - Offset of custom attribute in the #Blob stream - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - A reader positioned at the the first byte of the CA blob - Custom attribute constructor - A new instance - - - - Reads a custom attribute - - Owner module - CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads a custom attribute - - Owner module - A stream positioned at the the first byte of the CA blob - Custom attribute constructor - Generic parameter context - A new instance - - - - Reads custom attribute named arguments - - Owner module - A reader positioned at the the first byte of the CA blob - Number of named arguments to read from - Generic parameter context - A list of s or null if some error - occurred. - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - If is not an enum or null - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - A high-level representation of a row in the DeclSecurity table - - - - - The row id in its table - - - - - - - - - - - - - - From column DeclSecurity.Action - - - - - - - - From column DeclSecurity.PermissionSet - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - Gets the blob data or null if there's none - - Blob data or null - - - - Returns the .NET 1.x XML string or null if it's not a .NET 1.x format - - - - - - A DeclSecurity row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The security action - The security attributes (now owned by this) - - - - - - - Created from a row in the DeclSecurity table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this DeclSecurity row - Row ID - If is null - If is invalid - - - - - - - Reads DeclSecurity blobs - - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - #Blob offset of DeclSecurity signature - Generic parameter context - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity blob - Generic parameter context/// - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - A list of s - - - - Reads a DeclSecurity blob - - Module that will own the returned list - DeclSecurity stream that will be owned by us - Generic parameter context - A list of s - - - - Reads the new (.NET 2.0+) DeclSecurity blob format - - - - - - Reads the old (.NET 1.x) DeclSecurity blob format - - - - - - See CorHdr.h/CorElementType - - - - - - - System.Void - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Pointer type (*) - - - ByRef type (&) - - - Value type - - - Reference type - - - Type generic parameter - - - Multidimensional array ([*], [,], [,,], ...) - - - Generic instance type - - - Typed byref - - - Value array (don't use) - - - System.IntPtr - - - System.UIntPtr - - - native real (don't use) - - - Function pointer - - - System.Object - - - Single-dimension, zero lower bound array ([]) - - - Method generic parameter - - - Required C modifier - - - Optional C modifier - - - Used internally by the CLR (don't use) - - - Module (don't use) - - - Sentinel (method sigs only) - - - Pinned type (locals only) - - - - A CIL opcode. If the high byte is 0 or if it's , it's a 1-byte opcode, - else it's a two-byte opcode and the highest byte is the first byte of the opcode. - - - - - Extension methods - - - - - Converts a to an - - The code - A or null if it's invalid - - - - Gets the opcode or if is null - - this - - - - - Gets the operand or null if is null - - this - - - - - Gets the offset or 0 if is null - - this - - - - - Gets the sequence point or null if is null - - this - - - - - Resolves a token - - An object - The metadata token - A or null if is invalid - - - - options - - - - - No option is enabled - - - - - Some fields/methods have an unknown declaring type and don't have a context with - that information. If this is enabled, the reader will try to guess it but it doesn't - always work. If you get an , try enabling this option. - - - - - Reads code from a DynamicMethod - - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Generic parameter context - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - - - - Constructor - - Module that will own the method body - This can be one of several supported types: the delegate instance - created by DynamicMethod.CreateDelegate(), a DynamicMethod instance, a RTDynamicMethod - instance or a DynamicResolver instance. - Importer - Options - - - - Reads the code - - - - - - Returns the created method. Must be called after . - - A new instance - - - - - - - - - - - - - - - - - - - - - - A CIL method exception handler - - - - - First instruction of try block - - - - - One instruction past the end of try block or null if it ends at the end - of the method. - - - - - Start of filter handler or null if none. The end of filter handler is - always . - - - - - First instruction of try handler block - - - - - One instruction past the end of try handler block or null if it ends at the end - of the method. - - - - - The catch type if is - - - - - Type of exception handler clause - - - - - Default constructor - - - - - Constructor - - Exception clause type - - - - Type of exception handler. See CorHdr.h/CorExceptionFlag - - - - - - - - - - - - - - - - - - - - CIL opcode flow control - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A CIL instruction (opcode + operand) - - - - - The opcode - - - - - The opcode operand - - - - - Offset of the instruction in the method body - - - - - PDB sequence point or null if none - - - - - Default constructor - - - - - Constructor - - Opcode - - - - Constructor - - Opcode - The operand - - - - Creates a new instruction with no operand - - The opcode - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with an operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a operand - - The opcode - The value - A new instance - - - - Creates a new instruction with a string operand - - The opcode - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - The opcode - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The opcode - The targets - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a type operand - - The opcode - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The opcode - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The opcode - The field - A new instance - - - - Creates a new instruction with a method operand - - The opcode - The method - A new instance - - - - Creates a new instruction with a token operand - - The opcode - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The opcode - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The opcode - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The opcode - The method local - A new instance - - - - Creates a ldci4 instruction - - Operand value - A new instance - - - - Gets the size in bytes of the instruction - - - - - - Updates with the new stack size - - Current stack size - - - - Updates with the new stack size - - Current stack size - true if the method has a return value, - false otherwise - - - - Calculates stack usage - - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Calculates stack usage - - true if method has a return value - Updated with number of stack pushes - Updated with number of stack pops or -1 if the stack should - be cleared. - - - - Checks whether it's one of the leave instructions - - - - - Checks whether it's one of the br instructions - - - - - Checks whether it's one of the brfalse instructions - - - - - Checks whether it's one of the brtrue instructions - - - - - Checks whether it's one of the conditional branch instructions (bcc, brtrue, brfalse) - - - - - Checks whether this is one of the ldc.i4 instructions - - - - - Returns a ldc.i4 instruction's operand - - The integer value - isn't one of the - ldc.i4 opcodes - - - - Checks whether it's one of the ldarg instructions, but does not check - whether it's one of the ldarga instructions. - - - - - Checks whether it's one of the ldloc instructions, but does not check - whether it's one of the ldloca instructions. - - - - - Checks whether it's one of the starg instructions - - - - - Checks whether it's one of the stloc instructions - - - - - Returns the local if it's a ldloc, stloc or ldloca instruction - - The locals - The local or null if it's not a ldloc, stloc or ldloca - instruction or if the local doesn't exist. - - - - Gets the index of the instruction's parameter operand or -1 if the parameter - is missing or if it's not an instruction with a parameter operand. - - - - - Returns a method parameter - - All parameters - A parameter or null if it doesn't exist - - - - Returns an argument type - - Method signature - Declaring type (only needed if it's an instance method) - The type or null if it doesn't exist - - - - Clone this instance. The and fields - are shared by this instance and the created instance. - - - - - - - - Converts instructions to strings - - - - - Converts an instruction to a string - - The instruction - The result - - - - Gets the instruction's operand as a string - - The instruction - The operand as a string - - - - Add an instruction's operand to - - Place result here - The instruction - - - - Add an instruction's operand to - - Place result here - The instruction - A string that will be added before the operand, if there's - an operand. - - - - Thrown when invalid data is detected while parsing a .NET method - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - The inner exception or null if none - - - - Constructor - - - - - - - A collection of s - - - - - Gets the number of locals - - - - - Gets the list of locals - - - - - Gets the N'th local - - The local index - - - - Default constructor - - - - - Constructor - - All locals that will be owned by this instance - - - - Adds a new local and then returns it - - The local that should be added to the list - The input is always returned - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A method local - - - - - Gets/sets the type of the local - - - - - Local index - - - - - Gets the name. This property is obsolete, use to get/set the name stored in the PDB file. - - - - - Gets the attributes. This property is obsolete, use to get/set the attributes stored in the PDB file. - - - - - Constructor - - The type - - - - Constructor - - The type - Name of local - - - - Constructor - - The type - Name of local - Index, should only be used if you don't add it to the locals list - - - - - - - Method body base class - - - - - A native method body - - - - - Gets/sets the RVA of the native method body - - - - - Default constructor - - - - - Constructor - - RVA of method body - - - - CIL (managed code) body - - - - - Size of a small header - - - - - Gets/sets a flag indicating whether the original max stack value should be used. - - - - - Gets/sets the init locals flag. This is only valid if the method has any locals. - - - - - Gets/sets the size in bytes of the method body header. The instructions immediately follow - the header. - - - - - true if it was a small body header ( is 1) - - - - - true if it was a big body header - - - - - Gets/sets max stack value from the fat method header. - - - - - Gets/sets the locals metadata token - - - - - true if is not empty - - - - - Gets the instructions - - - - - true if is not empty - - - - - Gets the exception handlers - - - - - true if is not empty - - - - - Gets the locals - - - - - Gets/sets the PDB method. This is null if no PDB has been loaded or if there's - no PDB info for this method. - - - - - true if is not null - - - - - Gets the total size of the body in the PE file, including header, IL bytes, and exception handlers. - This property returns 0 if the size is unknown. - - - - - Default constructor - - - - - Constructor - - Init locals flag - All instructions. This instance will own the list. - All exception handlers. This instance will own the list. - All locals. This instance will own the locals in the list. - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - - - - Optimizes branches by using the smallest possible branch - - - - - Updates each instruction's offset - - Total size in bytes of all instructions - - - - Reads strings from #US heap - - - - - Reads a string from the #US heap - - String token - A string - - - - Resolves instruction operands - - - - - Reads a .NET method body (header, locals, instructions, exception handlers) - - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Creates a CIL method body or returns an empty one if doesn't - point to the start of a valid CIL method body. - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - - - - Creates a CIL method body or returns an empty one if is not - a valid CIL method body. - - The operand resolver - All code - Exceptions or null if all exception handlers are in - - Method parameters - Method header flags, eg. 2 if tiny method - Max stack - Code size - Local variable signature token or 0 if none - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Use parameters from this method - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Method parameters - Generic parameter context - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - - - - Constructor - - The operand resolver - A reader positioned at the start of a .NET method body - Exception handler reader or null if exceptions aren't - present or if contains the exception handlers - Method parameters - Generic parameter context - - - - Initializes the method header - - Header flags, eg. 2 if it's a tiny method - Max stack - Code size - Local variable signature token - - - - Reads the method body header, locals, all instructions, and the exception handlers (if any) - - true if it worked, and false if something failed - - - - Reads the method header - - - - - Reads the locals - - All locals or null if there are none - - - - Reads all instructions - - - - - - - - - - - - - - - - - - - - - - - Reads all exception handlers - - - - - Creates a CIL body. Must be called after , and can only be - called once. - - A new instance - - - - Method body reader base class - - - - The method reader - - - All parameters - - - All locals - - - All instructions - - - All exception handlers - - - First byte after the end of the code - - - Start offset of method - - - - Gets all parameters - - - - - Gets all locals - - - - - Gets all instructions - - - - - Gets all exception handlers - - - - - Constructor - - - - - Constructor - - The reader - - - - Constructor - - The reader - Method parameters or null if they're not known yet - - - - Sets new locals - - A list of types of all locals or null if none - - - - Sets new locals - - A list of types of all locals or null if none - - - - Reads all instructions - - Number of instructions to read - - - - Reads all instructions - - Size of code - - - - Fixes all branch instructions so their operands are set to an - instead of an offset. - - - - - Finds an instruction - - Offset of instruction - The instruction or null if there's no instruction at . - - - - Finds an instruction and throws if it's not present - - Offset of instruction - The instruction - There's no instruction at - - - - - Reads the next instruction - - - - - Reads the next OpCode from the current position - - - - - Reads the instruction operand (if any) - - The instruction - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a operand - - The current instruction - The operand - - - - Reads a (a parameter) operand - - The current instruction - The operand - - - - Reads a (a local) operand - - The current instruction - The operand - - - - Returns true if it's one of the ldarg/starg instructions that have an operand - - The instruction to check - - - - Returns a parameter - - A parameter index - A or null if is invalid - - - - Returns a local - - A local index - A or null if is invalid - - - - Add an exception handler if it appears valid - - The exception handler - true if it was added, false otherwise - - - - Gets the offset of an instruction - - The instruction or null if the offset is the first offset - at the end of the method. - The instruction offset - - - - Restores a 's body with the parsed method instructions - and exception handlers - - The method that gets updated with the instructions, locals, and - exception handlers. - - - - Converts a type address to a . The address can be found in - RuntimeTypeHandle.Value and it's the same address you use with the WinDbg SOS command - !dumpmt. - - - - - Converts to a . - - Address of type - The or null - - - - Instruction utility methods - - - - - Shorter instructions are converted to the longer form, eg. Ldc_I4_1 is - converted to Ldc_I4 with a 1 as the operand. - - All instructions - All locals - All method parameters, including the hidden 'this' parameter - if it's an instance method. Use . - - - - Optimizes instructions by using the shorter form if possible. Eg. Ldc_I4 1 - will be replaced with Ldc_I4_1. - - All instructions - - - - Short branch instructions are converted to the long form, eg. Beq_S is - converted to Beq. - - All instructions - - - - Optimizes branches by using the smallest possible branch - - All instructions - - - - Updates each instruction's offset - - All instructions - Total size in bytes of all instructions - - - - A CIL opcode - - - - - The opcode name - - - - - The opcode as a enum - - - - - Operand type - - - - - Flow control info - - - - - Opcode type - - - - - Push stack behavior - - - - - Pop stack behavior - - - - - Gets the value which is compatible with - - - - - Gets the size of the opcode. It's either 1 or 2 bytes. - - - - - Creates a new instruction with no operand - - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with an operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a operand - - The value - A new instance - - - - Creates a new instruction with a string operand - - The string - A new instance - - - - Creates a new instruction with an instruction target operand - - Target instruction - A new instance - - - - Creates a new instruction with an instruction target list operand - - The targets - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a type operand - - The type - A new instance - - - - Creates a new instruction with a method/field operand - - The method/field - A new instance - - - - Creates a new instruction with a field operand - - The field - A new instance - - - - Creates a new instruction with a method operand - - The method - A new instance - - - - Creates a new instruction with a token operand - - The token - A new instance - - - - Creates a new instruction with a method signature operand - - The method signature - A new instance - - - - Creates a new instruction with a method parameter operand - - The method parameter - A new instance - - - - Creates a new instruction with a method local operand - - The method local - A new instance - - - - - - - Contains all valid CIL opcodes - - - - - All one-byte opcodes - - - - - All two-byte opcodes (first byte is 0xFE) - - - - - CIL opcode type - - - - - - - - - - - - - - - - - - - - - - - CIL opcode operand type - - - - 4-byte relative instruction offset - - - 4-byte field token ( or ) - - - int32 - - - int64 - - - 4-byte method token (, - or ) - - - No operand - - - Never used - - - 64-bit real - - - - - - 4-byte method sig token () - - - 4-byte string token (0x70xxxxxx) - - - 4-byte count N followed by N 4-byte relative instruction offsets - - - 4-byte token (, , - , , , - or ) - - - 4-byte type token (, or - ) - - - 2-byte param/local index - - - 1-byte relative instruction offset - - - 1-byte sbyte () or byte (the rest) - - - 32-bit real - - - 1-byte param/local index - - - - CIL opcode stack behavior - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Event attributes, see CorHdr.h/CorEventAttr - - - - event is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - - A high-level representation of a row in the Event table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column Event.EventFlags - - - - - - - - From column Event.Name - - - - Name - - - - From column Event.EventType - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the adder method - - - - - Gets/sets the invoker method - - - - - Gets/sets the remover method - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - - - - Reset , , , - - - - true if there are no methods attached to this event - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the event - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - An Event row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Type - - - - Constructor - - Name - Type - Flags - - - - Created from a row in the Event table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this Event row - Row ID - If is null - If is invalid - - - - - - - A high-level representation of a row in the ExportedType table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - - - - - - - - - - From column ExportedType.Flags - - - - Attributes - - - - From column ExportedType.TypeDefId - - - - - - - - From column ExportedType.TypeName - - - - - - - - From column ExportedType.TypeNamespace - - - - - - - - From column ExportedType.Implementation - - - - - - - - - - Called to initialize - - - - true if it's nested within another - - - - - Gets the declaring type, if any - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit. See also - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this type has been moved to another assembly - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - Source module or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Converts this instance to a - - A new instance - - - - - - - An ExportedType row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - TypeDef ID - Type name - Type namespace - Flags - Implementation - - - - Created from a row in the ExportedType table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this ExportedType row - Row ID - If is null - If is invalid - - - - Field flags, see CorHdr.h/CorFieldAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Field may only be initialized, not written to after init. - - - Value is compile time constant. - - - Field does not have to be serialized when type is remoted. - - - field is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Runtime(metadata internal APIs) should check name encoding. - - - Field has marshalling information. - - - Field has default. - - - Field has RVA. - - - - A high-level representation of a row in the Field table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - From column Field.Flags - - - - Attributes - - - - From column Field.Name - - - - Name - - - - From column Field.Signature - - - - - - - - Gets/sets the field layout offset - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the field RVA - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the initial value. Be sure to set to true if - you write to this field. - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - Gets/sets the - - - - - - - - true if is not null - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - Gets/sets the field type - - - - - Modify field: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the field access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Returns the full name of this field - - - - - Gets the size of this field in bytes or 0 if unknown. - - - - - Gets the size of this field in bytes or 0 if unknown. - - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Updated with size - true if is valid, false otherwise - - - - Gets the size of this field in bytes or 0 if unknown. - - The declaring type of this - The field signature of this - Size of a pointer - Updated with size - true if is valid, false otherwise - - - - - - - A Field row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Signature - - - - Constructor - - Name - Signature - Flags - - - - Created from a row in the Field table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Field row - Row ID - If is null - If is invalid - - - - File row flags. See CorHdr.h/CorFileFlags - - - - This is not a resource file - - - This is a resource file or other non-metadata-containing file - - - - A high-level representation of a row in the File table - - - - - The row id in its table - - - - - - - - - - - - - - - - - From column File.Flags - - - - Attributes - - - - From column File.Name - - - - Name - - - - From column File.HashValue - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - A File row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name of file - Flags - File hash - - - - Created from a row in the File table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this File row - Row ID - If is null - If is invalid - - - - Redirects .NET framework assembly references from older to newer versions - - - - - Redirects a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - Module using the assembly reference - - - - Tries to redirect a .NET Framework assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Module using the assembly reference - Updated with the redirected assembly if successful - - - - - Redirects a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Redirects a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Current assembly reference that might get updated - - - - Tries to redirect a .NET Framework 2.0-3.5 assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Tries to redirect a .NET Framework 4.0+ assembly from an older version to the correct version - loaded at runtime. - - Assembly reference - Updated with the redirected assembly if successful - - - - - Helps create a name - - - - - Checks whether the assembly name should be included when printing - the full type name. The assembly name isn't required in custom attributes - when the type already exists in the same module as the CA, or if the type - exists in mscorlib. - - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Creates type names, method names, etc. - - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - true if the assembly name must be included, false otherwise - - - - Checks whether the assembly name should be included when printing the full name. - See for more info. - - Owner module - The type (TypeDef, TypeRef or ExportedType) - or null - If false, don't add an assembly name if it's a type in , - if true, don't add an assembly name if it's a type in or the corlib. - true if the assembly name must be included, false otherwise - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The IType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Property signature - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a property - - Declaring type full name or null if none - Name of property - Event type - Type generic arguments or null if none - String builder to use or null - Property full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a field - - Declaring type full name or null if none - Name of field - Field signature - Type generic arguments or null if none - String builder to use or null - Field full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a method - - Declaring type full name or null if none - Name of method or null if none - Method signature - Type generic arguments or null if none - Method generic arguments or null if none - Generic parameter owner method or null - String builder to use or null - Method full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a property sig - - Property sig - String builder to use or null - Property sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the full name of a sig - - Declaring type or null - Name or null - Method sig - Owner method or null - String builder to use or null - Sig full name - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeRef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeRef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeRef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeRef - A or null if none found - - - - Gets the scope - - The TypeRef - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeRef - A or null if none found - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeDef - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeDef - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeDef - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeDef - A or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeDef - A or null if none found - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The TypeSpec - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The TypeSpec - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSpec - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSpec - A or null if none found - - - - Gets the scope type - - The TypeSpec - The scope type or null if none found - - - - Gets the scope - - The TypeSpec - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSpec - A or null if none found - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The type sig - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the full name of a - - The type sig - Set if output should be compatible with reflection - Helps print the name - Type generic args or null if none - Method generic args or null if none - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The TypeSig - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The TypeSig - A or null if none found - - - - Gets the scope - - The TypeSig - The or null if none found - - - - Gets the scope type - - The TypeSig - The scope type or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The TypeSig - A or null if none found - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the namespace of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The namespace - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the name of a - - The ExportedType - Set if output should be compatible with reflection - String builder to use or null - The name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the full name of a - - The ExportedType - Set if output should be compatible with reflection - Helps print the name - String builder to use or null - The full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly qualified full name of a - - The ExportedType - Helps print the name - String builder to use or null - The assembly qualified full name - - - - Returns the assembly where this type is defined - - The ExportedType - A or null if none found - - - - Gets the scope type - - The ExportedType - The scope type or null if none found - - - - Gets the scope - - The ExportedType - The or null if none found - - - - Returns the owner module. The type was created from metadata in this module. - - The ExportedType - A or null if none found - - - - - - - Constructor - - true if it's for generic types, false if generic methods - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Resolves a generic argument - - Generic variable number - A or null if none was found - - - - Replaces generic type/method var with its generic argument - - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Pushes generic arguments - - The generic arguments - - - - Pops generic arguments - - The popped generic arguments - - - - Replaces a generic type/method var with its generic argument (if any). If - isn't a generic type/method var or if it can't - be resolved, it itself is returned. Else the resolved type is returned. - - Type signature - New which is never null unless - is null - - - - A high-level representation of a row in the GenericParam table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner type/method - - - - - - - - Gets the declaring type or null if none or if is - not a - - - - - - - - Gets the declaring method or null if none or if is - not a - - - - - From column GenericParam.Number - - - - - - - - From column GenericParam.Flags - - - - Attributes - - - - From column GenericParam.Name - - - - Name - - - - From column GenericParam.Kind (v1.1 only) - - - - - - - - Gets the generic param constraints - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not empty - - - - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets variance (non, contra, co) - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the special constraint - - - - - true if there are no special constraints - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - - - - - - - - - - - - - - - - A GenericParam row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic param number - - - - Constructor - - The generic param number - Flags - - - - Constructor - - The generic param number - Flags - Name - - - - Created from a row in the GenericParam table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this GenericParam row - Row ID - If is null - If is invalid - - - - - - - Generic parameter flags. See CorHdr.h/CorGenericParamAttr - - - - - - - - - - - - - - - - - - - - - - type argument must be a reference type - - - type argument must be a value type but not Nullable - - - type argument must have a public default constructor - - - - A high-level representation of a row in the GenericParamConstraint table - - - - - The row id in its table - - - - - - - - - - - - - - Gets the owner generic param - - - - - - - - From column GenericParamConstraint.Constraint - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - A GenericParamConstraintAssembly row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The constraint - - - - Created from a row in the GenericParamConstraint table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this GenericParamConstraint row - Row ID - Generic parameter context - If is null - If is invalid - - - - Generic parameter context - - - - - Type context - - - - - Method context - - - - - true if and are both null - - - - - Creates a new instance and initializes the - field to 's - and the field to . - - Method - A new instance - - - - Creates a new instance and initializes the - field to and the field - to null - - Type - A new instance - - - - Constructor - - Type context - - - - Constructor. The field is set to null and NOT to - 's . Use - if you want that behavior. - - Method context - - - - Constructor - - Type context - Method context - - - - Resolves assemblies - - - - - Finds and returns an - - The assembly to find - The module that needs to resolve an assembly or null - An instance owned by the assembly resolver or - null if the assembly couldn't be found. - - - - The table row can be referenced by a MD token - - - - - Returns the metadata token - - - - - Gets/sets the row ID - - - - - All *MD classes implement this interface. - - - - - Gets the original row ID - - - - - An assembly. Implemented by , and - . - - - - - The assembly version - - - - - Assembly flags - - - - - Public key or public key token - - - - - Locale, aka culture - - - - - Gets the full name of the assembly but use a public key token - - - - - Gets/sets the bit - - - - - Gets/sets the processor architecture - - - - - Gets/sets the processor architecture - - - - - true if unspecified processor architecture - - - - - true if neutral (PE32) architecture - - - - - true if x86 (PE32) architecture - - - - - true if IA-64 (PE32+) architecture - - - - - true if x64 (PE32+) architecture - - - - - true if ARM (PE32) architecture - - - - - true if eg. reference assembly (not runnable) - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the content type - - - - - true if content type is Default - - - - - true if content type is WindowsRuntime - - - - - Implemented by and , which are the only - valid managed entry point tokens. - - - - - Interface to access a module def/ref - - - - - Type of scope - - - - - It's an instance - - - - - It's a instance - - - - - It's a instance - - - - - Implemented by modules and assemblies - - - - - Gets the scope type - - - - - Gets the scope name - - - - - Interface to get the full name of a type, field, or method - - - - - Gets the full name - - - - - Simple name of implementer - - - - - Implemented by all member refs and types - - - - - Gets the owner module - - - - - Methods to check whether the implementer is a type or a method. - - - - - true if it's a type - - - - - true if it's a method - - - - - Implemented by types, fields, methods, properties, events - - - - - Gets the declaring type - - - - - true if it's a or a that's - referencing a field. - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - All member definitions implement this interface: , - , , , - , and . - - - - - Gets the declaring type - - - - - Implemented by the following classes: , - , , , - , , , - and - - - - - Implemented by types and methods - - - - - Gets the number of generic parameters / arguments - - - - - Implemented by fields ( and ) - - - - - Gets/sets the field signature - - - - - Implemented by methods (, and ) - - - - - Method signature - - - - - Implemented by tables that can be a token in the ldtoken instruction - - - - - The table row can be referenced by a coded token - - - - - TypeDefOrRef coded token interface - - - - - The coded token tag - - - - - HasConstant coded token interface - - - - - The coded token tag - - - - - Gets/sets the constant value - - - - - HasCustomAttribute coded token interface - - - - - The coded token tag - - - - - Gets all custom attributes - - - - - true if is not empty - - - - - HasFieldMarshal coded token interface - - - - - The coded token tag - - - - - Gets/sets the marshal type - - - - - true if is not null - - - - - HasDeclSecurity coded token interface - - - - - The coded token tag - - - - - Gets the permission sets - - - - - true if is not empty - - - - - MemberRefParent coded token interface - - - - - The coded token tag - - - - - HasSemantic coded token interface - - - - - The coded token tag - - - - - MethodDefOrRef coded token interface - - - - - The coded token tag - - - - - MemberForwarded coded token interface - - - - - The coded token tag - - - - - Gets/sets the impl map - - - - - true if is not null - - - - - Implementation coded token interface - - - - - The coded token tag - - - - - CustomAttributeType coded token interface - - - - - The coded token tag - - - - - ResolutionScope coded token interface - - - - - The coded token tag - - - - - TypeOrMethodDef coded token interface - - - - - The coded token tag - - - - - Gets the generic parameters - - - - - true if is not empty - - - - - HasCustomDebugInformation interface - - - - - The custom debug information tag - - - - - Gets the custom debug infos - - - - - true if is not empty - - - - - Access to .NET core library's simple types - - - - - Gets a System.Void - - - - - Gets a System.Boolean - - - - - Gets a System.Char - - - - - Gets a System.SByte - - - - - Gets a System.Byte - - - - - Gets a System.Int16 - - - - - Gets a System.UInt16 - - - - - Gets a System.Int32 - - - - - Gets a System.UInt32 - - - - - Gets a System.Int64 - - - - - Gets a System.UInt64 - - - - - Gets a System.Single - - - - - Gets a System.Double - - - - - Gets a System.String - - - - - Gets a System.TypedReference - - - - - Gets a System.IntPtr - - - - - Gets a System.UIntPtr - - - - - Gets a System.Object - - - - - Gets the assembly reference to the core library - - - - - Gets a that references a type in the core library assembly - - Namespace of type (eg. "System") - Name of type - A instance. This instance may be a cached instance. - - - - Custom attribute interface. Implemented by and - - - - - - Gets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Interface to decrypt methods - - - - - Gets the method's body - - Method rid - The found in the method's Method row - The method's parameters - Generic parameter context - Updated with the method's if this - method returns true - true if the method body was decrypted, false if the method isn't - encrypted and the default body reader code should be used. - - - - Interface to decrypt strings - - - - - Reads a string - - String token - A string or null if we should read it from the #US heap - - - - events - - - - - An error was detected. An exception should normally be thrown but the error - can be ignored. - - - - - Just a warning and can be ignored. - - - - - A normal message - - - - - A verbose message - - - - - A very verbose message - - - - - Simple logger - - - - - Log something - - Caller or null - Logger event - Format - Arguments - - - - true if this event is ignored. If the event is ignored, the caller can - choose not to call . This is useful if it can take time to - prepare the message. - - The logger event - - - - Dummy logger which ignores all messages, but can optionally throw on errors. - - - - - It ignores everything and doesn't throw anything. - - - - - Throws a on errors, but ignores anything else. - - - - - Constructor - - If non-null, this exception type is thrown on - errors. It must have a public constructor that takes a as the only - argument. - - - - - - - - - - A high-level representation of a row in the ImplMap table - - - - - The row id in its table - - - - - - - - - - - From column ImplMap.MappingFlags - - - - Attributes - - - - From column ImplMap.ImportName - - - - Name - - - - From column ImplMap.ImportScope - - - - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the char set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets best fit - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets throw on unmappable char - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets calling convention - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - true if it's the specified P/Invoke method, else false - - - - Checks whether this is a certain P/Invoke method - - Name of the DLL - Name of the function within the DLL - Treat as Windows - true if it's the specified P/Invoke method, else false - - - - An ImplMap row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Scope - Name - Flags - - - - Created from a row in the ImplMap table - - - - - - - - Constructor - - The module which contains this ImplMap row - Row ID - If is null - If is invalid - - - - options - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s whenever possible if the is located - in this module. - - - - - Use s, s and s - whenever possible if the definition is located in this module. - - - - - - - - Don't set this flag. For internal use only. - - - - - Re-maps entities that were renamed in the target module - - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Matches source to the one that is already present in the target module under a different name. - - referenced by the entity that is being imported. - matching or null if there's no match. - - - - Overrides default behavior of - May be used to use reference assemblies for resolution, for example. - - to create for. - or null to use default 's type resolution - - - - Imports s, s, s - and s as references - - - - - Constructor - - The module that will own all references - - - - Constructor - - The module that will own all references - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - - - - Constructor - - The module that will own all references - Importer options - Generic parameter context - Mapper for renamed entities - - - - Imports a as a . If it's a type that should be - the declaring type of a field/method reference, call instead. - - The type - The imported type or null if is invalid - - - - Imports a as a . Should be called if it's the - declaring type of a method/field reference. See also - - The type - - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - A list of all required modifiers or null - A list of all optional modifiers or null - The imported type or null if is invalid - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a . This will be either - a or a . - - The method - Always verify method signature to make sure the - returned reference matches the metadata in the source assembly - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a - - The field - Always verify field signature to make sure the - returned reference matches the metadata in the source assembly - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The sig - The imported sig or null if input is invalid - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as an - - The field - The imported type or null if is invalid - - - - Imports a as an - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - A high-level representation of a row in the InterfaceImpl table - - - - - The row id in its table - - - - - - - - - - - - - - From column InterfaceImpl.Interface - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - An InterfaceImpl row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The interface the type implements - - - - Created from a row in the InterfaceImpl table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this InterfaceImpl row - Row ID - Generic parameter context - If is null - If is invalid - - - - Resolves types, methods, fields - - - - - Resolves types - - - - - Resolves a type - - The type - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves fields and methods - - - - - Resolves a method or a field - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves tokens - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Interface to get the full name of a type - - - - - true if it's a value type - - - - - Returns the name of this type - - - - - Returns the reflection name of this type - - - - - Returns the namespace of this type - - - - - Returns the reflection namespace of this type - - - - - Returns the reflection name of this type. See also . - - - - - Returns the reflection name of this type, and includes the assembly name where the - type is located. It can be passed to to - load the type. - - - - - Gets the assembly where this type is defined - - - - - Gets the scope, which is different from since it - can differentiate between modules within the same assembly. - - - - - Gets the type whose scope is returned by and whose assembly - is returned by . This is always a - , or null. It can also be a - nested . - For example, if this type is a System.String&, then this value is a System.String. - If it's a generic instance type (eg. List<int>), then the generic type is - returned (eg. List<T>). In other words, the first or - that is found (without searching generic arguments) is returned. - - - - - true if it's an integer or a floating point type - - - - - Implemented by types and calling convention signatures. - - - - - true if this contains a or a . - - - - - Finds s - - - - - Finds a - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . 's scope (i.e., module or - assembly) is ignored when looking up the type. - - The type ref - An existing or null if it wasn't found. - - - - Interface to access a local or a parameter - - - - - Gets the variable type - - - - - Gets the 0-based position - - - - - Gets/sets the variable name - - - - - A high-level representation of a row in the ManifestResource table - - - - - The row id in its table - - - - - - - - - - - - - - From column ManifestResource.Offset - - - - - - - - From column ManifestResource.Flags - - - - Attributes - - - - From column ManifestResource.Name - - - - Name - - - - From column ManifestResource.Implementation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - A ManifestResource row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - Implementation - - - - Constructor - - Name - Implementation - Flags - - - - Constructor - - Name - Implementation - Flags - Offset - - - - Created from a row in the ManifestResource table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ManifestResource row - Row ID - If is null - If is invalid - - - - ManifestResource flags. See CorHdr.h/CorManifestResourceFlags - - - - - - - The Resource is exported from the Assembly. - - - The Resource is private to the Assembly. - - - - Reads s - - - - - Reads a from the #Blob heap - - Module - Blob offset - A new instance - - - - Reads a from the #Blob heap - - Module - Blob offset - Generic parameter context - A new instance - - - - Reads a from - - Owner module - Marshal data - A new instance - - - - Reads a from - - Owner module - Marshal data - Generic parameter context - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - A new instance - - - - Reads a from - - Owner module - A reader that will be owned by us - Generic parameter context - A new instance - - - - Base class of all marshal types - - - - - The native type - - - - - Gets the - - - - - Constructor - - Native type - - - - - - - Contains the raw marshal blob data - - - - - Gets/sets the raw data - - - - - Constructor - - Raw data - - - - A marshal type - - - - - Gets/sets the size - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - - - - A marshal type - - - - - Gets/sets the variant type - - - - - Gets/sets the user-defined sub type (it's usually null) - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Variant type - - - - Constructor - - User-defined sub type - - - - Constructor - - Variant type - User-defined sub type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the size - - - - - true if is valid - - - - - true if is valid - - - - - Default constructor - - - - - Constructor - - Size - - - - Constructor - - Size - Element type - - - - - - - A marshal type - - - - - Gets/sets the element type - - - - - Gets/sets the parameter number - - - - - Gets/sets the size of the array - - - - - Gets/sets the flags - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if is valid - - - - - true if ntaSizeParamIndexSpecified bit is set, false if it's not - set or if is invalid. - - - - - true if ntaSizeParamIndexSpecified bit is not set, false if it's - set or if is invalid. - - - - - Default constructor - - - - - Constructor - - Element type - - - - Constructor - - Element type - Parameter number - - - - Constructor - - Element type - Parameter number - Number of elements - - - - Constructor - - Element type - Parameter number - Number of elements - Flags - - - - - - - A marshal type - - - - - Gets/sets the GUID string - - - - - Gets/sets the native type name string - - - - - Gets/sets the custom marshaler - - - - - Gets/sets the cookie string - - - - - Default constructor - - - - - Constructor - - GUID string - - - - Constructor - - GUID string - Native type name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - - - - Constructor - - GUID string - Native type name string - Custom marshaler name string - Cookie string - - - - - - - A , or a - marshal type - - - - - Gets/sets the IID parameter index - - - - - true if is valid - - - - - Constructor - - Native type - - - - Constructor - - Native type - IID parameter index - - - - - - - Metadata token - - - - - Mask to get the rid from a raw metadata token - - - - - Max rid value - - - - - Number of bits to right shift a raw metadata token to get the table index - - - - - Returns the table type - - - - - Returns the row id - - - - - Returns the raw token - - - - - Returns true if it's a null token - - - - - Constructor - - Raw token - - - - Constructor - - Raw token - - - - Constructor - - The table type - Row id - - - - Constructor - - The table type - Row id - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the rid (row ID) - - A raw metadata token - A rid - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Returns the table - - A raw metadata token - A metadata table index - - - - Gets the token as a raw 32-bit signed integer - - - - - Gets the token as a raw 32-bit unsigned integer - - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Represents the #Blob stream - - - - - - - - - - - Reads data - - Offset of data - The data or null if invalid offset - - - - Reads data just like , but returns an empty array if - offset is invalid - - Offset of data - The data - - - - Creates a reader that can access a blob - - Offset of blob - A new stream - - - - Creates a reader that can access a blob or returns false on failure - - Offset of blob - Updated with the reader - - - - - Contains all possible coded token classes - - - - TypeDefOrRef coded token - - - HasConstant coded token - - - HasCustomAttribute coded token - - - HasFieldMarshal coded token - - - HasDeclSecurity coded token - - - MemberRefParent coded token - - - HasSemantic coded token - - - MethodDefOrRef coded token - - - MemberForwarded coded token - - - Implementation coded token - - - CustomAttributeType coded token - - - ResolutionScope coded token - - - TypeOrMethodDef coded token - - - HasCustomDebugInformation coded token - - - - Returns all types of tables - - - - - Returns the number of bits that is used to encode table type - - - - - Constructor - - Number of bits used to encode token type - All table types - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - - - - - Encodes a token - - The token - Coded token - true if successful - - - - Encodes a token - - The token - Coded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token or 0 on failure - - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Decodes a coded token - - The coded token - Decoded token - true if successful - - - - Info about one column in a MD table - - - - - Gets the column index - - - - - Returns the column offset within the table row - - - - - Returns the column size - - - - - Returns the column name - - - - - Returns the ColumnSize enum value - - - - - Constructor - - Column index - The column name - Column size - - - - Constructor - - Column index - The column name - Column size - Offset of column - Size of column - - - - Reads the column - - A reader positioned on this column - The column value - - - - Writes a column - - The writer position on this column - The column value - - - - MD table column size - - - - RID into Module table - - - RID into TypeRef table - - - RID into TypeDef table - - - RID into FieldPtr table - - - RID into Field table - - - RID into MethodPtr table - - - RID into Method table - - - RID into ParamPtr table - - - RID into Param table - - - RID into InterfaceImpl table - - - RID into MemberRef table - - - RID into Constant table - - - RID into CustomAttribute table - - - RID into FieldMarshal table - - - RID into DeclSecurity table - - - RID into ClassLayout table - - - RID into FieldLayout table - - - RID into StandAloneSig table - - - RID into EventMap table - - - RID into EventPtr table - - - RID into Event table - - - RID into PropertyMap table - - - RID into PropertyPtr table - - - RID into Property table - - - RID into MethodSemantics table - - - RID into MethodImpl table - - - RID into ModuleRef table - - - RID into TypeSpec table - - - RID into ImplMap table - - - RID into FieldRVA table - - - RID into ENCLog table - - - RID into ENCMap table - - - RID into Assembly table - - - RID into AssemblyProcessor table - - - RID into AssemblyOS table - - - RID into AssemblyRef table - - - RID into AssemblyRefProcessor table - - - RID into AssemblyRefOS table - - - RID into File table - - - RID into ExportedType table - - - RID into ManifestResource table - - - RID into NestedClass table - - - RID into GenericParam table - - - RID into MethodSpec table - - - RID into GenericParamConstraint table - - - RID into Document table - - - RID into MethodDebugInformation table - - - RID into LocalScope table - - - RID into LocalVariable table - - - RID into LocalConstant table - - - RID into ImportScope table - - - RID into StateMachineMethod table - - - RID into CustomDebugInformation table - - - 8-bit byte - - - 16-bit signed int - - - 16-bit unsigned int - - - 32-bit signed int - - - 32-bit unsigned int - - - Index into #Strings stream - - - Index into #GUID stream - - - Index into #Blob stream - - - TypeDefOrRef encoded token - - - HasConstant encoded token - - - HasCustomAttribute encoded token - - - HasFieldMarshal encoded token - - - HasDeclSecurity encoded token - - - MemberRefParent encoded token - - - HasSemantic encoded token - - - MethodDefOrRef encoded token - - - MemberForwarded encoded token - - - Implementation encoded token - - - CustomAttributeType encoded token - - - ResolutionScope encoded token - - - TypeOrMethodDef encoded token - - - HasCustomDebugInformation encoded token - - - - See COMIMAGE_FLAGS_XXX in CorHdr.h in the Windows SDK - - - - - See COMIMAGE_FLAGS_ILONLY in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITREQUIRED in the Windows SDK - - - - - Set if a native header exists (COMIMAGE_FLAGS_IL_LIBRARY) - - - - - See COMIMAGE_FLAGS_STRONGNAMESIGNED in the Windows SDK - - - - - See COMIMAGE_FLAGS_NATIVE_ENTRYPOINT in the Windows SDK - - - - - See COMIMAGE_FLAGS_TRACKDEBUGDATA in the Windows SDK - - - - - See COMIMAGE_FLAGS_32BITPREFERRED in the Windows SDK - - - - - Used when a #~ stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - A custom .NET metadata stream - - - - - Constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - .NET metadata stream - - - - - Reader that can access the whole stream. - - NOTE: Always copy this field to a local variable before using it since it must be thread safe. - - - - - null if it wasn't present in the file - - - - - - - - - - - Gets the length of this stream in the metadata - - - - - Gets the stream header - - - - - Gets the name of the stream - - - - - Gets a data reader that can read the full stream - - - - - - Default constructor - - - - - Constructor - - Data reader factory - Offset of metadata - The stream header - - - - Called after gets recreated - - - - - - - - Dispose method - - true if called by - - - - Checks whether an index is valid - - The index - true if the index is valid - - - - Check whether an offset is within the stream - - Stream offset - true if the offset is valid - - - - Check whether an offset is within the stream - - Stream offset - Size of data - true if the offset is valid - - - - Base class of #US, #Strings, #Blob, and #GUID classes - - - - - - - - - - - Initializes .NET table row sizes - - - - - Initializes the table sizes - - true if #Strings size >= 0x10000 - true if #GUID size >= 0x10000 - true if #Blob size >= 0x10000 - Count of rows in each table - Count of rows in each table (debug tables) - - - - Creates the table infos - - Major table version - Minor table version - All table infos (not completely initialized) - - - - Creates the table infos - - Major table version - Minor table version - Initialized to max present tables (eg. 42 or 45) - All table infos (not completely initialized) - - - - Used when a #- stream is present in the metadata - - - - - - - - - - - - - - - - - - - - - - - Converts a logical Field rid to a physical Field rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Method rid to a physical Method rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Param rid to a physical Param rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Event rid to a physical Event rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - Converts a logical Property rid to a physical Property rid - - A valid rid - Converted rid or any invalid rid value if is invalid - - - - - - - - - - - - - - - - - - - Gets a rid list (eg. field list) - - Source table, eg. TypeDef - Row ID in - Column index in , eg. 4 for TypeDef.FieldList - Destination table, eg. Field - A new instance - - - - - - - Linear searches the table (O(n)) for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - - - - Represents the #GUID stream - - - - - - - - - - - - - - Read a - - Index into this stream - A or null if is 0 or invalid - - - - Heap type. The values are set in stone by MS. Don't change. - - - - #Strings heap - - - #GUID heap - - - #Blob heap - - - #US heap - - - - Represents the IMAGE_COR20_HEADER structure - - - - - Returns true if it has a native header - - - - - Returns the IMAGE_COR20_HEADER.cb field - - - - - Returns the IMAGE_COR20_HEADER.MajorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.MinorRuntimeVersion field - - - - - Returns the IMAGE_COR20_HEADER.Metadata field - - - - - Returns the IMAGE_COR20_HEADER.Flags field - - - - - Returns the IMAGE_COR20_HEADER.EntryPointToken/EntryPointTokenRVA field - - - - - Returns the IMAGE_COR20_HEADER.Resources field - - - - - Returns the IMAGE_COR20_HEADER.StrongNameSignature field - - - - - Returns the IMAGE_COR20_HEADER.CodeManagerTable field - - - - - Returns the IMAGE_COR20_HEADER.VTableFixups field - - - - - Returns the IMAGE_COR20_HEADER.ExportAddressTableJumps field - - - - - Returns the IMAGE_COR20_HEADER.ManagedNativeHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Reads metadata table columns - - - - - Reads a column - - The table to read from - Table row id - The column to read - Result - true if was updated, false if - the column should be read from the original table. - - - - Reads table rows - - Raw row - - - - Reads a table row or returns false if the row should be read from the original table - - Row id - The row - - - - - Version strings found in the meta data header - - - - - MS CLR 1.0 version string (.NET 1.0) - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.0 version string (.NET 1.0). This is an incorrect version that shouldn't be used. - - - - - MS CLR 1.1 version string (.NET 1.1) - - - - - MS CLR 2.0 version string (.NET 2.0-3.5) - - - - - MS CLR 4.0 version string (.NET 4.0-4.5) - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.0 any version - - - - - MS CLR 1.1 any version - - - - - MS CLR 2.0 any version - - - - - MS CLR 4.0 any version - - - - - ECMA 2002 version string - - - - - ECMA 2005 version string - - - - - Portable PDB v1.0 - - - - - MDStream flags - - - - #Strings stream is big and requires 4 byte offsets - - - #GUID stream is big and requires 4 byte offsets - - - #Blob stream is big and requires 4 byte offsets - - - - - - - - - Extra data follows the row counts - - - Set if certain tables can contain deleted rows. The name column (if present) is set to "_Deleted" - - - - A MD table (eg. Method table) - - - - - - - - - - - Gets the table - - - - - Gets the name of this table - - - - - Returns total number of rows - - - - - Gets the total size in bytes of one row in this table - - - - - Returns all the columns - - - - - Returns true if there are no valid rows - - - - - Returns info about this table - - - - - Constructor - - The table - Number of rows in this table - Info about this table - - - - Checks whether the row exists - - Row ID - - - - Checks whether the row does not exist - - Row ID - - - - - - - Reads .NET metadata - - - - - true if the compressed (normal) metadata is used, false if the non-compressed - (Edit N' Continue) metadata is used. This can be false even if the table stream - is #~ but that's very uncommon. - - - - - true if this is standalone Portable PDB metadata - - - - - Gets the .NET header - - - - - Gets the version found in the metadata header. The major version number is in the high 16 bits - and the lower version number is in the low 16 bits. - - - - - Gets the version string found in the metadata header - - - - - Gets the - - - - - Gets the metadata header - - - - - Returns the #Strings stream or a default empty one if it's not present - - - - - Returns the #US stream or a default empty one if it's not present - - - - - Returns the #Blob stream or a default empty one if it's not present - - - - - Returns the #GUID stream or a default empty one if it's not present - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Pdb stream or null if it's not a standalone portable PDB file - - - - - Gets all streams - - - - - Gets a list of all the valid TypeDef rids. It's usually every rid in the - TypeDef table, but could be less if a type has been deleted. - - - - - Gets a list of all the valid ExportedType rids. It's usually every rid in the - ExportedType table, but could be less if a type has been deleted. - - - - - Gets the Field rid list - - TypeDef rid - A new instance - - - - Gets the Method rid list - - TypeDef rid - A new instance - - - - Gets the Param rid list - - Method rid - A new instance - - - - Gets the Event rid list - - EventMap rid - A new instance - - - - Gets the Property rid list - - PropertyMap rid - A new instance - - - - Finds all InterfaceImpl rids owned by - - Owner TypeDef rid - A instance containing the valid InterfaceImpl rids - - - - Finds all GenericParam rids owned by in table - - A TypeOrMethodDef table - Owner rid - A instance containing the valid GenericParam rids - - - - Finds all GenericParamConstraint rids owned by - - Owner GenericParam rid - A instance containing the valid GenericParamConstraint rids - - - - Finds all CustomAttribute rids owned by in table - - A HasCustomAttribute table - Owner rid - A instance containing the valid CustomAttribute rids - - - - Finds all DeclSecurity rids owned by in table - - A HasDeclSecurity table - Owner rid - A instance containing the valid DeclSecurity rids - - - - Finds all MethodSemantics rids owned by in table - - A HasSemantic table - Owner rid - A instance containing the valid MethodSemantics rids - - - - Finds all MethodImpl rids owned by - - Owner TypeDef rid - A instance containing the valid MethodImpl rids - - - - Finds a ClassLayout rid - - Owner TypeDef rid - The ClassLayout rid or 0 if is invalid - or if it has no row in the ClassLayout table. - - - - Finds a FieldLayout rid - - Owner Field rid - The FieldLayout rid or 0 if is invalid - or if it has no row in the FieldLayout table. - - - - Finds a FieldMarshal rid - - A HasFieldMarshal table - Owner rid - The FieldMarshal rid or 0 if is invalid - or if it has no row in the FieldMarshal table. - - - - Finds a FieldRVA rid - - Owner Field rid - The FieldRVA rid or 0 if is invalid - or if it has no row in the FieldRVA table. - - - - Finds an ImplMap rid - - A MemberForwarded table - Owner rid - The ImplMap rid or 0 if is invalid - or if it has no row in the ImplMap table. - - - - Finds a NestedClass rid - - Owner TypeDef rid - The NestedClass rid or 0 if is invalid - or if it has no row in the NestedClass table. - - - - Finds an EventMap rid - - Owner TypeDef rid - The EventMap rid or 0 if is invalid - or if it has no row in the EventMap table. - - - - Finds a PropertyMap rid - - Owner TypeDef rid - The PropertyMap rid or 0 if is invalid - or if it has no row in the PropertyMap table. - - - - Finds a Constant rid - - A HasConstant table - Owner rid - The Constant rid or 0 if is invalid - or if it has no row in the Constant table. - - - - Returns the owner TypeDef rid - - A Field rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Method rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Event rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeDef rid - - A Property rid - The owner TypeDef rid or 0 if is invalid - or if it has no owner. - - - - Returns the owner TypeOrMethodDef rid - - A GenericParam rid - The owner TypeOrMethodDef rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner GenericParam rid - - A GenericParamConstraint rid - The owner GenericParam rid or 0 if is - invalid or if it has no owner. - - - - Returns the owner Method rid - - A Param rid - The owner Method rid or 0 if is invalid - or if it has no owner. - - - - Gets a list of all nested classes owned by - - A TypeDef rid - A new instance - - - - Gets a list of all non-nested classes. A type is a non-nested type if - returns an empty list. - - A new instance - - - - Finds all LocalScope rids owned by - - Owner Method rid - A instance containing the valid LocalScope rids - - - - Gets the StateMachineMethod rid or 0 if it's not a state machine method - - Owner Method rid - - - - - Finds all CustomDebugInformation rids owned by in table - - A HasCustomDebugInformation table - Owner rid - A instance containing the valid CustomDebugInformation rids - - - - Disposes of this instance - - - - - Common base class for #~ and #- metadata classes - - - - - The PE image - - - - - The .NET header - - - - - The MD header - - - - - The #Strings stream - - - - - The #US stream - - - - - The #Blob stream - - - - - The #GUID stream - - - - - The #~ or #- stream - - - - - The #Pdb stream - - - - - All the streams that are present in the PE image - - - - true if this is standalone Portable PDB metadata - - - - Sorts a table by key column - - - - - Remembers rid and key - - - - - Constructor - - Row ID - Key - - - - Constructor - - The MD table - Index of key column - - - - Binary searches for a row with a certain key - - The key - The row or 0 if not found - - - - Find all rids that contain - - The key - A new instance - - - - Constructor - - The PE image - The .NET header - The MD header - - - - Initializes the metadata, tables, streams - - - - - Creates empty heap objects if they're not present in the metadata - - - - - Called by - - - - - Binary searches the table for a rid whose key column at index - is equal to . - - Table to search - Key column index - Key - The rid of the found row, or 0 if none found - - - - Finds all rows owned by in table - whose index is - - Table to search - Key column index - Key - A instance - - - - Finds all rows owned by in table - whose index is . Should be called if - could be unsorted. - - Table to search - Key column index - Key - A instance - - - - Dispose method - - true if called by - - - - Low level access to a .NET file's metadata - - - - - Create a instance - - The PE image - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - A new instance - - - - Create a instance - - The PE image - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a instance - - The PE image - Runtime reader kind - true if we should verify that it's a .NET PE file - A new instance - - - - Create a standalone portable PDB instance - - Metadata stream - true if we should verify that it's a .NET PE file - A new instance - - - - Represents the .NET metadata header - - IMAGE_COR20_HEADER.Metadata points to this header - - - - Returns the signature (should be 0x424A5342) - - - - - Returns the major version - - - - - Returns the minor version - - - - - Returns the reserved dword (pointer to extra header data) - - - - - Returns the version string length value - - - - - Returns the version string - - - - - Returns the offset of STORAGEHEADER - - - - - Returns the flags (reserved) - - - - - Returns the reserved byte (padding) - - - - - Returns the number of streams - - - - - Returns all stream headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Constructor - - PE file reader pointing to the start of this section - Runtime reader kind - Verify section - Thrown if verification fails - - - - #Pdb stream - - - - - Gets the PDB id - - - - - Gets the entry point token or 0 - - - - - Gets the referenced type system tables in the PE metadata file - - - - - Gets all type system table rows. This array has exactly 64 elements. - - - - - - - - Equality comparer for all raw rows - - - - - Default instance - - - - - Raw contents of an uncompressed Module table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeDef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Field table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Method table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ParamPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Param table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed InterfaceImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MemberRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Constant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomAttribute table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldMarshal table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed DeclSecurity table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ClassLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldLayout table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StandAloneSig table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed EventPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Event table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed PropertyPtr table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Property table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSemantics table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodImpl table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ModuleRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed TypeSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImplMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed FieldRVA table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCLog table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ENCMap table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Assembly table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRef table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefProcessor table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed AssemblyRefOS table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed File table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ExportedType table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ManifestResource table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed NestedClass table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParam table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodSpec table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed GenericParamConstraint table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed Document table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed MethodDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalVariable table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed LocalConstant table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed ImportScope table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed StateMachineMethod table row - - - - - Gets a column - - Index of column - - - - - Raw contents of an uncompressed CustomDebugInformation table row - - - - - Gets a column - - Index of column - - - - - Stores a list of rids - - - - - Gets the empty instance - - - - - Creates a new instance - - - - - - - - Creates a new instance - - List of valid rids - - - - - Gets the 'th rid - - Index. Must be < - A rid or 0 if is invalid - - - - Gets the number of rids it will iterate over - - - - - Enumerator - - - - - Gets the current rid - - - - - Disposes this instance - - - - - Moves to the next rid - - - - - - Gets the enumerator - - - - - - Storage flags found in the MD header - - - - - Normal flags - - - - - More data after the header but before the streams. - - The CLR will fail to load the file if this flag (or any other bits) is set. - - - - A metadata stream header - - - - - The offset of the stream relative to the start of the metadata header - - - - - The size of the stream - - - - - The name of the stream - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the #Strings stream - - - - - - - - - - - Reads a - - Offset of string - A instance or null if invalid offset - - - - Reads a . The empty string is returned if - is invalid. - - Offset of string - A instance - - - - The metadata tables - - - - Module table (00h) - - - TypeRef table (01h) - - - TypeDef table (02h) - - - FieldPtr table (03h) - - - Field table (04h) - - - MethodPtr table (05h) - - - Method table (06h) - - - ParamPtr table (07h) - - - Param table (08h) - - - InterfaceImpl table (09h) - - - MemberRef table (0Ah) - - - Constant table (0Bh) - - - CustomAttribute table (0Ch) - - - FieldMarshal table (0Dh) - - - DeclSecurity table (0Eh) - - - ClassLayout table (0Fh) - - - FieldLayout table (10h) - - - StandAloneSig table (11h) - - - EventMap table (12h) - - - EventPtr table (13h) - - - Event table (14h) - - - PropertyMap table (15h) - - - PropertyPtr table (16h) - - - Property table (17h) - - - MethodSemantics table (18h) - - - MethodImpl table (19h) - - - ModuleRef table (1Ah) - - - TypeSpec table (1Bh) - - - ImplMap table (1Ch) - - - FieldRVA table (1Dh) - - - ENCLog table (1Eh) - - - ENCMap table (1Fh) - - - Assembly table (20h) - - - AssemblyProcessor table (21h) - - - AssemblyOS table (22h) - - - AssemblyRef table (23h) - - - AssemblyRefProcessor table (24h) - - - AssemblyRefOS table (25h) - - - File table (26h) - - - ExportedType table (27h) - - - ManifestResource table (28h) - - - NestedClass table (29h) - - - GenericParam table (2Ah) - - - MethodSpec table (2Bh) - - - GenericParamConstraint table (2Ch) - - - (Portable PDB) Document table (30h) - - - (Portable PDB) MethodDebugInformation table (31h) - - - (Portable PDB) LocalScope table (32h) - - - (Portable PDB) LocalVariable table (33h) - - - (Portable PDB) LocalConstant table (34h) - - - (Portable PDB) ImportScope table (35h) - - - (Portable PDB) StateMachineMethod table (36h) - - - (Portable PDB) CustomDebugInformation table (37h) - - - - Info about one MD table - - - - - Returns the table type - - - - - Returns the total size of a row in bytes - - - - - Returns all the columns - - - - - Returns the name of the table - - - - - Constructor - - Table type - Table name - All columns - - - - Constructor - - Table type - Table name - All columns - Row size - - - - .NET metadata tables stream - - - - - Gets/sets the column reader - - - - - Gets/sets the Method table reader - - - - - Gets the reserved field - - - - - Gets the version. The major version is in the upper 8 bits, and the minor version - is in the lower 8 bits. - - - - - Gets - - - - - Gets the reserved log2 rid field - - - - - Gets the valid mask - - - - - Gets the sorted mask - - - - - Gets the extra data - - - - - Gets the MD tables - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Constructor - - factory - Offset of metadata - Stream header - - - - Constructor - - factory - Offset of metadata - Stream header - Runtime kind - - - - Initializes MD tables - - Type system table rows (from #Pdb stream) - - - - - - - - - - Returns a MD table - - The table type - A or null if table doesn't exist - - - - Checks whether a table exists - - The table type - true if the table exists - - - - Checks whether table is sorted - - The table - - - - Reads a raw Module row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeDef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Field row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Method row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ParamPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Param row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw InterfaceImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MemberRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Constant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomAttribute row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldMarshal row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw DeclSecurity row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ClassLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldLayout row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StandAloneSig row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw EventPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Event row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw PropertyPtr row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Property row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSemantics row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodImpl row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ModuleRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw TypeSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImplMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw FieldRVA row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCLog row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ENCMap row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Assembly row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRef row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefProcessor row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw AssemblyRefOS row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw File row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ExportedType row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ManifestResource row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw NestedClass row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParam row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodSpec row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw GenericParamConstraint row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw Document row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw MethodDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalVariable row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw LocalConstant row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw ImportScope row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw StateMachineMethod row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a raw CustomDebugInformation row or returns false if the row doesn't exist - - Row ID - Row data - - - - - Reads a column - - The table - Row ID - Column index in - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Reads a column - - The table - Row ID - Column - Result is put here or 0 if we return false - true if we could read the column, false otherwise - - - - Represents the #US stream - - - - - - - - - - - Reads a unicode string - - Offset of unicode string - A string or null if is invalid - - - - Reads data just like , but returns an empty string if - offset is invalid - - Offset of unicode string - The string - - - - Finds types, fields, methods, etc in a module. If nothing has been added to the module, it's - faster to call ResolveMethodDef(), ResolveTypeRef() etc. - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - All found s - - - - - Finds all types, fields, etc - - The module to scan - Itself - - - - Methods to load properties to make sure they're initialized - - - - - Read every collection element - - Collection element type - Collection - - - - Load the object instance - - The value (ignored) - - - - A high-level representation of a row in the MemberRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - From column MemberRef.Class - - - - - - - - From column MemberRef.Name - - - - Name - - - - From column MemberRef.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - true if this is a method reference ( != null) - - - - - true if this is a field reference ( != null) - - - - - Gets/sets the method sig - - - - - Gets/sets the field sig - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - - - - Gets the full name - - - - - Get the declaring type's full name - - Full name or null if there's no declaring type - - - - Resolves the method/field - - A or a instance or null - if it couldn't be resolved. - - - - Resolves the method/field - - A or a instance - If the method/field couldn't be resolved - - - - Resolves the field - - A instance or null if it couldn't be resolved. - - - - Resolves the field - - A instance - If the field couldn't be resolved - - - - Resolves the method - - A instance or null if it couldn't be resolved. - - - - Resolves the method - - A instance - If the method couldn't be resolved - - - - Gets a that can be used as signature context - - Context passed to the constructor - Field/method class owner - - - - - - - - A MemberRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Name of ref - - - - Constructor - - Owner module - Name of field ref - Field sig - - - - Constructor - - Owner module - Name of field ref - Field sig - Owner of field - - - - Constructor - - Owner module - Name of method ref - Method sig - - - - Constructor - - Owner module - Name of method ref - Method sig - Owner of method - - - - Created from a row in the MemberRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MemberRef row - Row ID - Generic parameter context - If is null - If is invalid - - - - Method attributes, see CorHdr.h/CorMethodAttr - - - - member access mask - Use this mask to retrieve accessibility information. - - - Member not referenceable. - - - Member not referenceable. - - - Accessible only by the parent type. - - - Accessible by sub-types only in this Assembly. - - - Accessibly by anyone in the Assembly. - - - Accessible only by type and sub-types. - - - Accessibly by sub-types anywhere, plus anyone in assembly. - - - Accessibly by anyone who has visibility to this scope. - - - Defined on type, else per instance. - - - Method may not be overridden. - - - Method virtual. - - - Method hides by name+sig, else just by name. - - - vtable layout mask - Use this mask to retrieve vtable attributes. - - - The default. - - - Method always gets a new slot in the vtable. - - - Overridability is the same as the visibility. - - - Method does not provide an implementation. - - - Method is special. Name describes how. - - - Implementation is forwarded through pinvoke. - - - Managed method exported via thunk to unmanaged code. - - - Runtime should check name encoding. - - - Method has security associate with it. - - - Method calls another method containing security code. - - - - A high-level representation of a row in the Method table - - - - - The row id in its table - - - - - All parameters - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column Method.RVA - - - - - - - - From column Method.ImplFlags - - - - Implementation attributes - - - - From column Method.Flags - - - - Attributes - - - - From column Method.Name - - - - Name - - - - From column Method.Signature - - - - - - - - From column Method.ParamList - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - Initializes - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets/sets the method body. See also - - - - - - - - - - - Frees the method body if it has been loaded. This does nothing if - returns false. - - - - Called to initialize - - - - true if can free the method body - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the methods this method implements - - - - - - - Initializes - - - - Gets the export info or null if the method isn't exported to unmanaged code. - - - - - - - - - - - - - - true if is not empty - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets/sets the CIL method body. See also - - - - - Gets/sets the native method body - - - - - true if there's at least one in - - - - - true if it has a - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets the full name - - - - - Gets/sets the - - - - - Gets the parameters - - - - - - - - true if the method has a hidden 'this' parameter - - - - - true if the method has an explicit 'this' parameter - - - - - Gets the calling convention - - - - - Gets/sets the method return type - - - - - true if the method returns a value (i.e., return type is not ) - - - - - Gets/sets the method semantics attributes. If you remove/add a method to a property or - an event, you must manually update this property or eg. won't - work as expected. - - - - Set when has been initialized - - - - - - Initializes - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the method access - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the code type - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the static type constructor - - - - - true if this is an instance constructor - - - - - true if this is a static or an instance constructor - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - A Method row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Method name - - - - Constructor - - Method name - Method sig - - - - Constructor - - Method name - Method sig - Flags - - - - Constructor - - Method name - Method sig - Impl flags - - - - Constructor - - Method name - Method sig - Impl flags - Flags - - - - Created from a row in the Method table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Method row - Row ID - If is null - If is invalid - - - - - - - - - - Contains the name and ordinal of a method that gets exported to unmanaged code. - - - - - Gets the ordinal or null - - - - - Gets the name. If it's null, and is also null, the name of the method - () is used as the exported name. - - - - - Gets the options - - - - - Constructor - - - - - Constructor - - Name or null to export by ordinal - - - - Constructor - - Ordinal - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - - - - Constructor - - Name or null to export by ordinal - Ordinal or null to export by name - Options - - - - Exported method options - - - - - No bit is set - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - Method impl attributes, see CorHdr.h/CorMethodImpl - - - - Flags about code type. - - - Method impl is IL. - - - Method impl is native. - - - Method impl is OPTIL - - - Method impl is provided by the runtime. - - - Flags specifying whether the code is managed or unmanaged. - - - Method impl is unmanaged, otherwise managed. - - - Method impl is managed. - - - Indicates method is defined; used primarily in merge scenarios. - - - Indicates method sig is not to be mangled to do HRESULT conversion. - - - Reserved for internal use. - - - Method is single threaded through the body. - - - Method may not be inlined. - - - Method should be inlined if possible. - - - Method may not be optimized. - - - Method may contain hot code and should be aggressively optimized. - - - The JIT compiler should look for security mitigation attributes, such as the user-defined System.Runtime.CompilerServices.SecurityMitigationsAttribute. If found, the JIT compiler applies any related security mitigations. Available starting with .NET Framework 4.8. - - - - Describes which method some method implements - - - - - The method body. Usually a but could be a - - - - - The method implements - - - - - Constructor - - Method body - The method implements - - - - Method semantics flags, see CorHdr.h/CorMethodSemanticsAttr - - - - No bit is set - - - Setter for property - - - Getter for property - - - other method for property or event - - - AddOn method for event - - - RemoveOn method for event - - - Fire method for event - - - - A high-level representation of a row in the MethodSpec table - - - - - The row id in its table - - - - - - - - - - - - - - From column MethodSpec.Method - - - - - - - - From column MethodSpec.Instantiation - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - - - - - - - Gets/sets the generic instance method sig - - - - - - - - - - - Gets the full name - - - - - - - - A MethodSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - The generic method - - - - Constructor - - The generic method - The instantiated method sig - - - - Created from a row in the MethodSpec table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this MethodSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - context - - - - - Gets/sets the assembly resolver. This is never null. - - - - - Gets/sets the resolver. This is never null. - - - - - Default constructor - - - - - Constructor - - Assembly resolver or null - - - - Constructor - - Type/method/field resolver or null - - - - Constructor - - Assembly resolver or null - Type/method/field resolver or null - - - - creation options - - - - - Module context - - - - - PDB reader options - - - - - Set it to A) the path (string) of the PDB file, B) the data (byte[]) of the PDB file or - C) to an of the PDB data. The will - be owned by the module. You don't need to initialize - - - - - If true, will load the PDB file from disk if present, or an embedded portable PDB file - stored in the PE file. The default value is true. - You don't need to initialize . - - - - - corlib assembly reference to use or null if the default one from the opened - module should be used. - - - - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - - Default constructor - - - - - Constructor - - Module context - - - - Constructor - - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Constructor - - Module context - Runtime reader kind, default is . It should be - set to if it's an obfuscated Mono/Unity assembly. - - - - Runtime reader kind - - - - - Microsoft's CLRs (.NET Framework, .NET Core) - - - - - Mono's CLR (Mono, Unity) - - - - - A high-level representation of a row in the Module table - - - - Default characteristics - - - Default DLL characteristics - - - - The row id in its table - - - - - Initialize this in the ctor - - - - - PDB state - - - - - Array of last used rid in each table. I.e., next free rid is value + 1 - - - - Module context - - - - - - - - - - - - - - - - Gets/sets a user value. This is never used by dnlib. This property isn't thread safe. - - - - - - - - - - - Gets/sets Module.Generation column - - - - - - - - Gets/sets Module.Name column - - - - Name - - - - Gets/sets Module.Mvid column - - - - - - - - Gets/sets Module.EncId column - - - - - - - - Gets/sets Module.EncBaseId column - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets the module's assembly. To set this value, add this - to . - - - - - - - - Gets a list of all non-nested s. See also - - - - - - - Initializes - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the native entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - Gets/sets the managed entry point. Only one of and - can be set. You write to one and the other one gets cleared. - - - - - - - - - - - - - Called to initialize - - - Called to initialize - - - - - - - Gets/sets the entry point method - - - - - true if is non-zero - - - - - true if is non-null - - - - - true if is non-null - - - - - Gets a list of all s - - - - - - - Initializes - - - - Gets/sets the . This is null if there are no - vtable fixups. - - - - - - - - - - Called to initialize - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - - - - Gets/sets the path of the module or an empty string if it wasn't loaded from disk - - - - - - - - Gets the - - - - - Gets the instance - - - - - Gets/sets the module context. This is never null. - - - - - If true, the cache is enabled. The cache is used by - and to find types. -

- IMPORTANT: Only enable the cache if this module's types keep their exact - name, namespace, and declaring type and if no type is either added or - removed from or from any type that is reachable from the - top-level types in (i.e., any type owned by this module). - This is disabled by default. When disabled, all calls to - and will result in a slow O(n) (linear) search. -
- -
- - - true if this is the manifest (main) module - - - - - Gets the global (aka. <Module>) type or null if there are no types - - - - - true if it's the core library module, false if it's not the core library module, - and null if it's not known. - - - - - Gets/sets the Win32 resources - - - - - - - - - - Called to initialize - - - - Gets the . This is null if no PDB file - has been loaded or if no PDB file could be found. - - - - - Module kind - - - - - Gets/sets the characteristics (from PE file header) - - - - - Gets/sets the DLL characteristics (from PE optional header) - - - - - Gets/sets the runtime version which is stored in the metadata header. - See . - - Not thread safe - - - - Gets the WinMD status - - Not thread safe - - - - true if this is a WinMD file - - - - - true if this is a managed WinMD file - - - - - true if this is a pure (non-managed) WinMD file - - - - - Gets the CLR runtime version of the managed WinMD file or null if none. This is - similar to for normal non-WinMD files. - - Not thread safe - - - - Gets the WinMD version or null if none - - Not thread safe - - - - true if is the CLR v1.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.0 string - - - - - true if is the CLR v1.1 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v1.1 string - - - - - true if is the CLR v1.0 or v1.1 string (only the - major and minor version numbers are checked) - - - - - true if is the CLR v1.0 or v1.1 string - - - - - true if is the CLR v2.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v2.0 string - - - - - true if is the CLR v4.0 string (only the major - and minor version numbers are checked) - - - - - true if is the CLR v4.0 string - - - - - true if is the ECMA 2002 string - - - - - true if is the ECMA 2005 string - - - - - Gets/sets the (from PE header) - - - - - true if is , , ... - - - - - true if is - - - - - true if is , , ... - - - - - true if is , , ... - - - - - true if is , , ... - - - - - Gets/sets the (from .NET header) - - - - - - - - Gets/sets the runtime version number in the COR20 header. The major version is - in the high 16 bits. The minor version is in the low 16 bits. This is normally 2.5 - (0x00020005), but if it's .NET 1.x, it should be 2.0 (0x00020000). If this is - null, the default value will be used when saving the module (2.0 if CLR 1.x, - and 2.5 if not CLR 1.x). - - - - - Gets the tables header version. The major version is in the upper 8 bits and the - minor version is in the lower 8 bits. .NET 1.0/1.1 use version 1.0 (0x0100) and - .NET 2.x and later use version 2.0 (0x0200). 1.0 has no support for generics, - 1.1 has support for generics (GenericParam rows have an extra Kind column), - and 2.0 has support for generics (GenericParam rows have the standard 4 columns). - No other version is supported. If this is null, the default version is - used (1.0 if .NET 1.x, else 2.0). - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - Dispose method - - true if called by - - - - Gets all the types (including nested types) present in this module - - - - - Adds as a non-nested type. If it's already nested, its - will be set to null. - - The to insert - - - - Updates the rid to the next free rid available. It's only updated if - the original rid is 0. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Updates the rid to the next free rid available. - - IMDTokenProvider - The row that should be updated - Returns the input - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The type - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported field or null if is invalid - or if we failed to import the field - - - - Imports a as a . This will be either - a or a . - - The method - The imported method or null if is invalid - or if we failed to import the method - - - - Imports a - - The type - The imported type or null - - - - Imports a as a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The type - The imported type or null - - - - Imports a - - The field - The imported type or null if is invalid - - - - Imports a as a - - The field - The imported type or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a as a - - The method - The imported method or null if is invalid - - - - Imports a - - The method - The imported method or null if is invalid - - - - Imports a - - The member ref - The imported member ref or null if is invalid - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the module to a stream. - - Destination stream - - - - Writes the module to a stream. - - Destination stream - Writer options - - - - Resets the cache which can be enabled by setting - to true. Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - Creates a new - - PDB file kind - - - - Sets a - - New - - - - Returns the size of a pointer. Assumes it's 32-bit if pointer size is unknown or - if it can be 32-bit or 64-bit. - - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size if it's not known or if it - can be 32-bit or 64-bit - Size of a pointer (4 or 8) - - - - Returns the size of a pointer - - Default pointer size - Pointer size if it's prefer-32-bit (should usually be 4) - - - - - - - - - - - - - - - - - - - - Finds a . For speed, enable - if possible (read the documentation first). - - Full name of the type (no assembly information) - true if it's a reflection name, and nested - type names are separated by a + character. If false, nested type names - are separated by a / character. - An existing or null if it wasn't found. - - - - Finds a . Its scope (i.e., module or assembly) is ignored when - looking up the type. For speed, enable if possible - (read the documentation first). - - The type ref - An existing or null if it wasn't found. - - - - Finds a - - The type - A or null if it wasn't found - - - - Creates a new instance. There should normally only be one - instance shared by all s. - - A new instance - - - - Load everything in this module. All types, fields, asm refs, etc are loaded, all their - properties are read to make sure everything is cached. - - Cancellation token or null - - - - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a token - - The metadata token - A or null if is invalid - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Gets all s - - - - - Gets all s - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - - - - Gets all s. s with generic parameters - aren't cached and a new copy is always returned. - - Generic parameter context - - - - Gets all s - - - - - Finds an assembly reference by name. If there's more than one, pick the one with - the greatest version number. - - Simple name of assembly (eg. "mscorlib") - The found or null if there's no such - assembly reference. - - - - Compare asm refs' version - - First asm ref - New asm ref - - - - - A Module row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - is initialized to a random - Module nam - - - - Constructor - - Module name - Module version ID - - - - Constructor - - Module name - Module version ID - Corlib assembly ref or null - - - - Created from a row in the Module table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Module row - Row ID - If is null - If is invalid - - - - Initialize fields from the raw Module row - - - - - Created from a row in the Module table - - - - The file that contains all .NET metadata - - - - Gets/sets the method decrypter - - - - - Gets/sets the string decrypter - - - - - Returns the .NET metadata interface - - - - - Returns the #~ or #- tables stream - - - - - Returns the #Strings stream - - - - - Returns the #Blob stream - - - - - Returns the #GUID stream - - - - - Returns the #US stream - - - - - - - - - - - - - - - - - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a file - - File name of an existing .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a byte[] - - Contents of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module context or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a reflection module - - An existing reflection module - Module creation options or null - Image layout of the module in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - A new instance - - - - Creates a instance - - PE image - A new instance - - - - Creates a instance - - PE image - Module context or null - A new instance - - - - Creates a instance - - PE image - Module creation options or null - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module context or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a memory location - - Address of a .NET module/assembly - Module creation options or null - Image layout of the file in memory - A new instance - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module context or null - A new instance - If is null - - - - Creates a instance from a stream - - This will read all bytes from the stream and call . - It's better to use one of the other Load() methods. - The stream (owned by caller) - Module creation options or null - A new instance - If is null - - - - Creates a instance from a - - The metadata - Module creation options or null - A new instance that now owns - - - - Constructor - - The metadata - Module creation options or null - If is null - - - - Loads symbols using - - PDB symbol reader - - - - Loads symbols from a PDB file - - PDB file name - - - - Loads symbols from a PDB file - - PDB reader options - PDB file name - - - - Loads symbols from a byte array - - PDB data - - - - Loads symbols from a byte array - - PDB reader options - PDB data - - - - Loads symbols from a stream - - PDB file stream which is now owned by us - - - - Loads symbols from a stream - - PDB reader options - PDB file stream which is now owned by us - - - - Loads symbols if a PDB file is available - - - - - Loads symbols if a PDB file is available - - PDB reader options - - - - Finds a mscorlib - - An existing instance or null if it wasn't found - - - - Called when no corlib assembly reference was found - - - - - - - - - Resolves a token - - The metadata token - Generic parameter context - A or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves an - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - The row ID - A instance or null if is invalid - - - - Resolves a - - The row ID - Generic parameter context - A instance or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasConstant coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - A or null if is invalid - - - - Resolves a - - A HasCustomAttribute coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasFieldMarshal coded token - A or null if is invalid - - - - Resolves a - - A HasDeclSecurity coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - A or null if is invalid - - - - Resolves a - - A MemberRefParent coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A HasSemantic coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - A or null if is invalid - - - - Resolves a - - A MethodDefOrRef coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A MemberForwarded coded token - A or null if is invalid - - - - Resolves an - - An Implementation coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - A or null if is invalid - - - - Resolves a - - A CustomAttributeType coded token - Generic parameter context - A or null if is invalid - - - - Resolves a - - A ResolutionScope coded token - A or null if is invalid - - - - Resolves a - - A TypeOrMethodDef> coded token - A or null if is invalid - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a from the blob - - Table of owner - Row ID of owner - Generic parameter context - A new instance or null if there's no field - marshal for this owner. - - - - Reads a CIL method body - - Method parameters - RVA - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Reads a CIL method body - - Method parameters - RVA - Generic parameter context - A new instance. It's empty if RVA is invalid (eg. 0 or - it doesn't point to a CIL method body) - - - - Returns the owner type of a field - - The field - The owner type or null if none - - - - Returns the owner type of a method - - The method - The owner type or null if none - - - - Returns the owner type of an event - - The event - The owner type or null if none - - - - Returns the owner type of a property - - The property - The owner type or null if none - - - - Returns the owner type/method of a generic param - - The generic param - The owner type/method or null if none - - - - Returns the owner generic param of a generic param constraint - - The generic param constraint - The owner generic param or null if none - - - - Returns the owner method of a param - - The param - The owner method or null if none - - - - Reads a module - - File rid - The assembly owning the module we should read - A new instance or null if - is invalid or if it's not a .NET module. - - - - Gets a list of all File rids that are .NET modules. Call - to read one of these modules. - - A new instance - - - - Concatenates the inputs and returns the result if it's a valid path - - Base dir - File name - Full path to the file or null if one of the inputs is invalid - - - - Gets the base directory where this .NET module is located on disk - - Base directory or null if unknown or if an error occurred - - - - Creates a instance - - ManifestResource rid - A new instance - - - - Reads a - - Custom attribute rid - A new instance or null if - is invalid - - - - Reads a - - Custom attribute rid - Generic parameter context - A new instance or null if - is invalid - - - - Reads data somewhere in the address space of the image - - RVA of data - Size of data - All the data or null if or - is invalid - - - - Gets the native entry point or 0 if none - - - - - Gets the managed entry point (a Method or a File) or null if none - - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - A new instance - - - - Reads a new instance. This one is not cached. - - Row ID - Generic parameter context - A new instance - - - - Reads a method body - - Method - Method RVA - Method impl attrs - Generic parameter context - A or null if none - - - - Updates with the PDB info (if any) - - Owner method - Method body - Returns originak value - - - - Reads a string from the #US heap - - String token - A non-null string - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - - - - Writes the mixed-mode module to a file on disk. If the file exists, it will be overwritten. - - Filename - Writer options - - - - Writes the mixed-mode module to a stream. - - Destination stream - - - - Writes the mixed-mode module to a stream. - - Destination stream - Writer options - - - - Reads data from the #Blob. The following columns are returned: - Field.Signature - Method.Signature - MemberRef.Signature - Constant.Value - CustomAttribute.Value - FieldMarshal.NativeType - DeclSecurity.PermissionSet - StandAloneSig.Signature - Property.Type - TypeSpec.Signature - Assembly.PublicKey - AssemblyRef.PublicKeyOrToken - File.HashValue - MethodSpec.Instantiation - - A token - The value in the #Blob or null if is invalid - - - - Module kind - - - - - Console UI module - - - - - Windows GUI module - - - - - DLL module - - - - - Netmodule (it has no assembly manifest) - - - - - A high-level representation of a row in the ModuleRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - From column ModuleRef.Name - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - Gets the definition module, i.e., the module which it references, or null - if the module can't be found. - - - - - Gets the definition assembly, i.e., the assembly of the module it references, or - null if the assembly can't be found. - - - - - - - - - - - A ModuleRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - - - - Constructor - - Owner module - Module name - - - - Created from a row in the ModuleRef table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this ModuleRef row - Row ID - If is null - If is invalid - - - - Native types used by field marshals. See CorHdr.h/CorNativeType - - - - Deprecated - - - void - - - bool - - - int8 - - - unsigned int8 - - - int16 - - - unsigned int16 - - - int32 - - - unsigned int32 - - - int64 - - - unsigned int64 - - - float32 - - - float64 - - - syschar - - - variant - - - currency - - - ptr - - - decimal - - - date - - - bstr - - - lpstr - - - lpwstr - - - lptstr - - - fixed sysstring - - - objectref - - - iunknown - - - idispatch - - - struct - - - interface - - - safearray - - - fixed array - - - int - - - uint - - - nested struct - - - byvalstr - - - ansi bstr - - - tbstr - - - variant bool - - - func - - - as any - - - array - - - lpstruct - - - custom marshaler - - - error - - - iinspectable - - - hstring - - - UTF-8 encoded string - - - first invalid element type - - - Value wasn't present in the blob - - - Raw marshal blob type - - - - A resolver that always fails - - - - - The one and only instance of this type - - - - - - - - - - - - - - Parameter flags. See CorHdr.h/CorParamAttr - - - - Param is [In] - - - Param is [out] - - - Param is a locale identifier - - - Param is a return value - - - Param is optional - - - Param has default value. - - - Param has FieldMarshal. - - - - A high-level representation of a row in the Param table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - Gets the declaring method - - - - - - - - From column Param.Flags - - - - Attributes - - - - From column Param.Sequence - - - - - - - - From column Param.Name - - - - Name - - - - - - - - - - - - Called to initialize - - - Reset - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - true if is not null - - - - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - A Param row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Sequence - - - - Constructor - - Name - Sequence - Flags - - - - Created from a row in the Param table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this Param row - Row ID - If is null - If is invalid - - - - A list of all method parameters - - - - - Gets the owner method - - - - - Gets the number of parameters, including a possible hidden 'this' parameter - - - - - Gets the index of the first parameter that is present in the method signature. - If this is a static method, the value is 0, else it's an instance method so the - index is 1 since the first parameter is the hidden 'this' parameter. - - - - - Gets the N'th parameter - - The parameter index - - - - Gets the method return parameter - - - - - Constructor - - The method with all parameters - 's declaring type - - - - Should be called when the method's declaring type has changed - - Method declaring type - - - - Should be called when the method sig has changed - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - A method parameter - - - - - The hidden 'this' parameter's - - - - - The return type parameter's - - - - - Gets the parameter index. If the method has a hidden 'this' parameter, that parameter - has index 0 and the remaining parameters in the method signature start from index 1. - The method return parameter has index -1. - - - - - Gets the index of the parameter in the method signature. See also - and - - - - - true if it's a normal visible method parameter, i.e., it's not the hidden - 'this' parameter and it's not the method return type parameter. - - - - - true if it's the hidden 'this' parameter - - - - - true if it's the method return type parameter - - - - - Gets the parameter type - - - - - Gets the owner method - - - - - Gets the or null if not present - - - - - true if it has a - - - - - Gets the name from . If is null, - an empty string is returned. - - - - - Constructor - - Parameter index - - - - Constructor - - Parameter index - Parameter type - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - - - - Constructor - - Parameter index (0 is hidden this param if it exists) - Index in method signature - Parameter type - - - - Creates a if it doesn't already exist - - - - - - - - Custom debug info guids - - - - - Implements and uses a as the underlying - stream. - - - - - Constructor - - Source stream - - - - Constructor - - Source stream - Name of original file or null if unknown. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - IMAGE_DEBUG_DIRECTORY - - - - - An address in the image - - - - - Section - - - - - Offset in - - - - - Constructor - - Section - Offset in - - - - Constructor - - Section - Offset in - - - - Returns true if is less than or equal to - - First - Second - - - - - Returns true if is less than - - First - Second - - - - - Returns true if is greater than or equal to - - First - Second - - - - - Returns true if is greater than - - First - Second - - - - - Returns true if is equal to - - First - Second - - - - - Returns true if is not equal to - - First - Second - - - - - Compares this instance with and returns less than 0 if it's - less than , 0 if it's equal to and - greater than 0 if it's greater than - - Other instance - - - - - Compares this to another instance - - The other one - true if they're equal - - - - Compares this to another instance - - The other one - true if they're equal - - - - Gets the hash code - - Hash code - - - - ToString() override - - - - - - Reads a 32-bit offset followed by a 16-bit section and creates a new - - Reader - - - - - Exception that is thrown when encounters an error. - - - - - Constructor - - - - - Constructor - - Exception message - - - - Constructor - - Inner exception - - - - Constructor - - - - - - - A managed PDB reader implementation for .NET modules. - - - - - Read the PDB in the specified stream. - - PDB file data reader - - - - Creates a instance - - - - - Creates a new instance - - PDB context - PDB file stream which is now owned by this method - A new instance or null. - - - - A constant in a method scope, eg. "const int SomeConstant = 123;" - - - - - Gets/sets the name - - - - - Gets/sets the type of the constant - - - - - Gets/sets the value of the constant - - - - - Constructor - - - - - Constructor - - Name of constant - Type of constant - Constant value - - - - - - - - - - Gets all custom debug infos - - - - - ToString() - - - - - - Custom debug info kind - - See CustomDebugInfoKind in Roslyn source code - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Unknown - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Base class of custom debug info added to the PDB file by the compiler - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Unknown custom debug info. If you see an instance of this class, you're using an old dnlib version or - dnlib hasn't been updated to support this new custom debug info kind. - - - - - Gets the custom debug info kind - - - - - Gets the custom debug info guid, see - - - - - Gets the data - - - - - Constructor - - Custom debug info kind - Raw custom debug info data - - - - Constructor - - Custom debug info guid - Raw custom debug info data - - - - Contains sizes of using groups - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the using counts - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains a reference to another method that contains the import strings - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - Contains a reference to another method that contains the per-module debug info (assembly reference aliases) - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the referenced method - - - - - Constructor - - - - - Constructor - - The referenced method - - - - State machine hosted local scope info - - - - - true if it's a syntesized local ( and are both null) - - - - - The instruction of the first operation in the scope. Can be null if it's a synthesized local - - - - - The instruction of the first operation outside of the scope or null if it ends at the last instruction in the body. - Can also be null if it's a synthesized local (in which case is also null, see ) - - - - - Constructor - - Start of the scope - First instruction after the end of the scope - - - - Contains local scopes for state machine hoisted local variables. - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the scopes - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the state machine type - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the state machine type - - - - - Constructor - - - - - Constructor - - State machine type - - - - Contains dynamic flags for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the dynamic locals - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Dynamic local info - - - - - Gets the dynamic flags - - - - - Gets/sets the name of the local. The name must have at most 64 characters and no char can be NUL (0x0000). - If null is written, is returned instead. - - - - - true if it's a constant and not a variable ( is null) - - - - - true if it's a variable ( is not null) - - - - - Gets/sets the local. Could be null if there's no local (it's a 'const' local). - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains the EnC local variable slot map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLocalSlotMap - - - - - Constructor - - Raw custom debug info data - - - - Contains the EnC lambda map - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the data. Spec: https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#EditAndContinueLambdaAndClosureMap - - - - - Constructor - - Raw custom debug info data - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Tuple element name info - - - - - Gets/sets the name of the local. If null is written, is returned instead. - - - - - Gets/sets the local. It's null if it's a constant, and non-null if it's a variable - - - - - true if it's a constant. Constants have a scope ( and ) - - - - - true if it's a variable. Variables don't have a scope ( and ) - - - - - Gets/sets the start of the scope or null. Only constants have a scope. - - - - - Gets/sets the end of the scope or null if it has no scope or if the scope ends at the end of the body. Only constants have a scope. - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Contains tuple element names for local variables and constants - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the tuple element names - - - - - Constructor - - - - - Constructor - - Initial capacity of - - - - Async method stepping info - - It's internal and translated to a - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the catch handler instruction or null - - - - - Gets all async step infos - - - - - Constructor - - - - - Default namespace - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the default namespace - - - - - Constructor - - - - - Constructor - - Default namespace - - - - Dynamic flags - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the dynamic flags - - - - - Constructor - - - - - Constructor - - Dynamic flags - - - - Contains the source code - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source code blob. - - It's not decompressed and converted to a string because the encoding isn't specified. - - https://github.com/dotnet/corefx/blob/master/src/System.Reflection.Metadata/specs/PortablePdb-Metadata.md#embedded-source-c-and-vb-compilers - - - - - Constructor - - - - - Constructor - - Source code blob - - - - Contains the source link file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source link file contents - - - - - Constructor - - - - - Constructor - - Source link file contents - - - - Contains the source server file - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the source server file contents - - - - - Constructor - - - - - Constructor - - Source server file contents - - - - Async method info - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets/sets the starting method that initiates the async operation - - - - - Gets/sets the instruction for the compiler generated catch handler that wraps an async method. - This can be null. - - - - - Gets all step infos used by the debugger - - - - - Constructor - - - - - Constructor - - Default capacity for - - - - Async step info used by debuggers - - - - - The yield instruction - - - - - Resume method - - - - - Resume instruction (where the debugger puts a breakpoint) - - - - - Constructor - - The yield instruction - Resume method - Resume instruction (where the debugger puts a breakpoint) - - - - Iterator method - - - - - Returns - - - - - Gets the custom debug info guid, see - - - - - Gets the kickoff method - - - - - Constructor - - - - - Constructor - - Kickoff method - - - - A PDB document - - - - - Gets/sets the document URL - - - - - Gets/sets the language GUID. See - - - - - Gets/sets the language vendor GUID. See - - - - - Gets/sets the document type GUID. See - - - - - Gets/sets the checksum algorithm ID. See - - - - - Gets/sets the checksum - - - - - - - - - - - Gets all custom debug infos - - - - - Default constructor - - - - - Constructor - - A instance - - - - Constructor - - Document URL - Language. See - Language vendor. See - Document type. See - Checksum algorithm ID. See - Checksum - - - - - - - - - - PDB document constants - - - - - PDB file kind - - - - - Windows PDB - - - - - Portable PDB - - - - - Embedded portable PDB - - - - - Import scope - - - - - Constructor - - - - - Gets/sets the parent import scope - - - - - Gets all imports - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - Import kind - - - - - PDB import base class - - - - - Gets the import kind - - - - - Import namespace - - - - - Returns - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - Import assembly, namespace - - - - - Returns - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import type - - - - - Returns - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - Import xml namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Import assembly reference alias - - - - - Returns - - - - - Gets the alias - - - - - Constructor - - - - - Constructor - - - - - - Alias assembly reference - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Constructor - - - - - Constructor - - - - - - - Alias namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - Alias assembly namespace - - - - - Returns - - - - - Gets the alias - - - - - Gets the target assembly - - - - - Gets the target namespace - - - - - Constructor - - - - - Constructor - - - - - - - - Alias type - - - - - Returns - - - - - Gets the alias - - - - - Gets the target type - - - - - Constructor - - - - - Constructor - - - - - - - A local variable - - - - - Constructor - - - - - Constructor - - - - - - - - Gets/sets the local - - - - - Gets/sets the name - - - - - Gets/sets the attributes - - - - - Gets the index of the local - - - - - true if it should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - - - - - - - Gets all custom debug infos - - - - - Local attributes - - - - - No bit is set - - - - - Local should be hidden in debugger variables windows. Not all compiler generated locals have this flag set. - - - - - A PDB method - - - - - Gets/sets the root scope. It contains all scopes of the method, using namespaces, variables and constants - - - - - Constructor - - - - - PDB reader options - - - - - No bit is set - - - - - Use the COM Windows PDB reader instead of the managed Windows PDB reader. - - This is NOT recommended since the COM reader can only be called on the same - thread it was created on. It also requires a Windows OS. - - If this is not set, the managed PDB reader will be used. - - This option is only used if it's a Windows PDB file, not if it's a Portable PDB file. - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - Only used if is set and if it's a Windows PDB file - - - - - Don't use diasymreader.dll's PDB reader that is shipped with .NET Framework. - - Only used if is set and if it's a Windows PDB file - - - - - A PDB scope - - - - - Constructor - - - - - Gets/sets the first instruction - - - - - Gets/sets the last instruction. It's null if it ends at the end of the method. - - - - - Gets all child scopes - - - - - true if is not empty - - - - - Gets all locals in this scope - - - - - true if is not empty - - - - - Gets all namespaces (Windows PDBs). Portable PDBs use - - - - - true if is not empty - - - - - Gets/sets the import scope (Portable PDBs). Windows PDBs use - - - - - Gets all constants - - - - - true if is not empty - - - - - - - - - - - Gets all custom debug infos - - - - - PDB state for a - - - - - Gets/sets the PDB file kind. You can change it from portable PDB to embedded portable PDB - and vice versa. Converting a Windows PDB to a portable PDB isn't supported. - - - - - Gets/sets the user entry point method. - - - - - Gets all PDB documents - - - - - true if is not empty - - - - - Constructor - - Module - PDB file kind - - - - Constructor - - A instance - Owner module - - - - Adds - - New document - if it wasn't inserted, or the already existing document - if it was already inserted. - - - - Removes - - Document - true if it was removed, false if it wasn't inserted. - - - - Returns an inserted instance or null if it's not been - inserted yet. - - A PDB document - The existing or null if it doesn't exist. - - - - Removes all documents - - - - - - Removes all documents and optionally returns them - - true if all the original s - should be returned. - All s if is true - or null if is false. - - - - Constructor - - Module that resolves assembly and type references - Portable PDB blob stream - - - - PDB sequence point - - - - - PDB document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - Clones this instance - - A new cloned instance - - - - Async step info - - - - - Yield offset - - - - - Breakpoint offset - - - - - Breakpoint method token - - - - - Constructor - - Yield offset - Breakpoint offset - Breakpoint method token - - - - A document - - - - - Gets the URL - - - - - Gets the language - - - - - Gets the language vendor - - - - - Gets the document type - - - - - Gets the checksum algorithm id - - - - - Gets the checksum - - - - - Gets the custom debug infos - - - - - A method - - - - - Gets the method token - - - - - Gets the root scope - - - - - Gets all sequence points - - - - - Reads custom debug info - - Method - Method body - Updated with custom debug info - - - - A namespace - - - - - Gets the name - - - - - Reads symbols from a PDB file - - - - - Called by the owner module before any other methods and properties are called - - Owner module - - - - Gets the PDB file kind - - - - - Gets the user entry point token or 0 if none - - - - - Gets all documents - - - - - Gets a method or returns null if the method doesn't exist in the PDB file - - Method - Edit and continue version. The first version is 1 - - - - - Reads custom debug info - - Token of a instance - Generic parameter context - Updated with custom debug info - - - - Cleans up resources - - - - - A scope - - - - - Gets the method - - - - - Gets the parent scope - - - - - Gets the start offset of the scope in the method - - - - - Gets the end offset of the scope in the method - - - - - Gets all child scopes - - - - - Gets all locals defined in this scope - - - - - Gets all namespaces in this scope - - - - - Gets all custom debug infos - - - - - Gets the import scope or null if none - - - - - Gets all the constants - - Owner module if a signature must be read from the #Blob - Generic parameter context - - - - - Sequence point - - - - - IL offset - - - - - Document - - - - - Start line - - - - - Start column - - - - - End line - - - - - End column - - - - - A variable - - - - - Gets the name - - - - - Gets the attributes - - - - - Gets the index of the variable - - - - - Gets all custom debug infos - - - - - Reads custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Reads custom debug info - - Method - The method's body. Needs to be provided by the caller since we're called from - PDB-init code when the Body property hasn't been initialized yet - Place all custom debug info in this list - Custom debug info from the PDB file - - - - Writes custom debug infos produced by the C# and Visual Basic compilers. They're stored in PDB files - as PDB method custom attributes with the name "MD2". - - - - - Returns the raw custom debug info or null if there was an error - - Metadata - Writer context - Method - Custom debug infos to write - - - - - - - - P/Invoke attributes, see CorHdr.h/CorPinvokeMap - - - - Pinvoke is to use the member name as specified. - - - Use this mask to retrieve the CharSet information. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Information about target function. Not relevant for fields. - - - - - - Pinvoke will use native callconv appropriate to target windows platform. - - - - - - - - - - - - In M9, pinvoke will raise exception. - - - - - - - Property attributes, see CorHdr.h/CorPropertyAttr - - - - property is special. Name describes how. - - - Runtime(metadata internal APIs) should check name encoding. - - - Property has default - - - - A high-level representation of a row in the Property table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - From column Property.PropFlags - - - - Attributes - - - - From column Property.Name - - - - Name - - - - From column Property.Type - - - - - - - - - - - - - - - - Called to initialize - - - Reset - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the first getter method. Writing null will clear all get methods. - - - - - Gets/sets the first setter method. Writing null will clear all set methods. - - - - - Gets all getter methods - - - - - Gets all setter methods - - - - - Gets the other methods - - - - - Initializes , , - and . - - - - - - - - - - - - - Reset , , - - - - true if there are no methods attached to this property - - - - - - - - true if is not empty - - - - - true if is not null - - - - - Gets the constant element type or if there's no constant - - - - - Gets/sets the property sig - - - - - Gets/sets the declaring type (owner type) - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - - Gets the full name of the property - - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - - - - A Property row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - Name - - - - Constructor - - Name - Property signature - - - - Constructor - - Name - Property signature - Flags - - - - Created from a row in the Property table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this Property row - Row ID - If is null - If is invalid - - - - - - - Represents a public key - - - - - Gets the - - - - - - - - Constructor - - - - - Constructor - - Public key data - - - - Constructor - - Public key data as a hex string or the string "null" - to set public key data to null - - - - - - - - - - Public key / public key token base class - - - - - The key data - - - - - Returns true if is null or empty - - - - - Returns true if is null - - - - - Gets/sets key data - - - - - Gets the - - - - - Constructor - - Key data - - - - Constructor - - Key data as a hex string or the string "null" - to set key data to null - - - - Checks whether a public key or token is null or empty - - Public key or token instance - - - - Returns a - - A or a instance - - - - Compares two s as s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Compares two s - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two public key tokens are equal - - First - Second - true if same, false otherwise - - - - Gets the public key token hash code - - Public key or token - The hash code - - - - Gets the public key token hash code - - Public key token - The hash code - - - - Creates a - - Public key data or null - A new instance or null if - was null - - - - Creates a - - Public key token data or null - A new instance or null if - was null - - - - Gets the raw public key / public key token byte array - - The instance or null - Raw public key / public key token data or null - - - - - - - Represents a public key token - - - - - Gets the - - - - - Constructor - - - - - - - - - - - - - - - - - Recursion counter - - - - - Max recursion count. If this is reached, we won't continue, and will use a default value. - - - - - Gets the recursion counter - - - - - Increments if it's not too high. ALL instance methods - that can be called recursively must call this method and - (if this method returns true) - - true if it was incremented and caller can continue, false if - it was not incremented and the caller must return to its caller. - - - - Must be called before returning to caller if - returned true. - - - - - - - - Extension methods for reflection types, methods, fields - - - - - Checks whether it's a - - The type - - - - Gets a 's - - The type - The type's element type - - - - Returns true if is a generic method, but - not a generic method definition, i.e., a MethodSpec. - - The method - - - - Checks whether a parameter/prop/event type should be treated as if it is really a - generic instance type and not a generic type definition. In the .NET metadata (method - sig), the parameter is a generic instance type, but the CLR treats it as if it's just - a generic type def. This seems to happen only if the parameter type is exactly the same - type as the declaring type, eg. a method similar to: MyType<!0> MyType::SomeMethod(). - - Declaring type of method/event/property - Parameter/property/event type - - - - Checks whether is a type definition and not a type spec - (eg. pointer or generic type instantiation) - - this - - - - Resolve exception base class - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if an assembly couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a type couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Thrown if a method/field couldn't be resolved - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Resolves types, methods, fields - - - - - true to project WinMD types to CLR types, eg. Windows.UI.Xaml.Interop.TypeName - gets converted to System.Type before trying to resolve the type. This is enabled - by default. - - - - - Constructor - - The assembly resolver - - - - - - - - - - Type of resource - - - - - It's a - - - - - It's a - - - - - It's a - - - - - Resource base class - - - - - - - - - - - Gets/sets the offset of the resource - - - - - Gets/sets the name - - - - - Gets/sets the flags - - - - - Gets the type of resource - - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - Constructor - - Name - flags - - - - A resource that is embedded in a .NET module. This is the most common type of resource. - - - - - Gets the length of the data - - - - - - - - Constructor - - Name of resource - Resource data - Resource flags - - - - Constructor - - Name of resource - Data reader factory - Offset of resource data - Length of resource data - Resource flags - - - - Gets a data reader that can access the resource - - - - - - - - - A reference to a resource in another assembly - - - - - - - - Gets/sets the assembly reference - - - - - Constructor - - Name of resource - Assembly reference - Resource flags - - - - - - - A resource that is stored in a file on disk - - - - - - - - Gets/sets the file - - - - - Gets/sets the hash - - - - - Gets/sets the file name - - - - - Constructor - - Name of resource - The file - Resource flags - - - - - - - A collection of s - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Finds the index of a resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an embedded resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of an assembly linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds the index of a linked resource - - Name of resource - The index of the or -1 if none was found - - - - Finds a resource - - Name of resource - The or null if none was found - - - - Finds an embedded resource - - Name of resource - The or null if none was found - - - - Finds an assembly linked resource - - Name of resource - The or null if none was found - - - - Finds a linked resource - - Name of resource - The or null if none was found - - - - Built-in resource data - - - - - Gets the data - - - - - - - - - - - - - - Constructor - - Type of data - Data - - - - - - - - - - Implemented by all resource data - - - - - Gets the type of data - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Writes the data - - Writer - Formatter if needed by implementer - - - - Creates resource data - - - - - Gets the owner module - - - - - Constructor - - Owner module - - - - Gets number of user data types - - - - - Create null data - - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates data - - Value - - - - - Creates array data - - Value - - - - - Creates data - - Value - - - - - Creates serialized data - - Serialized data - Type of serialized data - - - - - Creates serialized data - - Serialized data - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - - - - - Creates a user type. If the type already exists, the existing value is returned. - - Full name of type - Use without converting it to a - type in an existing assembly reference - - - - - Converts an assembly simple name (eg. mscorlib) to the full name of the assembly, - which includes the version, public key token, etc. Returns null if it's - unknown. - - Simple name of assembly - - - - - Gets all types sorted by - - - - - - Resource element - - - - - Name of resource - - - - - Data of resource - - - - - - - - Resource element set - - - - - Gets the number of elements in the set - - - - - Gets all resource elements - - - - - Adds a new resource to the set, overwriting any existing resource - - - - - - Thrown by - - - - - Constructor - - - - - Constructor - - Message - - - - Constructor - - - - - - - Gets called to create a from serialized data. Returns null - if a default instance should be created. - - ResourceDataFactory - Serialized type - Serialized data - - - - - Reads .NET resources - - - - - Returns true if it's possibly resources file data - - Reader - - - - - Reads a .NET resource - - Owner module - Data of resource - - - - - Reads a .NET resource - - Owner module - Data of resource - Call back that gets called to create a instance. Can be null. - - - - - Type of resource - - - - - null - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - array - - - - - - - - - - Start of user types - - - - - Writes .NET resources - - - - - Write .NET resources - - Owner module - Output stream - .NET resources - - - - Base class of all user data - - - - - Full name including assembly of type - - - - - User type code - - - - - - - - - - - Constructor - - User resource type - - - - - - - Binary data - - - - - Gets the raw data - - - - - Constructor - - User resource type - Raw serialized data - - - - - - - - - - User resource type - - - - - Full name including assembly of type - - - - - User type code - - - - - Constructor - - Full name including assembly of type - User type code - - - - - - - Security action. See CorHdr.h/CorDeclSecurity - - - - Mask allows growth of enum. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Persisted grant set at prejit time - - - Persisted grant set at prejit time - - - Persisted denied set at prejit time - - - Persisted denied set at prejit time - - - - - - - - - - - - Maximum legal value - - - - A DeclSecurity security attribute - - - - - Gets/sets the attribute type - - - - - Gets the full name of the attribute type - - - - - Gets all named arguments (field and property values) - - - - - true if is not empty - - - - - Gets all s that are field arguments - - - - - Gets all s that are property arguments - - - - - Creates a from an XML string. - - Owner module - XML - A new instance - - - - Default constructor - - - - - Constructor - - Attribute type - - - - Constructor - - Attribute type - Named arguments that will be owned by this instance - - - - - - - See CorSerializationType/CorHdr.h - - - - - - - System.Boolean - - - System.Char - - - System.SByte - - - System.Byte - - - System.Int16 - - - System.UInt16 - - - System.Int32 - - - System.UInt32 - - - System.Int64 - - - System.UInt64 - - - System.Single - - - System.Double - - - System.String - - - Single-dimension, zero lower bound array ([]) - - - System.Type - - - Boxed value type - - - A field - - - A property - - - An enum - - - - Compares types - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares fields - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - Compares methods - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Compares properties - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares events - - - - - Compares the declaring types - - - - - Doesn't compare the declaring types - - - - - Compares the declaring types, case insensitive names - - - - - Doesn't compare the declaring types, case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - Compares calling convention signatures - - - - - Default instance - - - - - Case insensitive names - - - - - Constructor - - Comparison options - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Decides how to compare types, sigs, etc - - - - - Don't compare a type's (assembly/module) scope - - - - - Compares a method/field's declaring type. - - - - - Compares a property's declaring type - - - - - Compares an event's declaring type - - - - - Compares method / field / property / event declaring types - - - - - Compares parameters after a sentinel in method sigs. Should not be enabled when - comparing s against s since it's - not possible to get those sentinel params from a . - - - - - Compares assembly public key token - - - - - Compares assembly version - - - - - Compares assembly locale - - - - - If set, a and an can reference the - global <Module> type. - - - - - Don't compare a method/property's return type - - - - - Type namespaces are case insensitive - - - - - Type names (not namespaces) are case insensitive - - - - - Type names and namespaces are case insensitive - - - - - Method and field names are case insensitive - - - - - Property names are case insensitive - - - - - Event names are case insensitive - - - - - Type namespaces, type names, method names, field names, property names - and event names are all case insensitive - - - - - A field that is can compare equal to - a - - - - - A method that is can compare equal to - a - - - - - A field that is and a method that is - can compare equal to a - - - - - Raw (bit by bit) comparison of signatures. This matches what the CLR does when it - compares signatures. This means that metadata tokens will be compared. - - - - - Ignore required and optional modifiers when comparing s. - They're already ignored when comparing eg. a with a - . - - - - - By default, all module and assembly compares when they're both the system library - (eg. mscorlib or System.Runtime.dll) return true, even if they're really different, - eg. mscorlib (.NET 2.0) vs mscorlib (Windows CE). If this flag is set, the system - library is compared just like any other module/assembly. - - - - - Don't project CLR compatible WinMD references back to the original CLR type/method before comparing - - - - - Don't check type equivalence when comparing types. Starting with .NET 4.0, two different - types can be considered equivalent if eg. a TypeIdentifierAttribute is used. - - - - - When comparing types, don't compare a multi-dimensional array's lower bounds and sizes - - - - - Compares types, signatures, methods, fields, properties, events - - - - - Constructor - - Comparison options - - - - Constructor - - Comparison options - The module which the comparison take place in. - - - - is mapped to , so use - the same hash code for both - - - - - Compare members - - Member #1 - Member #2 - true if same, false otherwise - - - - Gets the hash code of a member - - The member - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares resolution scopes - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares resolution scope and implementation - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares files - - File #1 - File #2 - true if same, false otherwise - - - - Compares a module with a file - - Module - File - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Compares signatures - - Sig #1 - Sig #2 - true if same, false otherwise - - - - Gets the hash code of a sig - - The sig - The hash code - - - - Compares method/property sigs - - Method/property #1 - Method/property #2 - true if same, false otherwise - - - - Gets the hash code of a method/property sig - - The method/property sig - The hash code - - - - Compares field sigs - - Field sig #1 - Field sig #2 - true if same, false otherwise - - - - Gets the hash code of a field sig - - The field sig - The hash code - - - - Compares local sigs - - Local sig #1 - Local sig #2 - true if same, false otherwise - - - - Gets the hash code of a local sig - - The local sig - The hash code - - - - Compares generic method instance sigs - - Generic inst method #1 - Generic inst method #2 - true if same, false otherwise - - - - Gets the hash code of a generic instance method sig - - The generic inst method sig - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a method - - The method - The hash code - - - - Compares MemberRefs - - MemberRef #1 - MemberRef #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRef - - The MemberRef - The hash code - - - - Compares MethodSpecs - - MethodSpec #1 - MethodSpec #2 - true if same, false otherwise - - - - Gets the hash code of a MethodSpec - - The MethodSpec - The hash code - - - - Compares MemberRefParents - - MemberRefParent #1 - MemberRefParent #2 - true if same, false otherwise - - - - Gets the hash code of a MemberRefParent - - The MemberRefParent - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Checks whether it's FnPtr&, FnPtr*, FnPtr[], or FnPtr[...] - - The type - - - - Compares types - - Type #1 - Type #2 - true if we should treat - as a generic instance type - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Compares types - - Type #1 - Type #2 - true if same, false otherwise - - - - Gets the hash code of a type - - The type - The hash code - - - - Gets the hash code of a type - - The type - true if we should treat - as a generic instance type - The hash code - - - - Gets the hash code of a type list - - The type list - The hash code - - - - Gets the hash code of a list with only generic method parameters () - - Number of generic method parameters - Hash code - - - - Gets the hash code of a TypeDef type - - The type - The hash code - - - - Compares type lists - - Type list #1 - Type list #2 - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares a file and a module - - File - Module - true if same, false otherwise - - - - Compares modules - - Module #1 - Module #2 - true if same, false otherwise - - - - Compares assemblies - - Assembly #1 - Assembly #2 - true if same, false otherwise - - - - Compares method declaring types - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares method sigs - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares generic method args, making sure only - contains s. - - Number of generic method args in method #1 - Generic method args in method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Compares methods - - Method #1 - Method #2 - true if same, false otherwise - - - - Gets the hash code of a MethodBase - - The MethodBase - The hash code - - - - Gets the hash code of a parameter list - - The type list - Declaring type of method that owns parameter - The hash code - - - - Compares calling conventions - - Calling convention - Method - - - - - Compares return types - - Return type #1 - MethodBase - true if same, false otherwise - - - - Compares parameter lists - - Type list #1 - Type list #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares parameter types - - Parameter type #1 - Parameter #2 - Declaring type of method that owns parameter - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Compares fields - - Field #1 - Field #2 - true if same, false otherwise - - - - Gets the hash code of a field - - The field - The hash code - - - - Compares properties - - Property #1 - Property #2 - true if same, false otherwise - - - - Gets the hash code of a property - - The property - The hash code - - - - Compares events - - Event #1 - Event #2 - true if same, false otherwise - - - - Gets the hash code of an event - - The event - The hash code - - - - - - - Helps resolve types - - - - - Resolves a - - A TypeDefOrRef coded token - Generic parameter context - A or null if - is invalid - - - - Converts the address of a to a - - - Address of . This is also known as the - method table and has the same value as - A or null if not supported - - - - Reads signatures from the #Blob stream - - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a type signature from the #Blob stream - - Reader module - #Blob stream offset of signature - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - The module where the signature is located in - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature data - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Reads a signature - - Token resolver - A instance - The signature reader - Generic parameter context - If there's any extra data after the signature, it's saved - here, else this will be null - A new instance or null if - is invalid. - - - - Constructor - - Reader module - #Blob stream offset of signature - Generic parameter context - - - - Constructor - - Token resolver - A instance - The signature data - Generic parameter context - - - - Reads the signature - - A new instance or null if invalid signature - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads a - - First byte of signature - A new instance - - - - Reads the next type - - A new instance or null if invalid element type - - - - A high-level representation of a row in the StandAloneSig table - - - - - The row id in its table - - - - - - - - - - - - - - From column StandAloneSig.Signature - - - - - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - Gets/sets the method sig - - - - - Gets/sets the locals sig - - - - - - - - A StandAloneSig row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A locals sig - - - - Constructor - - A method sig - - - - Created from a row in the StandAloneSig table - - - - The module where this instance is located - - - - - - - - - - - - - Constructor - - The module which contains this StandAloneSig row - Row ID - Generic parameter context - If is null - If is invalid - - - - Thrown if the strong name key or public key is invalid - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - Type of signature algorithm. See WinCrypt.h in the Windows SDK - - - - - RSA signature algorithm - - - - - A public key - - - - - Gets/sets the signature algorithm - - - - - Gets/sets the hash algorithm - - - - - Gets/sets the modulus - - - - - Gets/sets the public exponent - - - - - Default constructor - - - - - Constructor - - Modulus - Public exponent - - - - Constructor - - Modulus - Public exponent - Hash algorithm - - - - Constructor - - Modulus - Public exponent - Hash algorithm - Signature algorithm - - - - Constructor - - Public key - - - - Constructor - - Public key data - Strong name key is invalid - - - - Constructor - - Public key file - Strong name key is invalid - - - - Constructor - - Public key stream - Strong name key is invalid - - - - Constructor - - Public key reader - Strong name key is invalid - - - - Creates a public key blob - - - - - - - - Stores a strong name key pair - - - - - Gets the public key - - - - - Gets the strong name signature size in bytes - - - - - Gets the public key hash algorithm. It's usually - - - - - Gets the public exponent - - - - - Gets the modulus - - - - - Gets prime1 - - - - - Gets prime2 - - - - - Gets exponent1 - - - - - Gets exponent2 - - - - - Gets the coefficient - - - - - Gets the private exponent - - - - - Constructor - - Strong name key data - Strong name key is invalid - - - - Constructor - - Strong name key file - Strong name key is invalid - - - - Constructor - - Strong name key stream - Strong name key is invalid - - - - Constructor - - Strong name key reader - Strong name key is invalid - - - - Creates a strong name key with a new hash algorithm - - Algorithm - - - - - Creates an instance - - - - - Creates a strong name blob - - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature as a hex string - - - - Creates a counter signature, just like - sn -a IdentityPubKey.snk IdentityKey.snk SignaturePubKey.snk can do. - The public key sn prints is 's value. - - Identity public key - Identity strong name key pair - Signature public key - The counter signature - - - - Strong name signs an assembly. It supports normal strong name signing and the new - (.NET 4.5) enhanced strong name signing. - - - - - Constructor - - .NET PE file stream - - - - Constructor - - .NET PE file stream - Offset in of the first byte of - the PE file. - - - - Calculates the strong name signature and writes it to the stream. The signature - is also returned. - - Strong name key used for signing - Offset (relative to the start of the PE file) of the strong - name signature. - The strong name signature - - - - Calculates and returns the strong name signature - - Strong name key used for signing - Offset (relative to start of PE file) of the strong - name signature. - The strong name signature - - - - Strong name hashes the .NET file - - Hash algorithm - Strong name sig offset (relative to start of .NET PE file) - Size of strong name signature - The strong name hash of the .NET file - - - - Returns the strong name signature - - Strong name key - Hash algorithm - Strong name hash of the .NET PE file - Strong name signature - - - - System.Runtime.InteropServices.TypeIdentifierAttribute helper code used by - - - - - TypeDef and ExportedType flags. See CorHdr.h/CorTypeAttr - - - - Use this mask to retrieve the type visibility information. - - - Class is not public scope. - - - Class is public scope. - - - Class is nested with public visibility. - - - Class is nested with private visibility. - - - Class is nested with family visibility. - - - Class is nested with assembly visibility. - - - Class is nested with family and assembly visibility. - - - Class is nested with family or assembly visibility. - - - Use this mask to retrieve class layout information - - - Class fields are auto-laid out - - - Class fields are laid out sequentially - - - Layout is supplied explicitly - - - Use this mask to retrieve class semantics information. - - - Use this mask to retrieve class semantics information. - - - Type is a class. - - - Type is an interface. - - - Class is abstract - - - Class is concrete and may not be extended - - - Class name is special. Name describes how. - - - Class / interface is imported - - - The class is Serializable. - - - The type is a Windows Runtime type - - - Use StringFormatMask to retrieve string information for native interop - - - LPTSTR is interpreted as ANSI in this class - - - LPTSTR is interpreted as UNICODE - - - LPTSTR is interpreted automatically - - - A non-standard encoding specified by CustomFormatMask - - - Use this mask to retrieve non-standard encoding information for native interop. The meaning of the values of these 2 bits is unspecified. - - - Initialize the class any time before first static field access. - - - This ExportedType is a type forwarder. - - - Flags reserved for runtime use. - - - Runtime should check name encoding. - - - Class has security associate with it. - - - - A high-level representation of a row in the TypeDef table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - Gets/sets the owner module - - - - - - - - - - Called to initialize - - - - From column TypeDef.Flags - - - - Attributes - - - - From column TypeDef.Name - - - - Name - - - - From column TypeDef.Namespace - - - - Name - - - - From column TypeDef.Extends - - - - - - - - - - Called to initialize - - - Reset - - - - From column TypeDef.FieldList - - - - - - - Initializes - - - - From column TypeDef.MethodList - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets the interfaces - - - - - - - Initializes - - - - - - - - - Initializes - - - - Gets/sets the class layout - - - - - - - - - - Called to initialize - - - - - - - Gets/sets the enclosing type. It's null if this isn't a nested class. - - - - - - - - Called by and should normally not be called by any user - code. Use instead. Only call this if you must set the - declaring type without inserting it in the declaring type's method list. - - - - - - - - - - Called to initialize - - - - Gets all the nested types - - - - - - - Initializes - - - - Gets all events - - - - - - - Initializes - - - - Gets all properties - - - - - - - Initializes - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if there's at least one in - - - - - true if is not null - - - - - Gets/sets the packing size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - Gets/sets the class size. If you write to this property but - is null, it will be created. The value is returned - if is null. - - - - - - - - true if it's an enum - - - - - true if it's a delegate (it derives from ) - - - - - true if this is a nested type (it has a declaring type) - - - - - - - - Checks whether this type has opted into equivalence - - - - - Modify property: = - ( & ) | . - - Value to AND - Value to OR - - - - Set or clear flags in - - true if flags should be set, false if flags should - be cleared - Flags to set or clear - - - - Gets/sets the visibility - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the layout - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the string format - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - true if is set - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - true if this is the global (aka. <Module>) type - - - - - Gets a list of all nested types and all their nested types - - - - - Gets an enum's underlying type or null if none. Should only be called - if this is an enum. - - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. Private scope methods/fields are not returned. - - A method/field reference - A or a instance or null - if it couldn't be resolved. - - - - Resolves a method or a field. (owner type) is ignored when - resolving the method/field. - - A method/field reference - Method/field signature comparison options - A or a instance or null - if it couldn't be resolved. - - - - Finds a method. Private scope methods are not returned. - - Method name - Method signature - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The first method that matches or null if none found - - - - Finds a method - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The first method that matches or null if none found - - - - Finds a method by name - - Name of method - The or null if not found - - - - Finds all methods by name - - Name of method - All methods with that name - - - - Finds the class constructor (aka type initializer). It's the method named .cctor - - The class constructor or null if none found - - - - Finds the class constructor (aka type initializer). It's the method named .cctor. - If it doesn't exist, it is created, inserted into and returned. - The created .cctor will have just one RET instruction. - - The class constructor - - - - Finds all instance constructors (not class constructors) - - All instance constructors - - - - Finds all static and instance constructors - - All static and instance constructors - - - - Finds the default instance constructor (the one with no arguments) - - The default instance constructor or null if none - - - - Finds a field. Private scope fields are not returned. - - Field name - Field signature - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The first field that matches or null if none found - - - - Finds a field - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The first field that matches or null if none found - - - - Finds a field by name - - Name of field - The or null if not found - - - - Finds all fields by name - - Name of field - All fields with that name - - - - Finds an event - - Name of event - Type of event - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - A or null if not found - - - - Finds an event - - Name of event - Type of event - Event type comparison options - The module that needs to find the event or null - A or null if not found - - - - Finds an event by name - - Name of event - The or null if not found - - - - Finds all events by name - - Name of event - All events with that name - - - - Finds a property - - Name of property - Property signature - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - A or null if not found - - - - Finds a property - - Name of property - Property signature - Property signature comparison options - The module that needs to find the property or null - A or null if not found - - - - Finds a prop by name - - Name of prop - The or null if not found - - - - Finds all props by name - - Name of prop - All props with that name - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - Method signature - Method signature comparison options - The module that needs to find the method or null - The method or null if it wasn't found - - - - Finds a method by checking this type or any of its base types - - Method name - The method or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - Field signature - Field signature comparison options - The module that needs to find the field or null - The field or null if it wasn't found - - - - Finds a field by checking this type or any of its base types - - Field name - The field or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - Event type - The event or null if it wasn't found - - - - Finds an event by checking this type or any of its base types - - Event name - The event or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - Property signature - Property signature comparison options - The module that needs to find the property or null - The property or null if it wasn't found - - - - Finds a property by checking this type or any of its base types - - Property name - The property or null if it wasn't found - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - - - - Removes a method from this type. It also removes it from any properties and events. - - The method to remove - true if we should remove all - empty properties and events. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Gets all fields named - - Field name - A list of 0 or more fields with name - - - - Gets the first field named - - Field name - The field or null if none found - - - - FInd a method implementation method - - Method - - - - - - - - A TypeDef row created by the user and not present in the original .NET file - - - - - Constructor - - Name - - - - Constructor - - Namespace - Name - - - - Constructor - - Name - Base class or null if it's an interface - - - - Constructor - - Namespace - Name - Base class or null if it's an interface - - - - Created from a row in the TypeDef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeDef row - Row ID - If is null - If is invalid - - - - Gets all methods overrides - - The method - Generic parameter context - A list (possibly empty) of all methods overrides - - - - Initializes all . Only those s - that are property or event handlers get updated. - - - - - Initializes a property's special methods - - The property - Updated with a list of all get methods - Updated with a list of all set methods - Updated with a list of all other methods - - - - Initializes an event's special methods - - The event - Updated with the addOn method or null if none - Updated with the fire method or null if none - Updated with the removeOn method or null if none - Updated with a list of all other methods - - - - - - - - - - - - - - - - - - - Finds s - - - - - true if the cache is enabled. false if the cache - is disabled and a slower O(n) lookup is performed. - - - - - Constructor - - All root types. All their nested types are also included. - If is null - - - - Constructor - - All root types - true if all nested types that are reachable - from should also be included. - If is null - - - - Resets the cache (clears all cached elements). Use this method if the cache is - enabled but some of the types have been modified (eg. removed, added, renamed). - - - - - - - - - - - Gets the next or null if there are no more left - - The next or null if none - - - - Gets the next or null if there are no more left. - The cache is updated with the returned before the method - returns. - - The next or null if none - - - - - - - Various helper methods for classes to prevent infinite recursion - - - - - Checks whether contains a or a - . - - Calling convention signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Field signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Method or property signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Local signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Generic method signature - true if contains a - or a . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Checks whether contains a or a - . - - Type - true if contains a or a - . - - - - Thrown by when it fails to parse a type name - - - - - Default constructor - - - - - Constructor - - Exception message - - - - Constructor - - Exception message - Inner exception or null if none - - - - Constructor - - - - - - - Helps create types - - - - - Finds a 's when the original assembly - info is missing from the full type name. - - A non-nested - 's or null - - - - Parses a type name and creates an - - - - Owner module - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance - If parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - A new instance or null if parsing failed - - - - Parses a Reflection type name and creates a - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - A new instance or null if parsing failed - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Parses a type name and creates a - - A new instance - If parsing failed - - - - Increment recursion counter - - If this method has been called too many times - - - - Decrement recursion counter - - - - - - - - Dispose method - - true if called by - - - - Reads a including any possible nested s. - - Character separating nested types - A new instance, which could be nested. - - - - Reads a namespace and name and creates a TypeRef. Does not read any nested types. - - A new instance - - - - Peeks the next char. -1 if no more chars. - - - - - Gets the next char or -1 if no more chars - - - - - Gets the next ID char or -1 if no more ID chars - - true if white space should be ignored - - - - Parses reflection type names. Grammar http://msdn.microsoft.com/en-us/library/yfsftwz6.aspx - - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - - - - Constructor - - Module that will own the returned or null - Full name of type - Helper class - Generic parameter context - - - - Parses an assembly name - - Full assembly name - A new instance or null if parsing failed - - - - Parses an assembly name - - Full assembly name - Generic parameter context - A new instance or null if parsing failed - - - - - - - A high-level representation of a row in the TypeRef table - - - - - The row id in its table - - - - - The owner module - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Always returns false since a does not contain any - or . - - - - - - - - From column TypeRef.ResolutionScope - - - - - - - - - - Called to initialize - - - - From column TypeRef.Name - - - - Name - - - - From column TypeRef.Namespace - - - - Name - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - true if it's nested within another - - - - - - - - - - - Gets the declaring type, if any - - - - - - - - Resolves the type - - A instance or null if it couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance or null if it couldn't be resolved - - - - Resolves the type - - A instance - If the type couldn't be resolved - - - - Resolves the type - - The module that needs to resolve the type or null - A instance - If the type couldn't be resolved - - - - Gets the top-most (non-nested) - - Input - The non-nested or null - - - - - - - A TypeRef row created by the user and not present in the original .NET file - - - - - Constructor - - Owner module - Type name - - - - Constructor - - Owner module - Type namespace - Type name - - - - Constructor - - Owner module - Type namespace - Type name - Resolution scope (a , - , or ) - - - - Created from a row in the TypeRef table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeRef row - Row ID - If is null - If is invalid - - - - Type sig base class - - - - - Returns the wrapped element type. Can only be null if it was an invalid sig or - if it's a - - - - - Gets the element type - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a or a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if it's a - - - - - true if this contains a or a - . - - - - - - - - Base class for element types that are last in a type sig, ie., - , , , - , - - - - - - - - Wraps a - - - - - Gets the the TypeDefOrRef - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Returns true if != null - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Gets the or null if it's not a - - - - - Constructor - - A , or - a - - - - A core library type - - - - - Gets the element type - - - - - Constructor - - The type which must be a or a - . and null are not allowed. - The type's element type - - - - Base class for class/valuetype element types - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Represents a - - - - - - - - Constructor - - A - - - - Generic method/type var base class - - - - - true if it has an owner or - - - - - true if it has an owner ( is - not null) - - - - - true if it has an owner ( is - not null) - - - - - Gets the owner type or null if the owner is a or if it - has no owner. - - - - - Gets the owner method or null if the owner is a or if it - has no owner. - - - - - Gets the generic param number - - - - - Gets the corresponding or null if none exists. - - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - - - - Constructor - - true if it's a Var, false if it's a MVar - Generic param number - Owner method/type or null - - - - Returns true if it's a MVar element type - - - - - Returns true if it's a Var element type - - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner type or null - - - - Constructor - - Generic parameter number - Owner type or null - - - - Represents a - - - - - - - - - - - - - - Constructor - - Generic parameter number - Owner method or null - - - - Constructor - - Generic parameter number - Owner method or null - - - - Represents a - - - - - - - - Represents a - - - - - - - - Gets the signature - - - - - Gets the - - - - - Constructor - - The method signature - - - - Represents a - - - - - - - - Gets the generic type - - - - - Gets the generic arguments (it's never null) - - - - - Default constructor - - - - - Constructor - - The generic type - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Number of generic arguments - - - - Constructor - - The generic type - Generic argument #1 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - - - - Constructor - - The generic type - Generic argument #1 - Generic argument #2 - Generic argument #3 - - - - Constructor - - The generic type - Generic arguments - - - - Constructor - - The generic type - Generic arguments - - - - Base class of non-leaf element types - - - - - - - - Constructor - - Next sig - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Array base class - - - - - Constructor - - Array type - - - - true if it's a multi-dimensional array (i.e., ), - and false if it's a single-dimensional array (i.e., ) - - - - - - true if it's a single-dimensional array (i.e., ), - and false if it's a multi-dimensional array (i.e., ) - - - - - - Gets/sets the rank (number of dimensions). This can only be set if - is true - - - - - Gets all sizes. If it's a , then it will be an empty temporary - list that is re-created every time this method is called. - - A list of sizes - - - - Gets all lower bounds. If it's a , then it will be an empty - temporary list that is re-created every time this method is called. - - A list of lower bounds - - - - Represents a - - - - - - - - - Gets/sets the rank (max value is 0x1FFFFFFF) - - - - - Gets all sizes (max elements is 0x1FFFFFFF) - - - - - Gets all lower bounds (max elements is 0x1FFFFFFF) - - - - - Constructor - - Array type - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - Constructor - - Array type - Array rank - Sizes list. This instance will be the owner of this list. - Lower bounds list. This instance will be the owner of this list. - - - - - - - - - - Represents a (single dimension, zero lower bound array) - - - - - - - - - - - - Constructor - - The next element type - - - - - - - - - - Base class for modifier type sigs - - - - - Returns the modifier type - - - - - Constructor - - Modifier type - The next element type - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - - - - Represents a - - - - - - - - Constructor - - The next element type - - - - Represents a - - - - - - - - Gets/sets the size - - - - - Constructor - - The next element type - Size of the array - - - - Represents a - - - - - - - - Gets/sets the index - - - - - Constructor - - Index - The next element type - - - - A high-level representation of a row in the TypeSpec table - - - - - The row id in its table - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - From column TypeSpec.Signature - - - - - Gets/sets the extra data that was found after the signature - - - - - - - - - - - - - Called to initialize - - - - Gets all custom attributes - - - - - - - Initializes - - - - - - - - - - - - - Gets all custom debug infos - - - - - - - Initializes - - - - - - - A TypeSpec row created by the user and not present in the original .NET file - - - - - Default constructor - - - - - Constructor - - A type sig - - - - Created from a row in the TypeSpec table - - - - The module where this instance is located - - - - - - - - - - - - - - - - Constructor - - The module which contains this TypeSpec row - Row ID - Generic parameter context - If is null - If is invalid - - - - Compares s - - - - - The default instance - - - - - - - - - - - A UTF-8 encoded string where the original data is kept in memory to avoid conversions - when the data is not really valid UTF-8 encoded data - - When comparing strings, a byte compare is performed. The reason is that this - is what the CLR does when comparing strings in the #Strings stream. - - - - An empty - - - - - Gets the value as a UTF8 decoded string. Only use it for display purposes, - not for serialization. - - - - - Gets the original encoded data. Don't modify this data. - - - - - Gets the length of the this as a . I.e., it's the same as - String.Length. - - - - - - Gets the length of the raw data. It's the same as Data.Length - - - - - - Checks whether is null or if its data is null. - - The instance to check - true if null or empty, false otherwise - - - - Checks whether is null or if its data is null or the - data is zero length. - - The instance to check - true if null or empty, false otherwise - - - Implicit conversion from to - - - Implicit conversion from to - - - - Converts it to a - - The UTF-8 string instace or null - A or null if is null - - - - Converts it to a or an empty string if is null - - The UTF-8 string instace or null - A (never null) - - - - Gets the hash code of a - - Input - - - - - - - Compares two instances (case sensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two instances (case insensitive) - - Instance #1 or null - Instance #2 or null - true if equals, false otherwise - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - Constructor - - UTF-8 data that this instance now owns - - - - Constructor - - The string - - - - Compares two instances - - First - Second - true if equals, false otherwise - - - - - - - - - - Checks whether exists in this string - - Value to find - true if exists in string or is the - empty string, else false - - - - Checks whether matches the end of this string - - Value - - - - - Checks whether matches the end of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the end of this string - - Value - Comparison type - - - - - Checks whether matches the beginning of this string - - Value - - - - - Checks whether matches the beginning of this string - - Value - true to ignore case - Culture info - - - - - Checks whether matches the beginning of this string - - Value - Comparison type - - - - - Compares this instance with - - Other string - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Returns the index of the first character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the first character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the first sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Returns the index of the last character in this string - - Character - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index - - Character - Start index - The index of or -1 if not found - - - - Returns the index of the last character in this string - starting from index for max - characters. - - Character - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index for max - characters. - - String - Start index - Max number of chars to scan - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - starting from index - - String - Start index - Comparison type - The index of or -1 if not found - - - - Returns the index of the last sub string in this string - - String - Comparison type - The index of or -1 if not found - - - - Inserts string at a index - - Start index - Value to insert - A new instance with the inserted at position - - - - - Removes all characters starting from position - - Start index - A new instance - - - - Removes characters starting from position - - - Start index - Number of characters to remove - A new instance - - - - Replaces all characters with - - Character to find - Character to replace all - A new instance - - - - Replaces all sub strings with - - Sub string to find - Sub string to replace all - A new instance - - - - Returns a sub string of this string starting at offset - - Start index - A new instance - - - - Returns a sub string of this string starting at offset . - Length of sub string is . - - Start index - Length of sub string - A new instance - - - - Returns the lower case version of this string - - A new instance - - - - Returns the lower case version of this string - - Culture info - A new instance - - - - Returns the lower case version of this string using the invariant culture - - A new instance - - - - Returns the upper case version of this string - - A new instance - - - - Returns the upper case version of this string - - Culture info - A new instance - - - - Returns the upper case version of this string using the invariant culture - - A new instance - - - - Removes all leading and trailing whitespace characters - - A new instance - - - - - - - - - - Compares byte arrays - - - - - Default instance - - - - - - - - - - - Returns an assembly name string - - Simple assembly name - Version or null - Culture or null - Public key / public key token or null - Assembly attributes - An assembly name string - - - - Convert a byte[] to a - - All bytes - true if output should be in upper case hex - as a hex string - - - - Converts a hex string to a byte[] - - A string with an even number of hex characters - converted to a byte[] or null - if is invalid - - - - Converts a character to a hex digit - - Hex character - 0x00-0x0F if successful, -1 if is not - a valid hex digit - - - - Compares two byte arrays - - Byte array #1 - Byte array #2 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two byte arrays are equal - - First - Second - true if same, false otherwise - - - - Gets the hash code of a byte array - - Byte array - The hash code - - - - Compares two versions - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Checks whether two versions are the same - - This differs from if the build - and/or revision numbers haven't been initialized or if one of the args is null. - - Version #1 or null to be treated as v0.0.0.0 - Version #2 or null to be treated as v0.0.0.0 - true if same, false otherwise - - - - Creates a new instance with no undefined version values (eg. - the build and revision values won't be -1). - - A instance - A new instance - - - - Parses a version string - - Version string - A new or null if - is an invalid version - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Compares two locales (cultures) - - First - Second - < 0 if a < b, 0 if a == b, > 0 if a > b - - - - Compares two locales (cultures) - - First - Second - true if same, false otherwise - - - - Gets the hash code of a locale - - Value - The hash code - - - - Align up - - Value - Alignment - - - - Align up - - Value - Alignment - - - - Variant type (VT_XXX in the Windows SDK) - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This wasn't present in the blob - - - - All native vtables - - - - - Gets/sets the RVA of the vtable fixups - - - - - Gets all s - - - - - Default constructor - - - - - Constructor - - Module - - - - - - - - - - See COR_VTABLE_XXX in CorHdr.h - - - - - 32-bit vtable slots - - - - - 64-bit vtable slots - - - - - Transition from unmanaged code - - - - - Also retain app domain - - - - - Call most derived method - - - - - One VTable accessed by native code - - - - - Gets/sets the of this vtable - - - - - Gets/sets the flags - - - - - true if each vtable slot is 32 bits in size - - - - - true if each vtable slot is 64 bits in size - - - - - Gets the vtable methods - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - RVA of this vtable - Flgas - Number of methods in vtable - - - - Constructor - - RVA of this vtable - Flgas - Vtable methods - - - - - - - - - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - true if the returned type is a value type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD type to a CLR type. Returns null - if it's not a CLR compatible WinMD type. - - Owner module or null - Type - - - - - Converts WinMD member reference to a CLR member reference. Returns - null if it's not a CLR compatible WinMD member reference. - - Owner module or null - Member reference - - - - - Converts WinMD method to a CLR member reference. Returns - null if it's not a CLR compatible WinMD method - - Owner module or null - Method - - - - - WinMD status - - - - - This is not a WinMD file - - - - - This is a pure WinMD file (not managed) - - - - - This is a managed WinMD file (created by eg. winmdexp.exe) - - - - - Writes data - - - - - Gets the current position - - - - - Constructor - - Destination array - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes - - - - Writes bytes - - Bytes - Source index - Number of bytes to write - - - - #Blob heap - - - - - - - - Populates blobs from an existing (eg. to preserve - blob offsets) - - The #Blob stream with the original content - - - - Adds data to the #Blob heap - - The data - The offset of the data in the #Blob heap - - - - Adds data to the #Blob heap, but does not re-use an existing position - - The data - The offset of the data in the #Blob heap - - - - - - - - - - - - - - - - - - - Stores a byte array - - - - - - - - - - - Gets the data - - - - - Constructor - - The data. It will be owned by this instance and can't be modified by - other code if this instance is inserted as a key in a dictionary (because - return value will be different if you modify the array). If - it's never inserted as a key in a dictionary, then the contents can be modified, - but shouldn't be resized after has been called. - - - - - - - - - - - - - - - - - - - - - - Checksum algorithm - - - - - SHA-1 - - - - - SHA-256 - - - - - SHA-384 - - - - - SHA-512 - - - - - Contains a list of s - - - - - Default constructor - - - - - Add a - - The chunk to add or null if none - Chunk alignment - - - - Remove a - - The chunk to remove or null if none - Alignment of the chunk, or null if the chunk cannot be removed. - - - - Base class of chunk list types - - Chunk type - - - All chunks - - - true if has been called - - - - Helper struct - - - - Data - - - Alignment - - - - Constructor - - Chunk - Alignment - - - - Equality comparer for - - - - - Constructor - - Compares the chunk type - - - - - - - - - - - - - - - - - - - - - - - - - - - - Helps write custom attributes - - - - - Writes s - - - - - Writes a custom attribute - - Helper class - The custom attribute - Custom attribute blob - - - - Writes custom attribute named arguments - - Helper class - Named arguments - The named args blob - - - - Write a value - - The ctor arg type, field type, or property type - The value to write - - - - Gets the enum's underlying type - - An enum type - The underlying type or null if we couldn't resolve the type ref - - - - Converts to a , possibly resolving - a - - The type - A or null if we couldn't resolve the - or if is a type spec - - - - - - - A chunk - - - - - - - - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Constructor - - The data - - - - Constructor - - The data - Virtual size of - - - - Gets the data reader - - - - - Replaces the old data with new data. The new data must be the same size as the old data if - has been called. That method gets called after - event - - - - - - - - - - - - - - - - - - Copies existing data to a new metadata heap - - - - - Gets the name of the heap - - - - - Constructor - - The stream whose data will be copied to the new metadata file - - - - Constructor - - Heap name - Heap content - - - - - - - - - - Writes data - - - - - Gets/sets the position - - - - - Constructor - - Destination stream - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes a - - Value - - - - Writes bytes - - Bytes to write - - - - Writes bytes - - Bytes to write - Index to start copying from - Number of bytes to copy - - - - Writes a compressed - - Value - - - - Writes a compressed - - - - - - Gets the size of a compressed , see - - Value - - - - - Debug directory entry - - - - - Gets the header - - - - - Gets the data - - - - - Constructor - - Data - - - - Debug directory chunk - - - - Default debug directory alignment - - - - - - - - - - Constructor - - - - - Adds data - - Data - - - - - Adds data - - Data - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - Adds data - - Data - Debug type - Major version - Minor version - Timestamp - - - - - - - - - - - - - - - - - Writes DeclSecurity blobs - - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - A DeclSecurity blob - - - - Creates a DeclSecurity blob from - - Owner module - List of s - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A DeclSecurity blob - - - - Extension methods - - - - - Write zeros - - this - Number of zeros - - - - Writes all data to and verifies that all bytes were written - - this - Destination - Not all bytes were written - - - - Writes a data directory - - Writer - The data - - - - #GUID heap - - - - - - - - Adds a guid to the #GUID heap - - The guid - The index of the guid in the #GUID heap - - - - - - - - - - - - - - - - - - - Base class of most heaps - - - - - true if has been called - - - - - - - - - - - - - - - - - true if offsets require 4 bytes instead of 2 bytes. - - - - - - - - - - - - - - - - - Gets the raw length of the heap - - Raw length of the heap - - - - - - - Writes all data to at its current location. - - Destination - - - - - - - Data that gets written to the file - - - - - Gets the file offset. This is valid only after has been called. - - - - - Gets the RVA. This is valid only after has been called. - - - - - Called when the file offset and RVA are known - - File offset of this chunk - RVA of this chunk - - - - Gets the raw file length of this chunk. Must only be called after - has been called. - - Length of this chunk - - - - Gets the virtual size of this chunk. Must only be called after - has been called. - - Virtual size of this chunk - - - - Writes all data to at its current location. It's only - called after and have been called. - You cannot assume that 's file position is the same as this - chunk's file position. - - Destination - - - - Implemented by s that can reuse the old data location in the original PE file - - - - - Returns true if this chunk fits in the old location - - Original RVA of data - Size of the original location - - - - - .NET Heap interface - - - - - Gets the name of the heap - - - - - Checks whether the heap is empty - - - - - Called when the heap should be set to read-only mode - - - - - Options to - - - - - Default major runtime version - - - - - Default minor runtime version - - - - - Major runtime version - - - - - Minor runtime version - - - - - Flags - - - - - Entry point or null. Either a Method/File token or an RVA. - - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Major runtime version (default is ) - Minor runtime version (default is ) - Flags - - - - .NET header - - - - - Gets/sets the - - - - - Gets/sets the .NET resources - - - - - Gets/sets the strong name signature - - - - - - - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Import address table chunk - - - - - Gets/sets the - - - - - - - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Import directory chunk - - - - - Gets/sets the - - - - - Gets the RVA of _CorDllMain/_CorExeMain in the import lookup table - - - - - Gets RVA of _CorExeMain/_CorDllMain in the IAT - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets/sets the name of the dll which should be imported. - - - - - Gets/sets the name of the entry point of the imported dll. - - - - - Constructor - - true if it's a 64-bit PE file, false if it's a 32-bit PE file - - - - - - - - - - - - - - - - Interface to get and set raw heap data. Implemented by the offset heaps: #Strings, - #GUID, #Blob, and #US. - - Type of cooked data - - - - Gets the size of the data as raw data when written to the heap - - The data - Size of the data as raw data when written to the heap - - - - Overrides what value should be written to the heap. - - Offset of value. Must match an offset returned by - - The new raw data. The size must match the raw size exactly. - - - - Gets all inserted raw data and their offsets. The returned array - is owned by the caller. - - An enumerable of all raw data and their offsets - - - - Gets notified of errors. The default handler should normally throw since the written data - will probably be invalid. Any error can be ignored. - - - - - Called when an error is detected (eg. a null pointer or other invalid value). The error - can be ignored but the written data won't be valid. - - Error message - - - - Writes the .sdata blob. We could write the data in any order, but we write the data in the same order as ILASM - - PE timestamp - - - - Writes field marshal blobs - - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - A field marshal blob or null if is - null - - - - Creates a field marshal blob from - - Owner module - Marshal type - Helps this class - Optimize serialized type strings in custom attributes. - For more info, see - A field marshal blob or null if is - null - - - - - - - Calculates max stack usage by using a simple pass over all instructions. This value - can be placed in the fat method header's MaxStack field. - - - - - Gets max stack value - - All instructions - All exception handlers - Max stack value - - - - Gets max stack value - - All instructions - All exception handlers - Updated with max stack value - true if no errors were detected, false otherwise - - - - MD table interface - - - - - Gets the table type - - - - - true if the table is empty - - - - - Gets the number of rows in this table - - - - - Gets/sets a value indicating whether it's sorted - - - - - true if has been called - - - - - Gets/sets the - - - - - Called when the table can't be modified any more - - - - - Creates rows in a table. Rows can optionally be shared to create a compact table. - - The raw row type - - - - - - - - - - - - - - - - - - - - - - Gets the value with rid - - The row ID - - - - Constructor - - The table type - Equality comparer - - - - - - - Adds a row. If the row already exists, returns a rid to the existing one, else - it's created and a new rid is returned. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Creates a new row even if this row already exists. - - The row. It's now owned by us and must NOT be modified by the caller. - The RID (row ID) of the row - - - - Re-adds all added rows. Should be called if rows have been modified after being - inserted. - - - - - Reset the table. - - - - - Writes s - - - - - Writes a Module table - - Writer - Metadata - Table - - - - Writes a TypeRef table - - Writer - Metadata - Table - - - - Writes a TypeDef table - - Writer - Metadata - Table - - - - Writes a FieldPtr table - - Writer - Metadata - Table - - - - Writes a Field table - - Writer - Metadata - Table - - - - Writes a MethodPtr table - - Writer - Metadata - Table - - - - Writes a Method table - - Writer - Metadata - Table - - - - Writes a ParamPtr table - - Writer - Metadata - Table - - - - Writes a Param table - - Writer - Metadata - Table - - - - Writes a InterfaceImpl table - - Writer - Metadata - Table - - - - Writes a MemberRef table - - Writer - Metadata - Table - - - - Writes a Constant table - - Writer - Metadata - Table - - - - Writes a CustomAttribute table - - Writer - Metadata - Table - - - - Writes a FieldMarshal table - - Writer - Metadata - Table - - - - Writes a DeclSecurity table - - Writer - Metadata - Table - - - - Writes a ClassLayout table - - Writer - Metadata - Table - - - - Writes a FieldLayout table - - Writer - Metadata - Table - - - - Writes a StandAloneSig table - - Writer - Metadata - Table - - - - Writes a EventMap table - - Writer - Metadata - Table - - - - Writes a EventPtr table - - Writer - Metadata - Table - - - - Writes a Event table - - Writer - Metadata - Table - - - - Writes a PropertyMap table - - Writer - Metadata - Table - - - - Writes a PropertyPtr table - - Writer - Metadata - Table - - - - Writes a Property table - - Writer - Metadata - Table - - - - Writes a MethodSemantics table - - Writer - Metadata - Table - - - - Writes a MethodImpl table - - Writer - Metadata - Table - - - - Writes a ModuleRef table - - Writer - Metadata - Table - - - - Writes a TypeSpec table - - Writer - Metadata - Table - - - - Writes a ImplMap table - - Writer - Metadata - Table - - - - Writes a FieldRVA table - - Writer - Metadata - Table - - - - Writes a ENCLog table - - Writer - Metadata - Table - - - - Writes a ENCMap table - - Writer - Metadata - Table - - - - Writes a Assembly table - - Writer - Metadata - Table - - - - Writes a AssemblyProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyOS table - - Writer - Metadata - Table - - - - Writes a AssemblyRef table - - Writer - Metadata - Table - - - - Writes a AssemblyRefProcessor table - - Writer - Metadata - Table - - - - Writes a AssemblyRefOS table - - Writer - Metadata - Table - - - - Writes a File table - - Writer - Metadata - Table - - - - Writes a ExportedType table - - Writer - Metadata - Table - - - - Writes a ManifestResource table - - Writer - Metadata - Table - - - - Writes a NestedClass table - - Writer - Metadata - Table - - - - Writes a GenericParam table - - Writer - Metadata - Table - - - - Writes a MethodSpec table - - Writer - Metadata - Table - - - - Writes a GenericParamConstraint table - - Writer - Metadata - Table - - - - Writes a Document table - - Writer - Metadata - Table - - - - Writes a MethodDebugInformation table - - Writer - Metadata - Table - - - - Writes a LocalScope table - - Writer - Metadata - Table - - - - Writes a LocalVariable table - - Writer - Metadata - Table - - - - Writes a LocalConstant table - - Writer - Metadata - Table - - - - Writes a ImportScope table - - Writer - Metadata - Table - - - - Writes a StateMachineMethod table - - Writer - Metadata - Table - - - - Writes a CustomDebugInformation table - - Writer - Metadata - Table - - - - flags - - - - - Preserves all rids in the TypeRef table - - - - - Preserves all rids in the TypeDef table - - - - - Preserves all rids in the Field table - - - - - Preserves all rids in the Method table - - - - - Preserves all rids in the Param table - - - - - Preserves all rids in the MemberRef table - - - - - Preserves all rids in the StandAloneSig table - - - - - Preserves all rids in the Event table - - - - - Preserves all rids in the Property table - - - - - Preserves all rids in the TypeSpec table - - - - - Preserves all rids in the MethodSpec table - - - - - Preserves all method rids, i.e., Method, MemberRef and - MethodSpec rids. - - - - - Preserves all rids in the following tables: TypeRef, TypeDef, - Field, Method, Param, MemberRef, StandAloneSig, - Event, Property, TypeSpec, MethodSpec - - - - - Preserves all offsets in the #Strings heap (the original #Strings heap will be saved - in the new file). Type names, field names, and other non-user strings are stored - in the #Strings heap. - - - - - Preserves all offsets in the #US heap (the original #US heap will be saved - in the new file). User strings (referenced by the ldstr instruction) are stored in - the #US heap. - - - - - Preserves all offsets in the #Blob heap (the original #Blob heap will be saved - in the new file). Custom attributes, signatures and other blobs are stored in the - #Blob heap. - - - - - Preserves the extra data that is present after the original signature in the #Blob - heap. This extra data shouldn't be present but might be present if an obfuscator - has added this extra data and is eg. using it to decrypt stuff. - - - - - Preserves as much as possible - - - - - The original method body's max stack field should be used and a new one should not - be calculated. - - - - - Always create the #GUID heap even if it's empty - - - - - Always create the #Strings heap even if it's empty - - - - - Always create the #US heap even if it's empty - - - - - Always create the #Blob heap even if it's empty - - - - - Sort the InterfaceImpl table the same way Roslyn sorts it. Roslyn doesn't sort it - according to the ECMA spec, see https://github.com/dotnet/roslyn/issues/3905 - - - - - Don't write method bodies - - - - - Don't write .NET resources - - - - - Don't write field data - - - - - Serialized type names stored in custom attributes are optimized if the types - exist in the core library (eg. mscorlib/System.Private.CoreLib). - Instead of storing type-name + assembly-name, only type-name is stored. This results in - slightly smaller assemblies. -
-
- If it's a type in the current module, the type name is optimized and no assembly name is stored in the custom attribute. -
-
- This is disabled by default. It's safe to enable if the reference core assembly - is the same as the runtime core assembly (eg. it's mscorlib.dll and .NET Framework, - but not .NET Core / .NET Standard). -
-
- - - Metadata heaps event args - - - - - Gets the metadata writer - - - - - Gets all heaps - - - - - Constructor - - Metadata writer - All heaps - - - - options - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the debug (portable PDB) options. This is never null. - - - - - Various options - - - - - Extra heaps to add to the metadata. Also see and - - - - - Raised after all heaps have been added. The caller can sort the list if needed - - - - - Preserves the original order of heaps, and optionally adds all custom heaps to . - - Original module with the heaps - If true, all custom streams are added to - - - - Default constructor - - - - - Constructor - - Flags - - - - Constructor - - Meta data header options - - - - Constructor - - Meta data header options - Flags - - - - Portable PDB metadata kind - - - - - No debugging metadata - - - - - Standalone / embedded portable PDB metadata - - - - - Metadata writer event args - - - - - Gets the metadata writer - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Metadata writer progress event args - - - - - Gets the metadata writer - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - .NET meta data - - - - - Raised at various times when writing the metadata - - - - - Raised when the progress is updated - - - - - Gets/sets the logger - - - - - Gets the module - - - - - Gets the constants - - - - - Gets the method body chunks - - - - - Gets the .NET resources - - - - - Gets the MD header - - - - - Gets the tables heap. Access to this heap is not recommended, but is useful if you - want to add random table entries. - - - - - Gets the #Strings heap. Access to this heap is not recommended, but is useful if you - want to add random strings. - - - - - Gets the #US heap. Access to this heap is not recommended, but is useful if - you want to add random user strings. - - - - - Gets the #GUID heap. Access to this heap is not recommended, but is useful if you - want to add random GUIDs. - - - - - Gets the #Blob heap. Access to this heap is not recommended, but is useful if you - want to add random blobs. - - - - - Gets the #Pdb heap. It's only used if it's portable PDB metadata - - - - - Gets all exported methods - - - - - The public key that should be used instead of the one in . - - - - - Creates a instance - - Module - Constants list - Method bodies list - .NET resources list - Options - Debug metadata kind - A new instance - - - - - - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - Gets/sets the bit - - - - - If true, use the original Field RVAs. If it has no RVA, assume it's a new - field value and create a new Field RVA. - - - - - Gets the number of methods that will be written. - - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the new rid - - Value - Its new rid or 0 - - - - Gets the - - Method - The or null if is - null or not a method defined in this module. - - - - Gets a method's local variable signature token - - Method - Locals sig token or 0 - - - - Gets the where the resource data will be stored - - Embedded resource - A instance or null if - is invalid - - - - Gets the where the initial value is stored - - Field - A instance or null if - is invalid - - - - Called when an error is detected - - Error message - Optional message arguments - - - - Called to warn of something - - Warning message - Optional message arguments - - - - Raises - - Event - - - - Raises the progress event - - Base event - Sub progress - - - - Creates the .NET metadata tables - - - - - Updates each Method row's RVA column if it has any code - - - - - Updates the FieldRVA rows - - - - - Initializes all TypeDef, Field, Method, Event, - Property and Param rows. Other tables that are related to these six - tables are also updated. No custom attributes are written yet, though. Method bodies - aren't written either. - - - - - Writes TypeDef, Field, Method, Event, - Property and Param custom attributes and custom debug infos. - - - - - Adds the tokens of all methods in all vtables, if any - - - - - Adds the entry point. It's only needed if it's a since if it's - a , it will have already been added. - - - - - Sorts all unsorted tables except GenericParamConstraint and CustomAttribute - - - - - Initializes the GenericParamConstraint table - - - - - Inserts all custom attribute / custom debug info rows in the tables and sort them - - - - - Writes all method bodies - - - - - Checks whether a list is empty or whether it contains only nulls - - Any type - The list - true if the list is empty or if it contains only nulls, false otherwise - - - - - - - - - - Adds a - - Method signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - FIeld signature - Original StandAloneSig token or 0 if none - Its new rid - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a - - Value - Its encoded token - - - - Adds a NestedType row - - Nested type - Declaring type - - - - Adds a Module row - - Module - Its new rid - - - - Adds a ModuleRef row - - Module ref - Its new rid - - - - Adds an AssemblyRef row - - Assembly ref - Its new rid - - - - Adds an Assembly row - - Assembly - The public key that should be used - Its new rid - - - - Adds generic parameters - - New token of owner - All generic params - - - - Adds a generic param - - New token of owner - Generic paramater - - - - Adds generic parameter constraints - - New rid of owner generic param - Its constraints - - - - Adds a generic parameter constraint - - New rid of owner generic param - Generic parameter constraint - - - - Adds a InterfaceImpl row - - New rid of owner - All interfaces - - - - Adds a FieldLayout row - - Owner field - - - - Adds a FieldMarshal row - - New owner token - Owner - - - - Adds a FieldRVA row - - The field - - - - Adds a ImplMap row - - New owner token - Owner - - - - Adds a Constant row - - New owner token - Owner - - - - Adds a DeclSecurity row - - New owner token - All DeclSecurity rows - - - - Adds MethodSemantics rows - - Event - - - - Adds MethodSemantics rows - - Property - - - - Adds a ClassLayout row - - Type - - - - Adds a File row - - File - Its new rid - - - - Adds a ExportedType row - - Exported type - Its new rid - - - - Gets a #Blob offset of a type signature - - Type sig - Extra data to append the signature if - is true. - #Blob offset - - - - Gets a #Blob offset of a calling convention signature - - Signature - #Blob offset - - - - Adds a CustomAttribute row - - Owner table - New owner rid - Onwer - - - - Adds a CustomDebugInformation row - - Owner table - New owner rid - Onwer - - - - Writes the portable PDB to . - - Output stream - Entry point token - Updated with the offset of the 20-byte PDB ID. The caller is responsible for initializing it with the PDB ID - - - - - - - - - - - - - Called before any other methods - - - - - Gets all s that should be saved in the meta data - - - - - Initializes TypeDef rids and creates raw rows, but does not initialize - any columns. - - - - - Allocates Field, Method, Property, Event, Param: - rid and raw row, but doesn't initialize the raw row. - Initializes TypeDef columns: FieldList, MethodList. - Initializes Method column: ParamList. - Initializes and . - - - - - Adds a . Its custom attributes are also added. - - Type reference - Its new rid - - - - Adds a . Its custom attributes are also added. - - Type spec - Its new rid - - - - Adds a . Its custom attributes are also added. - - Member ref - Its new rid - - - - Adds a . Its custom attributes are also added. - - Stand alone sig - Its new rid - - - - Adds a . Its custom attributes are also added. - - Method spec - Its new rid - - - - Called before sorting the CustomAttribute table. This is the last time anything - can be inserted into this table. - - - - - Called after everything has been initialized. The sub class can initialize more - rows if necessary or do nothing. After this method has been called, nothing else - can be added. - - - - - Should be called before all chunks get an RVA - - - - - - - - - - - - - - - - - Sorts the s - - All s - A sorted list - - - - All events - - - - - Creating the tables has just begun - - - - - Before allocating all TypeDef RIDs - - - - - Before allocating all MemberDef RIDs - - - - - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Before sorting most tables - - - - - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - All resources are about to be added to the .NET resources table - - - - - All resources have been added to the .NET resources table - - - - - All method bodies are about to be written - - - - - All method bodies have been written. Their RVAs are still not known. - - - - - All tables are now sorted, including the CustomAttribute table. - - - - - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - options - - - - - Default version string - - - - - Default header signature - - - - - MD header signature. Default value is - - - - - Major version. Default is 1. MS' CLR supports v0.x (x >= 19) and v1.1, nothing else. - - - - - Minor version. Default is 1. - - - - - Reserved and should be 0. - - - - - Version string. Default is . It's stored as a - zero-terminated UTF-8 string. Length should be <= 255 bytes. - - - - - Storage flags should be 0 - - - - - Reserved and should be 0 - - - - - Creates portable PDB v1.0 options - - - - - - Meta data header. IMAGE_COR20_HEADER.Metadata points to this header. - - - - - - - - - - - Gets/sets the heaps - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Method body chunk - - - - - - - - - - - Gets the code - - - - - Gets the extra sections (exception handlers) or null - - - - - Gets the token of the locals - - - - - true if it's a fat body - - - - - true if it's a tiny body - - - - - true if there's an extra section - - - - - Constructor - - Code - - - - Constructor - - Code - Extra sections or null - - - - Constructor - - Code - Extra sections or null - Token of locals - - - - Gets the approximate size of the method body (code + exception handlers) - - - - - - - - - - - - - - - - - - - - - - - Stores all method body chunks - - - - - - - - - - - Gets the number of bytes saved by re-using method bodies - - - - - Constructor - - true if bodies can be shared - - - - Adds a and returns the one that has been cached - - The method body - The cached method body - - - Removes the specified method body from this chunk - The method body - if the method body is removed - - - - - - - - - - - - - - - - Returns tokens of token types, strings and signatures - - - - - Gets the token of - - A token type or a string or a signature - The token - - - - Gets a StandAloneSig token - - All locals - The original token or 0 if none - A StandAloneSig token or 0 if is - empty. - - - - Writes CIL method bodies - - - - - Gets the code as a byte array. This is valid only after calling . - The size of this array is not necessarily a multiple of 4, even if there are exception - handlers present. See also - - - - - Gets the extra sections (exception handlers) as a byte array or null if there - are no exception handlers. This is valid only after calling - - - - - Gets the token of the locals - - - - - Constructor - - Helps this instance - The CIL method body - - - - Constructor - - Helps this instance - The CIL method body - Keep the original max stack value that has been initialized - in - - - - Writes the method body - - - - - Gets the code and (possible) exception handlers in one array. The exception handlers - are 4-byte aligned. - - The code and any exception handlers - - - - - - - - - - - - - - - - - - - - - - - - - Base class of all CIL method body writers - - - - - - - - - - - true if there was at least one error - - - - - Constructor - - All instructions - All exception handlers - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Called when an error is detected (eg. a null pointer). The error can be - ignored but the method won't be valid. - - Error message - - - - Gets max stack value - - - - - Gets the offset of an instruction - - The instruction - The offset or 0 if is null or not - present in the list of all instructions. - - - - Initializes instruction offsets and returns the total code size - - Size of code - - - - Gets the size of an instruction - - The instruction - Size of the instruction in bytes - - - - Writes all instructions to at its current offset - - The instruction writer - Number of bytes written - - - - Gets the current offset in the instruction stream. This offset is relative to - the first written instruction. - - The instruction writer - Current offset, relative to the first written instruction - - - - Writes an instruction - - The instruction writer - The instruction - - - - Writes an instruction's opcode - - The instruction writer - The instruction - - - - Writes an instruction's operand - - The instruction writer - The instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes an operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - Writes a operand - - Instruction writer - Instruction - - - - options - - - - - Constructor - - The module - - - - Writes a .NET PE file. See also - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .sdata section - - - - - Gets the .rsrc section or null if none - - - - - Gets the .reloc section - - - - - Gets the PE headers - - - - - Gets the IAT or null if there's none - - - - - Gets the .NET header - - - - - Gets the import directory or null if there's none - - - - - Gets the startup stub or null if there's none - - - - - Gets the reloc directory or null if there's none - - - - - Constructor - - The module - - - - Constructor - - The module - Options or null - - - - - - - - - - Module writer event args - - - - - Gets the writer ( or ) - - - - - Gets the event - - - - - Constructor - - Writer - Event - - - - Module writer progress event args - - - - - Gets the writer ( or ) - - - - - Gets the progress, 0.0 - 1.0 - - - - - Constructor - - Writer - Progress, 0.0 - 1.0 - - - - Content ID - - - - - Gets the GUID - - - - - Gets the timestamp - - - - - Constructor - - Guid - Timestamp - - - - Event handler - - Event args type - Sender - Event args - - - - PDB writer options - - - - - No bit is set - - - - - Don't use Microsoft.DiaSymReader.Native. This is a NuGet package with an updated Windows PDB reader/writer implementation, - and if it's available at runtime, dnlib will try to use it. If this option is set, dnlib won't use it. - You have to add a reference to the NuGet package if you want to use it, dnlib has no reference to the NuGet package. - - This is only used if it's a Windows PDB file. - - - - - Don't use diasymreader.dll's PDB writer that is shipped with .NET Framework. - - This is only used if it's a Windows PDB file. - - - - - Create a deterministic PDB file and add a debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Hash the PDB file and add a PDB checksum debug directory entry to the PE file. - - It's ignored if the PDB writer doesn't support it. - - - - - Common module writer options base class - - - - - Raised at various times when writing the file. The listener has a chance to modify - the file, eg. add extra metadata, encrypt methods, etc. - - - - - Raised when the progress is updated - - - - - Gets/sets the logger. If this is null, any errors result in a - being thrown. To disable this behavior, either - create your own logger or use . - - - - - Gets/sets the writer logger. If this is null, use - . - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - Gets/sets the options. This is never null. - - - - - If true, Win32 resources aren't written to the output - - - - - Gets/sets the Win32 resources. If this is null, use the module's - Win32 resources if any. - - - - - true to delay sign the assembly. Initialize to the - public key to use, and don't initialize . To generate the - public key from your strong name key file, execute sn -p mykey.snk mypublickey.snk - - - - - Gets/sets the strong name key. When you enhance strong name sign an assembly, - this instance's HashAlgorithm must be initialized to its public key's HashAlgorithm. - You should call - to initialize this property if you use normal strong name signing. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - Gets/sets the new public key that should be used. If this is null, use - the public key generated from . If it is also null, - use the module's Assembly's public key. - You should call - or - to initialize this property if you use enhanced strong name signing. - - - - - true if method bodies can be shared (two or more method bodies can share the - same RVA), false if method bodies can't be shared. Don't enable it if there - must be a 1:1 relationship with method bodies and their RVAs. - This is enabled by default and results in smaller files. - - - - - true if the PE header CheckSum field should be updated, false if the - CheckSum field isn't updated. - - - - - true if it's a 64-bit module, false if it's a 32-bit or AnyCPU module. - - - - - Gets/sets the module kind - - - - - true if it should be written as an EXE file, false if it should be - written as a DLL file. - - - - - Set it to true to enable writing a PDB file. Default is false (a PDB file - won't be written to disk). - - - - - PDB writer options. This property is ignored if is false. - - - - - PDB file name. If it's null a PDB file with the same name as the output assembly - will be created but with a PDB extension. must be true or - this property is ignored. - - - - - PDB file name stored in the debug directory, or null to use - - - - - PDB stream. If this is initialized, then you should also set - to the name of the PDB file since the file name must be written to the PE debug directory. - must be true or this property is ignored. - - - - - Gets the PDB content id (portable PDBs). The argument is the PDB stream with the PDB ID zeroed out, - and the 2nd argument is the default timestamp. - This property is ignored if a deterministic PDB file is created or if the PDB checksum is calculated. - - - - - PDB checksum algorithm - - - - - true if an .mvid section should be added to the assembly. Not used by native module writer. - - - - - Constructor - - The module - - - - Initializes and - for normal strong name signing. - - Module - Signature strong name key pair - - - - Initializes and - for enhanced strong name signing (without key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - - - - Initializes and - for enhanced strong name signing (with key migration). See - http://msdn.microsoft.com/en-us/library/hh415055.aspx - - Module - Signature strong name key pair - Signature public key - Identity strong name key pair - Identity public key - - - - Module writer base class - - - - Default alignment of all constants - - - Default alignment of all method bodies - - - Default alignment of all .NET resources - - - Default alignment of the .NET metadata - - - Default Win32 resources alignment - - - Default strong name signature alignment - - - Default COR20 header alignment - - - See - - - See - - - See - - - See - - - See - - - See - - - Offset where the module is written. Usually 0. - - - Debug directory - - - - Strong name signature - - - - - Returns the module writer options - - - - - Gets the destination stream - - - - - Gets the constants - - - - - Gets the method bodies - - - - - Gets the .NET resources - - - - - Gets the .NET metadata - - - - - Gets the Win32 resources or null if there's none - - - - - Gets the strong name signature or null if there's none - - - - - Gets all s. The reloc section must be the last section, so use if you need to append a section - - - - - Adds to the sections list, but before the reloc section which must be last - - New section to add to the list - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Gets the debug directory or null if there's none - - - - - true if this is a , false if - this is a . - - - - - null if we're not writing a PDB - - - - - Writes the module to a file - - File name. The file will be truncated if it exists. - - - - Writes the module to a - - Destination stream - - - - Returns the module that is written - - - - - Writes the module to . Event listeners and - have been initialized when this method is called. - - Number of bytes written - - - - Creates the strong name signature if the module has one of the strong name flags - set or wants to sign the assembly. - - - - - Creates the .NET metadata chunks (constants, method bodies, .NET resources, - the metadata, and Win32 resources) - - - - - - Gets the Win32 resources that should be written to the new image or null if none - - - - - Calculates and of all s - - All chunks - Starting file offset - Starting RVA - File alignment - Section alignment - - - - Writes all chunks to - - The writer - All chunks - File offset of first chunk - File alignment - - - - Strong name sign the assembly - - Strong name signature offset - - - - Creates the debug directory if a PDB file should be written - - - - - Write the PDB file. The caller should send the PDB events before and after calling this - method. - - - - - Gets the timestamp stored in the PE header - - - - - - Raises a writer event - - Event - - - - - - - - - - Logs an error message - - Format - Format args - - - - Logs a warning message - - Format - Format args - - - - All / events - - - - - Writing has just begun - - - - - All PE sections have been created - - - - - All chunks have been created - - - - - All chunks have been added to their sections - - - - - Original event: . - Creating the metadata tables has just begun - - - - - Original event: . - Before allocating all TypeDef RIDs - - - - - Original event: . - Before allocating all MemberDef RIDs - - - - - Original event: . - The rids of types, fields, methods, events, properties and parameters are - now known. - - - - - Original event: . - The tables and rows of all types, fields, methods, events, properties and parameters - have been initialized. Method body RVAs are still not known, and no method has been - written yet. - - - - - Original event: . - Before sorting most tables - - - - - Original event: . - Most of the tables that should be sorted have been sorted. The CustomAttribute - table is still unsorted since it's not been created yet. - - - - - Original event: . - Custom attributes of all types, fields, methods, events, properties and parameters - have now been written. - - - - - Original event: . - All resources are about to be added to the .NET resources table - - - - - Original event: . - All resources have been added to the .NET resources table - - - - - Original event: . - All method bodies are about to be written - - - - - Original event: . - All method bodies have been written. Their RVAs are still not known. - - - - - Original event: . - All tables are now sorted, including the CustomAttribute table. - - - - - Original event: . - All tables have been created and all rows populated. The only columns that haven't - been initialized yet are the ones that are RVAs. - - - - - This event occurs before the PDB file is written. This event occurs even if no PDB file - will be written. - - - - - The PDB file has been written. This event occurs even if no PDB file has been written. - - - - - This event occurs just before all RVAs and file offsets of the chunks are calculated. - - - - - File offsets and RVAs of all chunks are now known. This includes method body and - field RVAs. Nothing has been written to the destination stream yet. - - - - - This event occurs before all chunks are written to the destination stream, and after - all RVAs and file offsets are known. - - - - - All chunks have been written to the destination stream. - - - - - This event occurs before the strong name signature is calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs after the strong name signature has been calculated. This event - occurs even if the assembly isn't strong name signed. - - - - - This event occurs before the checksum in the PE header is updated. This event - occurs even if the checksum isn't updated. - - - - - This event occurs after the checksum in the PE header has been updated. This event - occurs even if the checksum isn't updated. - - - - - Writing has ended - - - - - Thrown when the module writer encounters an unrecoverable error - - - - - Default constructor - - - - - Constructor - - Error message - - - - Constructor - - Error message - Other exception - - - - Constructor - - - - - - - options - - - - - If true, any extra data after the PE data in the original file is also saved - at the end of the new file. Enable this option if some protector has written data to - the end of the file and uses it at runtime. - - - - - If true, keep the original Win32 resources - - - - - Constructor - - Module - true to optimize the image size so it's as small as possible. - Since the file can contain native methods and other native data, we re-use the - original file when writing the new file. If is true, - we'll try to re-use the old method body locations in the original file and - also try to fit the new metadata in the old metadata location. - - - - A module writer that supports saving mixed-mode modules (modules with native code). - The original image will be re-used. See also - - - - The original .NET module - - - All options - - - - Any extra data found at the end of the original file. This is null if there's - no extra data or if is - false. - - - - The original PE sections and their data - - - Original PE image - - - New sections we've added and their data - - - New .text section where we put some stuff, eg. .NET metadata - - - The new COR20 header - - - - New .rsrc section where we put the new Win32 resources. This is null if there - are no Win32 resources or if - is true - - - - - Offset in of the PE checksum field. - - - - - Original PE section - - - - PE section - - - PE section data - - - - Constructor - - PE section - - - - - - - - - - Gets the module - - - - - - - - - - - Gets/sets the writer options. This is never null - - - - - Gets all s - - - - - Gets the original PE sections and their data - - - - - Gets the .text section - - - - - Gets the .rsrc section or null if there's none - - - - - Constructor - - The module - Options or null - - - - - - - - - - Gets the raw section data of the image. The sections are saved in - . - - - - - Creates the PE header "section" - - - - - Saves any data that is appended to the original PE file - - - - - true if image is 64-bit - - - - - Updates the PE header and COR20 header fields that need updating. All sections are - also updated, and the new ones are added. - - - - - Converts to a file offset in the destination stream - - RVA - - - - Gets the entry point - - Updated with entry point (either a token or RVA of native method) - true if it's a managed entry point or there's no entry point, - false if it's a native entry point - - - - .NET resources - - - - - - - - - - - Gets offset of next resource. This offset is relative to the start of - the .NET resources and is always aligned. - - - - - Constructor - - Alignment of all resources - - - - Adds a resource - - The resource data - The resource data - - - - - - - - - - - - - - - - Does not preserve metadata tokens - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - #Pdb heap - - - - - - - - Gets the PDB ID. This is always 20 bytes in size. - - - - - Gets/sets the entry point token - - - - - Gets the offset of the 20-byte PDB ID - - - - - Gets/sets the referenced type system tables - - - - - Gets the type system table rows. This table has 64 elements. - - - - - Constructor - - - - - - - - - - - options - - - - - Default DLL characteristics - - - - - Default subsystem value - - - - - Default major linker version. Roslyn C# defaults to 0x30, and Roslyn VB defaults to 0x50. - - - - - Default minor linker version - - - - - IMAGE_FILE_HEADER.Machine value - - - - - IMAGE_FILE_HEADER.TimeDateStamp value - - - - - IMAGE_FILE_HEADER.PointerToSymbolTable value - - - - - IMAGE_FILE_HEADER.NumberOfSymbols value - - - - - IMAGE_FILE_HEADER.Characteristics value. bit - is ignored and set/cleared depending on whether it's a EXE or a DLL file. - - - - - IMAGE_OPTIONAL_HEADER.MajorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorLinkerVersion value - - - - - IMAGE_OPTIONAL_HEADER.ImageBase value - - - - - IMAGE_OPTIONAL_HEADER.SectionAlignment value - - - - - IMAGE_OPTIONAL_HEADER.FileAlignment value - - - - - IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorImageVersion value - - - - - IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion value - - - - - IMAGE_OPTIONAL_HEADER.Win32VersionValue value - - - - - IMAGE_OPTIONAL_HEADER.Subsystem value - - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfStackCommit value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve value - - - - - IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit value - - - - - IMAGE_OPTIONAL_HEADER.LoaderFlags value - - - - - IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes value - - - - - Creates a new time date stamp using current time - - A new time date stamp - - - - DOS and PE headers - - - - - Gets/sets the native entry point - - - - - Gets/sets the COR20 header - - - - - Gets/sets the IAT - - - - - Gets/sets the - - - - - Gets/sets the Win32 resources - - - - - Gets/sets the relocation directory - - - - - Gets/sets the debug directory - - - - - Gets the image base - - - - - Gets/sets a value indicating whether this is a EXE or a DLL file - - - - - - - - - - - Gets the section alignment - - - - - Gets the file alignment - - - - - Gets/sets the s - - - - - Default constructor - - - - - Constructor - - Options - - - - - - - - - - - - - - - - Calculates the PE checksum and writes it to the checksum field - - Writer - Length of PE file - - - - A PE section - - - - - Gets the name - - - - - Gets the Characteristics - - - - - true if this is a code section - - - - - true if this is an initialized data section - - - - - true if this is an uninitialized data section - - - - - Constructor - - Section name - Section characteristics - - - - Writes the section header to at its current position. - Returns aligned virtual size (aligned to ) - - Writer - File alignment - Section alignment - Current - - - - Preserves metadata tokens - - - - - Its real rid - - - - - Its logical rid or real rid. If the ptr table exists (eg. MethodPtr), then it's - an index into it, else it's the real rid. - - - - - Gets total number of defs in the list. It does not necessarily return - the table size. Use for that. - - - - - Gets the number of rows that need to be created in the table - - - - - Returns true if the ptr table (eg. MethodPtr) is needed - - - - - Sorts the table - - Comparer - - - - Adds a def. must be called after adding the last def. - - The def - Collection position - - - - Must be called after 'ing the last def - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reserves rows in TypeRef, MemberRef, StandAloneSig, - TypeSpec and MethodSpec where we will store the original rows - to make sure they get the same rid. Any user created rows will be stored at - the end of each table. - - - - - Adds any non-referenced rows that haven't been added yet but are present in - the original file. If there are any non-referenced rows, it's usually a sign - that an obfuscator has encrypted one or more methods or that it has added - some rows it uses to decrypt something. - - - - - - - - Re-uses all Field rows which aren't owned by any type due to the fields - having been deleted by the user. The reason we must do this is that the - FieldPtr and Field tables must be the same size. - - - - - Re-uses all Method rows which aren't owned by any type due to the methods - having been deleted by the user. The reason we must do this is that the - MethodPtr and Method tables must be the same size. - - - - - Re-uses all Param rows which aren't owned by any type due to the params - having been deleted by the user. The reason we must do this is that the - ParamPtr and Param tables must be the same size. - This method must be called after since - this method will create more methods at the end of the Method table. - - - - - Re-uses all Event rows which aren't owned by any type due to the events - having been deleted by the user. The reason we must do this is that the - EventPtr and Event tables must be the same size. - - - - - Re-uses all Property rows which aren't owned by any type due to the properties - having been deleted by the user. The reason we must do this is that the - PropertyPtr and Property tables must be the same size. - - - - - Creates a dummy TypeDef at the end of the TypeDef table that will own - dummy methods and fields. These dummy methods and fields are only created if the size - of the ptr table is less than the size of the non-ptr table (eg. size MethodPtr table - is less than size Method table). The only reason the ptr table would be smaller than - the non-ptr table is when some field/method has been deleted and we must preserve - all method/field rids. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Relocations directory - - - - - - - - - - - Constructor - - Machine - - - - - - - - - - - - - - - - Adds a relocation - - RVA of location - - - - Adds a relocation - - Chunk or null. If it's null, is the RVA - Offset relative to the start of , or if is null, this is the RVA - - - - Length of section - - - - - Section characteristics - - - - - Constructor - - Length of section - Section characteristics - - - - Calculates the optional header section sizes - - - - - Helps map s to tokens - - - - - Returns a TypeDefOrRef encoded token - - A TypeDefOrRef type - - - - Writes signatures - - - - - Write a signature - - Helper - The type - The signature as a byte array - - - - Write a signature - - Helper - The signature - The signature as a byte array - - - - - - - Stores the instruction that jumps to _CorExeMain/_CorDllMain - - - - - Gets/sets the - - - - - Gets/sets the - - - - - - - - - - - Gets the address of the JMP instruction - - - - - Constructor - - Reloc directory - Machine - Error logger - - - - - - - - - - - - - - - - #Strings heap - - - - - - - - Populates strings from an existing (eg. to preserve - string offsets) - - The #Strings stream with the original content - - - - Adds a string to the #Strings heap. The returned value is not necessarily an offset in - the #Strings heap. Call to get the offset. - - The string - The offset id. This is not a #Strings offset. Call to get the #Strings offset - - - - Gets the offset of a string in the #Strings heap. This method can only be called after - all strings have been added. - - Offset id returned by - - - - - Adds a string to the #Strings heap, but does not re-use an existing position - - The string - The offset of the string in the #Strings heap - - - - - - - - - - - - - - - - - - - Strong name signature chunk - - - - - - - - - - - Constructor - - Size of strong name signature - - - - - - - - - - - - - - - - options - - - - - Should be 0 - - - - - Major version number. Default is 2. Valid versions are v1.0 (no generics), - v1.1 (generics are supported), or v2.0 (recommended). - - - - - Minor version number. Default is 0. - - - - - Force #- or #~ stream. Default value is null and recommended because the correct - tables stream will be used. true will force #- (Edit N' Continue) - stream, and false will force #~ (normal compressed) stream. - - - - - Extra data to write - - - - - true if there are deleted s, s, - s, s, s and/or - s. - - - - - Creates portable PDB v1.0 options - - - - - - Contains all .NET tables - - - - - - - - - - - All tables - - - - - - - - - - - true if the Edit 'N Continue name will be used (#-) - - - - - true if any rows have been deleted (eg. a deleted TypeDef, Method, Field, etc. - Its name has been renamed to _Deleted). - - - - - true if #Strings heap size > 0xFFFF - - - - - true if #GUID heap size > 0xFFFF - - - - - true if #Blob heap size > 0xFFFF - - - - - Constructor - - Metadata owner - Options - - - - - - - - - - - - - - - - Calculates the length. This will set all MD tables to read-only. - - - - - - - - - - - Re-uses existing chunks to save space - - Chunk type - - - - Default constructor - - - - - Constructor - - Compares the chunk type - - - - - - - Adds a if not already present - - The chunk to add or null if none - Chunk alignment - The original input if it wasn't present, or the cached one - - - - #US heap - - - - - - - - Populates strings from an existing (eg. to preserve - string tokens) - - The #US stream with the original content - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - Adds a string to the #US heap - - The string - The offset of the string in the #US heap - - - - - - - - - - - - - - - - - - - Writes Win32 resources - - - - - - - - - - - Constructor - - Win32 resources - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - . must have been called. - - A - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a . - must have been called. - - A - The file offset or 0 if is invalid - - - - Returns the of a . - must have been called. - - A - The RVA or 0 if is invalid - - - - Returns the and of a - 's name. must have been - called. - - The name of a - Updated with the file offset - Updated with the RVA - true if is valid and - and have been updated. false - if is not part of the Win32 resources. - - - - Returns the of a 's name. - must have been called. - - The name of a - The file offset or 0 if is invalid - - - - Returns the of a 's name. - must have been called. - - The name of a - The RVA or 0 if is invalid - - - - - - - - - - - - - - - - A that reads from a byte array - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since a has nothing that must be cleaned up - - - - - Thrown by a when it can't read data or if the caller tries to set an invalid offset - - - - - Reads data - - - - - Gets the start offset of the data - - - - - Gets the end offset of the data, not inclusive - - - - - Gets the total length of the data - - - - - Gets the current offset. This is between and (inclusive) - - - - - Gets/sets the position relative to - - - - - Gets the number of bytes that can be read without throwing an exception - - - - - Constructor - - Stream - Start offset of data - Length of data - - - - Resets the reader so it points to the start of the data - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Creates a new reader that can access a smaller part of this reader - - Start position relative to - Length of data - - - - - Creates a new reader that can access everything from to the end of the data - - Start position relative to - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Checks if it's possible to read bytes - - Length of data - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a - - - - - - Reads a UTF-16 encoded - - Number of characters to read - - - - - Reads bytes - - Destination pointer - Number of bytes to read - - - - Reads bytes - - Destination array - Destination index - Number of bytes to read - - - - Reads bytes - - Number of bytes to read - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a compressed - - Uncompressed - - - - - Reads a compressed - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a 7-bit encoded integer - - - - - - Reads a serialized UTF-8 string - - - - - - Reads a serialized string - - Encoding - - - - - Returns all data without updating the current position - - - - - - Returns the remaining data - - - - - - Reads all bytes until a terminating byte or returns null if wasn't found. - If found, the current offset is incremented by the length of the returned data - - Terminating byte value - - - - - Reads a zero-terminated UTF-8 string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - - - - - Reads a zero-terminated string or returns null if the string couldn't be read. - If successful, the current offset is incremented past the terminating zero. - - Encoding - - - - - Reads a UTF-8 encoded string - - Number of bytes to read (not characters) - - - - - Reads a string - - Number of bytes to read (not characters) - Encoding - - - - - Creates a that can access this content. The caller doesn't have to dispose of the returned stream. - - - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Number of bytes written - - - - Copies the data, starting from , to - - Destination - Temp buffer during writing - Number of bytes written - - - - Creates s that can read its data. - - This factory class is thread safe and its data can be read by on any thread. - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a data reader that can read all data - - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Creates a data reader - - Stream - Offset of data - Length of data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Disposes of this instance - - - - - This class is used by a . The instance - verifies that all input are valid before calling any methods in this class. - This class is thread safe. - - - - - Reads bytes - - Offset of data - Destination pointer - Number of bytes to read - - - - Reads bytes - - Offset of data - Destination array - Destination index - Number of bytes to read - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a - - Offset of data - - - - - Reads a UTF-16 encoded - - Offset of data - Number of characters to read - - - - - Reads a string - - Offset of data - Length of string in bytes - Encoding - - - - - Gets the data offset of a byte or returns false if the byte wasn't found - - Offset of data - End offset of data (not inclusive) - Byte value to search for - Offset of the byte if found - - - - - Creates s - - - - - Creates a that reads from native memory - - Pointer to data - - - - - Creates a that reads from a byte array - - Data - - - - - Represents a file offset - - - - - Extension methods - - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Base class for classes needing to implement IFileSection - - - - - The start file offset of this section - - - - - Size of the section - - - - - - - - - - - Set to 's current position - - The reader - - - - Set according to 's current position - - The reader - - - - Represents a section in a file - - - - - Start offset of the section in the file - - - - - End offset of the section in the file. This is one byte after the last - valid offset in the section. - - - - - Creates s that read memory mapped data - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Raised when all cached s created by this instance must be recreated - - - - - Creates a data reader - - Offset of data - Length of data - - - - - Cleans up and frees all allocated memory - - - - - true if memory mapped I/O is enabled - - - - - Call this to disable memory mapped I/O. This must only be called if no other code is - trying to access the memory since that could lead to an exception. - - - - - Creates s that read native memory - - - - - The filename or null if the data is not from a file - - - - - Gets the total length of the data - - - - - Creates a instance - - Pointer to data - Length of data - The filename or null if the data is not from a file - - - - - Creates a data reader - - Offset of data - Length of data - - - - - This method doesn't need to be called since this instance doesn't own the native memory - - - - - IMAGE_FILE_HEADER.Characteristics flags - - - - Relocation info stripped from file. - - - File is executable (i.e. no unresolved externel references). - - - Line nunbers stripped from file. - - - Local symbols stripped from file. - - - Agressively trim working set - - - App can handle >2gb addresses - - - - - - Bytes of machine word are reversed. - - - 32 bit word machine. - - - Debugging info stripped from file in .DBG file - - - If Image is on removable media, copy and run from the swap file. - - - If Image is on Net, copy and run from the swap file. - - - System File. - - - File is a DLL. - - - File should only be run on a UP machine - - - Bytes of machine word are reversed. - - - - IMAGE_OPTIONAL_HEADER.DllCharacteristics - - - - - - - - - - - - - - - - - - - Image can handle a high entropy 64-bit virtual address space. - - - DLL can move. - - - Code Integrity Image - - - Image is NX compatible - - - Image understands isolation and doesn't want it - - - Image does not use SEH. No SE handler may reside in this image - - - Do not bind this image. - - - Image should execute in an AppContainer - - - Driver uses WDM model - - - Image supports Control Flow Guard. - - - - - - - Interface for PE optional header classes - - - - - Returns the Magic field - - - - - Returns the MajorLinkerVersion field - - - - - Returns the MinorLinkerVersion field - - - - - Returns the SizeOfCode field - - - - - Returns the SizeOfInitializedData field - - - - - Returns the SizeOfUninitializedData field - - - - - Returns the AddressOfEntryPoint field - - - - - Returns the BaseOfCode field - - - - - Returns the BaseOfData field - - - - - Returns the ImageBase field - - - - - Returns the SectionAlignment field - - - - - Returns the FileAlignment field - - - - - Returns the MajorOperatingSystemVersion field - - - - - Returns the MinorOperatingSystemVersion field - - - - - Returns the MajorImageVersion field - - - - - Returns the MinorImageVersion field - - - - - Returns the MajorSubsystemVersion field - - - - - Returns the MinorSubsystemVersion field - - - - - Returns the Win32VersionValue field - - - - - Returns the SizeOfImage field - - - - - Returns the SizeOfHeaders field - - - - - Returns the CheckSum field - - - - - Returns the Subsystem field - - - - - Returns the DllCharacteristics field - - - - - Returns the SizeOfStackReserve field - - - - - Returns the SizeOfStackCommit field - - - - - Returns the SizeOfHeapReserve field - - - - - Returns the SizeOfHeapCommit field - - - - - Returns the LoaderFlags field - - - - - Returns the NumberOfRvaAndSizes field - - - - - Returns the DataDirectories field. This array contains exactly 16 elements. - - - - - Represents the IMAGE_DATA_DIRECTORY PE section - - - - - Returns the IMAGE_DATA_DIRECTORY.VirtualAddress field - - - - - Returns the IMAGE_DATA_DIRECTORY.Size field - - - - - Default constructor - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - A IMAGE_DEBUG_DIRECTORY - - - - - Gets the characteristics (reserved) - - - - - Gets the timestamp - - - - - Gets the major version - - - - - Gets the minor version - - - - - Gets the type - - - - - Gets the size of data - - - - - RVA of the data - - - - - File offset of the data - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Image debug type, see IMAGE_DEBUG_TYPE_* in winnt.n - - - - - Contains PDB info - - - - - It's a deterministic (reproducible) PE file - - - - - Embedded portable PDB data - - - - - Checksum of the PDB file. 0 or more entries allowed. - - - - - Represents the IMAGE_DOS_HEADER PE section - - - - - File offset of the NT headers - - - - - Constructor - - PE file reader - Verify section - Thrown if verification fails - - - - Represents the IMAGE_FILE_HEADER PE section - - - - - Returns the IMAGE_FILE_HEADER.Machine field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSections field - - - - - Returns the IMAGE_FILE_HEADER.TimeDateStamp field - - - - - Returns the IMAGE_FILE_HEADER.PointerToSymbolTable field - - - - - Returns the IMAGE_FILE_HEADER.NumberOfSymbols field - - - - - Returns the IMAGE_FILE_HEADER.SizeOfOptionalHeader field - - - - - Returns the IMAGE_FILE_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Represents the IMAGE_NT_HEADERS PE section - - - - - Returns the IMAGE_NT_HEADERS.Signature field - - - - - Returns the IMAGE_NT_HEADERS.FileHeader field - - - - - Returns the IMAGE_NT_HEADERS.OptionalHeader field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Creates an IImageOptionalHeader - - PE file reader pointing to the start of the optional header - Verify section - The created IImageOptionalHeader - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER (32-bit) PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER.BaseOfData field - - - - - Returns the IMAGE_OPTIONAL_HEADER.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_OPTIONAL_HEADER64 PE section - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Magic field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorLinkerVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfCode field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfInitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfUninitializedData field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.AddressOfEntryPoint field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.BaseOfCode field - - - - - Returns 0 since BaseOfData is not present in IMAGE_OPTIONAL_HEADER64 - - - - - Returns the IMAGE_OPTIONAL_HEADER64.ImageBase field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SectionAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.FileAlignment field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorOperatingSystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorImageVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MajorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.MinorSubsystemVersion field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Win32VersionValue field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfImage field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeaders field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.CheckSum field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.Subsystem field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DllCharacteristics field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfStackCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapReserve field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.SizeOfHeapCommit field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.LoaderFlags field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.NumberOfRvaAndSizes field - - - - - Returns the IMAGE_OPTIONAL_HEADER64.DataDirectories field - - - - - Constructor - - PE file reader pointing to the start of this section - Total size of this optional header (from the file header) - Verify section - Thrown if verification fails - - - - Represents the IMAGE_SECTION_HEADER PE section - - - - - Returns the human readable section name, ignoring everything after - the first nul byte - - - - - Returns the IMAGE_SECTION_HEADER.Name field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualSize field - - - - - Returns the IMAGE_SECTION_HEADER.VirtualAddress field - - - - - Returns the IMAGE_SECTION_HEADER.SizeOfRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRawData field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.PointerToLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfRelocations field - - - - - Returns the IMAGE_SECTION_HEADER.NumberOfLinenumbers field - - - - - Returns the IMAGE_SECTION_HEADER.Characteristics field - - - - - Constructor - - PE file reader pointing to the start of this section - Verify section - Thrown if verification fails - - - - Converts s to/from s - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Interface to access a PE image - - - - - true if image layout is the same as the raw PE image layout, false - if it's the same layout as a PE image loaded by the OS PE loader. - - - - - true if some of the memory where the image is located could be unavailable. - This could happen if it's been loaded by the OS loader. - - - - - The filename or null if the data is not from a file - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Returns the debug directories - - - - - Gets/sets the Win32 resources. This is null if there are no Win32 resources. - - - - - Gets the factory - - - - - Creates a from to the end of the image - - Offset of data - - - - - Creates a - - Offset of data - Length of data - - - - - Creates a from to the end of the image - - RVA of data - - - - - Creates a - - RVA of data - Length of data - - - - - Creates a that can read the whole image - - - - - - Interface to access a PE image - - - - - Call this to disable memory mapped I/O if it was used to open the file. This must only - be called if no other code is trying to access the memory since that could lead to an - exception. - - - - - true if memory mapped I/O is enabled - - - - - Extension methods - - - - - Finds a - - this - Type - Name - Language ID - The or null if none found - - - - Calculates a PE checksum - - PE image stream positioned at the MZ bytes - Length of image - Offset of checksum - PE checksum - - - - Align up - - this - Alignment - - - - Align up - - this - Alignment - - - - Converts a to/from an - - - - - Converts a to an - - The PEInfo context - The file offset to convert - The RVA - - - - Converts an to a - - The PEInfo context - The RVA to convert - The file offset - - - - IMAGE_FILE_HEADER.Machine enum - - - - Unknown machine - - - x86 - - - MIPS little-endian, 0x160 big-endian - - - MIPS little-endian - - - MIPS little-endian - - - MIPS little-endian WCE v2 - - - Alpha_AXP - - - SH3 little-endian - - - - - - SH3E little-endian - - - SH4 little-endian - - - SH5 - - - ARM Little-Endian - - - ARM Thumb/Thumb-2 Little-Endian - - - ARM Thumb-2 Little-Endian - - - - - - IBM PowerPC Little-Endian - - - - - - IA-64 - - - - - - - - - - - - - - - Infineon - - - - - - EFI Byte Code - - - x64 - - - M32R little-endian - - - - - - - - - - Extensions - - - - - Checks if is a 64-bit machine - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Checks if is , , etc... - - Machine - - - - - Image layout - - - - - Use this if the PE file has a normal structure (eg. it's been read from a file on disk) - - - - - Use this if the PE file has been loaded into memory by the OS PE file loader - - - - - Accesses a PE file - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Constructor - - Data reader factory - Image layout - Verify PE file data - - - - Constructor - - Name of the file - true if we should map it as an executable - Verify PE file data - - - - Constructor - - Name of the file - Verify PE file data - - - - Constructor - - Name of the file - - - - Constructor - - The PE file data - Filename or null - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Image layout - Verify PE file data - - - - Constructor - - The PE file data - Verify PE file data - - - - Constructor - - The PE file data - Filename or null - Verify PE file data - - - - Constructor - - The PE file data - - - - Constructor - - The PE file data - Filename or null - - - - Constructor - - Address of PE image - Length of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - Verify PE file data - - - - Constructor - - Address of PE image - Length of PE image - - - - Constructor - - Address of PE image - Image layout - Verify PE file data - - - - Constructor - - Address of PE image - Verify PE file data - - - - Constructor - - Address of PE image - - - - - - - - - - - - - - - - - - - - - - - - - - - - Reads all PE sections from a PE stream - - - - - Returns the DOS header - - - - - Returns the NT headers - - - - - Returns the section headers - - - - - Constructor - - PE file reader pointing to the start of this section - Verify sections - Thrown if verification fails - - - - Returns the first that has data at file offset - - - The file offset - - - - - Returns the first that has data at RVA - - - The RVA - - - - - Converts a to an - - The file offset to convert - The RVA - - - - Converts an to a - - The RVA to convert - The file offset - - - - Returns size of image rounded up to - - It calculates the size itself, and does not return - Size of image in bytes - - - - Represents an RVA (relative virtual address) - - - - - IMAGE_OPTIONAL_HEADER.Subsystem - - - - Unknown subsystem. - - - Image doesn't require a subsystem. - - - Image runs in the Windows GUI subsystem. - - - Image runs in the Windows character subsystem. - - - image runs in the OS/2 character subsystem. - - - image runs in the Posix character subsystem. - - - image is a native Win9x driver. - - - Image runs in the Windows CE subsystem. - - - - - - - - - - - - - - - - - - - - - - dnlib settings - - - - - true if dnlib is thread safe. (THREAD_SAFE was defined during compilation) - - - - - Cancellation token interface - - - - - Throws a if the operation should be canceled - - - - - Simple class using Monitor.Enter() and Monitor.Exit() - and just like ReaderWriterLockSlim it prevents recursive locks. It doesn't support - multiple readers. A reader lock is the same as a writer lock. - - - - - Creates a new instance of this class - - - - - - Constructor - - - - - Enter read mode - - - - - Exit read mode - - - - - Enter write mode - - - - - Exit write mode - - - - - Interface to access a lazily initialized list - - Type to store in list - - - - Gets notified of list events - - List value - - - - Called before a new value is lazily added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list. It can be modified by - the callee. - - - - Called before a new value is added to the list. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the value will be added - Value that will be added to the list - - - - Called before a value is removed from the list. If all elements are removed, - is called, and this method is not called. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index of value - The value that will be removed - - - - Called after the list has been resized (eg. an element has been added/removed). It's not - called when an element is replaced. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - Index where the change occurred. - - - - Called before the whole list is cleared. - - If you must access this list, you can only call _NoLock() methods - since a write lock is now held by this thread. - - - - Implements a that is lazily initialized - - Type to store in list - - - - Stores a simple value - - - - - true if it has been initialized, false otherwise - - - - - Default constructor - - - - - Constructor that should be used when new elements are inserted into - - User data - - - - Gets the value - - Index in the list - - - - Sets the value - - Index in the list - New value - - - - - - - - - - - - - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - - - - - - - - - - - - - - - - - - - - - - - - - Enumerator - - - - - Gets the current value - - - - - Moves to the next element in the collection - - - - - - Disposes the enumerator - - - - - Gets the list enumerator - - - - - - - - - Implements a that is lazily initialized - - Type to store in list - Type of the context passed to the read-value delegate - - - - Stores data and keeps track of the original index and whether the data has been - initialized or not. - - - - - - - - - - - - - - Constructor that should only be called when is initialized. - - Original index of this element - LazyList instance - - - - - - - Default constructor - - - - - Constructor - - List listener - - - - Constructor - - Initial length of the list - Context passed to - Delegate instance that returns original values - - - - Constructor - - Initial length of the list - List listener - Context passed to - Delegate instance that returns original values - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid in rare cases. It must never return - null. - - - - A readonly list that gets initialized lazily - - Any class type - - - - Gets the length of this list - - - - - Access the list - - Index - Generic parameter context - The element or null if is invalid - - - - Constructor - - Length of the list - Delegate instance that lazily reads an element. It might - be called more than once for each rid. It must never return null. - - - - Lazily returns the original value if the user hasn't overwritten the value - - Value type - - - - Sets the lock that protects the data - - - - - Set a delegate instance that will return the original value - - - - - Gets/sets the value - - The getter returns the original value if the value hasn't been initialized. - - - - Returns true if the value has been initialized - - - - - Returns true if the value was set by the user - - - - - A resource blob - - - - - Gets the data reader - - - - - - Gets/sets the code page - - - - - Gets/sets the reserved field - - - - - Constructor - - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - - - - Constructor - - Data reader factory - Offset of resource data - Length of resource data - Name - Code page - Reserved value - - - - A Win32 resource directory (see IMAGE_RESOURCE_DIRECTORY in the Windows SDK) - - - - See - - - See - - - See - - - See - - - See - - - See - - - - Gets/sets the characteristics - - - - - Gets/sets the time date stamp - - - - - Gets/sets the major version number - - - - - Gets/sets the minor version number - - - - - Gets all directory entries - - - - - Gets all resource data - - - - - Constructor - - Name - - - - Finds a by name - - Name - A or null if it wasn't found - - - - Finds a by name - - Name - A or null if it wasn't found - - - - A Win32 resource directory created by the user - - - - - Constructor - - Name - - - - A Win32 resource directory created from a PE file - - - - - To make sure we don't get stuck in an infinite loop, don't allow more than this - many sub directories. - - - - Owner - - - Directory depth. When creating more 's, - the instances get this value + 1 - - - - Info about all 's we haven't created yet - - - - - Info about all 's we haven't created yet - - - - Offset of resource directory / data - - - - Constructor - - Starts from 0. If it's big enough, we'll stop reading more data. - Name - Resources - Reader positioned at the start of this resource directory - - - - Reads the directory header and initializes and - . - - - - - - Reads a string - - Reader - Offset of string - The string or null if we could not read it - - - - Base class of and - - - - - Gets/sets the name - - - - - Constructor - - Name - - - - - - - A Win32 resource name. It can be either an integer or a string. - - - - - true if is valid - - - - - true if is valid - - - - - The ID. It's only valid if is true - - - - - The name. It's only valid if is true - - - - - Constructor - - ID - - - - Constructor - - Name - - - Converts input to a - - - Converts input to a - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - Overloaded operator - - - - - - - - - - - - - - - - - - - Win32 resources base class - - - - - Gets/sets the root directory - - - - - Finds a - - Type - The or null if none found - - - - Finds a - - Type - Name - The or null if none found - - - - Finds a - - Type - Name - Language ID - The or null if none found - - - - - - - Dispose method - - true if called by - - - - Win32 resources class created by the user - - - - - - - - Win32 resources class created from a PE file - - - - - Converts data RVAs to file offsets in - - - - - This reader only reads the raw data. The data RVA is found in the data header and - it's first converted to a file offset using . This file - offset is where we'll read from using this reader. - - - - - This reader only reads the directory entries and data headers. The data is read - by - - - - - - - - Gets the resource reader - - - - - Constructor - - / converter - Reader for the whole Win32 resources section (usually - the .rsrc section). It's used to read 's and - 's but not the actual data blob. - Offset of resource section - Length of resource section - true if this instance can dispose of - Data reader (it's used after converting an - to a ) - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Constructor - - The PE image - - - - Constructor - - The PE image - Reader for the whole Win32 resources section (usually - the .rsrc section) or null if we should create one from the resource data - directory in the optional header - Offset of resource section - Length of resource section - true if this instance can dispose of - - - - Creates a new data reader - - RVA of data - Size of data - - - - - - -